OS Manuals

/usr/bin/nri-consul

New Relic Infrastructure Consul Integration

From nri-consul 2.12.0-r0 (os), captured 2026-11-10 by running nri-consul --help (exit 0). permalink

Also provided by 1 other package version
Usage of /usr/bin/nri-consul:
  -ca_bundle_dir string
    	Alternative Certificate Authority bundle directory
  -ca_bundle_file string
    	Alternative Certificate Authority bundle file
  -cache_ttl duration
    	Optional. The time the integration considers a temporal stored value as valid (defaults to 6 minutes left empty). (default 6m0s)
  -check_leadership
    	Check leadership on consul server. This should be disabled on consul in client mode (default true)
  -enable_ssl
    	If true will use SSL encryption, false will not use encryption
  -events
    	Publish events data.
  -fan_out
    	If true will attempt to gather metrics from all other nodes in consul cluster (default true)
  -hostname string
    	The agent node Hostname or IP address to connect to (default "localhost")
  -inventory
    	Publish inventory data.
  -metadata
    	Add customer defined key-value attributes to the samples.
  -metrics
    	Publish metrics data.
  -nri_add_hostname
    	Add hostname attribute to the samples.
  -nri_cluster string
    	Optional. Cluster name
  -nri_service string
    	Optional. Service name
  -port string
    	Port to connect to agent node (default "8500")
  -pretty
    	Print pretty formatted JSON.
  -show_version
    	Print build information and exit
  -temp_dir string
    	Optional. Integrations path to store temporal data (defaults to os.tempDir if left empty).
  -timeout string
    	Timeout for an API call (default "0s")
  -token string
    	ACL Token if token authentication is enabled
  -trust_server_certificate
    	If true server certificate is not verified for SSL. If false certificate will be verified against supplied certificate
  -verbose
    	Print more information to logs.
Options (22)
OptionDescriptionSource
-ca_bundle_dir stringAlternative Certificate Authority bundle directoryhelp
-ca_bundle_file stringAlternative Certificate Authority bundle filehelp
-cache_ttl durationOptional.help
-check_leadershipCheck leadership on consul server.help
-enable_sslIf true will use SSL encryption, false will not use encryptionhelp
-eventsPublish events data.help
-fan_outIf true will attempt to gather metrics from all other nodes in consul cluster (default true)help
-hostname stringThe agent node Hostname or IP address to connect to (default "localhost")help
-inventoryPublish inventory data.help
-metadataAdd customer defined key-value attributes to the samples.help
-metricsPublish metrics data.help
-nri_add_hostnameAdd hostname attribute to the samples.help
-nri_cluster stringOptional.help
-nri_service stringOptional.help
-port stringPort to connect to agent node (default "8500")help
-prettyPrint pretty formatted JSON.help
-show_versionPrint build information and exithelp
-temp_dir stringOptional.help
-timeout stringTimeout for an API call (default "0s")help
-token stringACL Token if token authentication is enabledhelp
-trust_server_certificateIf true server certificate is not verified for SSL.help
-verbosePrint more information to logs.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.