OS Manuals

/usr/bin/nri-kafka

New Relic Infrastructure Kafka Integration (FIPS)

From nri-kafka-fips 3.30.0-r0 (enterprise-packages), captured 2026-11-09 by running nri-kafka --help (exit 0). permalink

Usage of /usr/bin/nri-kafka:
  -autodiscover_strategy string
    	How to discover broker nodes to collect metrics from. One of 'zookeeper' (default) or 'bootstrap' (default "zookeeper")
  -bootstrap_broker_host string
    	The bootstrap broker host (default "localhost")
  -bootstrap_broker_jmx_password string
    	The JMX password for the bootstrap broker
  -bootstrap_broker_jmx_port int
    	The JMX port for the bootstrap broker
  -bootstrap_broker_jmx_user string
    	The JMX username for the bootstrap broker
  -bootstrap_broker_kafka_port int
    	The bootstrap broker Kafka port (default 9092)
  -bootstrap_broker_kafka_protocol string
    	The protocol to connect to the bootstrap broker with. One of 'PLAINTEXT', 'SSL', 'SASL_PLAINTEXT', or 'SASL_SSL' (default "PLAINTEXT")
  -cache_ttl duration
    	Optional. The time the integration considers a temporal stored value as valid (defaults to 6 minutes left empty). (default 6m0s)
  -cluster_name string
    	A user-defined name to uniquely identify the cluster
  -collect_broker_extended_metrics
    	Collect broker.isActiveController, broker.leaderCount, broker.underMinIsrPartitionCount, replication.maxLag, and broker JVM heap memory/GC time rate on KafkaBrokerSample. The default home for future broker-level additions.
  -collect_cluster_metrics
    	Collect cluster-wide metrics from the Kafka controller.
  -collect_consumer_offset_extended_metrics
    	Collect consumer.earliestOffset (the partition's current log-start offset) on KafkaOffsetSample. Requires an extra per-partition ListOffsets query on top of the one already made for hwm/lag. Only in effect if ConsumerOffset is true.
  -collect_topic_extended_metrics
    	Collect topic.replicationFactor on KafkaTopicSample.
  -collect_topic_offset
    	Enablement of Topic offsets collection. This metric can be very resource intensive to collect especially against many topics.
  -collect_topic_size
    	Enablement of on disk Topic size metric collection. This metric can be very resource intensive to collect especially against many topics.
  -consumer_group_offset_by_topic
    	Report consumer-group offset metrics by topic
  -consumer_group_regex string
    	A regex pattern matching the consumer groups to collect
  -consumer_offset
    	Populate consumer offset data
  -consumers string
    	JSON array of consumer key:value maps with the keys 'name', 'host', 'port', 'user', 'password'. The 'name' key is required, the others default to the specified defaults in the default_jmx_* options.   (default "[]")
  -default_jmx_host string
    	Default host for JMX collection. (default "localhost")
  -default_jmx_password string
    	Default JMX password. Useful if all JMX hosts use the same JMX username and password. (default "admin")
  -default_jmx_port int
    	Default port for JMX collection. (default 9999)
  -default_jmx_user string
    	Default JMX username. Useful if all JMX hosts use the same JMX username and password. (default "admin")
  -disable_attributes string
    	JSON array of attribute names to omit from every sample that would otherwise include them. Currently supports 'clusterId' and 'brokerId'. (default "[]")
  -events
    	Publish events data.
  -force_topic_sample_collection
    	If LocalOnlyCollection=true it enforces the collection of the topicSample for every instance, possibly causing duplication. If LocalOnlyCollection=false it has no effects
  -inactive_consumer_group_offset
    	Collect offset from consumer-groups with inactive consumers
  -inventory
    	Publish inventory data.
  -kafka_version string
    	What version of the API to use for connecting to Kafka. Defaults to 2.1.0. Set this to match your cluster's version. Kafka 4.x requires at least 2.0.0 for topic and broker configuration collection (DescribeConfigs v0 was removed). Versions older than 1.0.0 may be missing some features. (default "2.1.0")
  -key_store string
    	The location for the keystore containing JMX Client's SSL certificate
  -key_store_password string
    	Password for the SSL Key Store
  -local_only_collection
    	Collect only the metrics related to the configured bootstrap broker. Useful for distributed metric collection
  -max_jmx_connections int
    	Maximum concurrent JMX connections. (default 3)
  -metadata
    	Add customer defined key-value attributes to the samples.
  -metrics
    	Publish metrics data.
  -nr_jmx string
    	Path to the nrjmx executable (default "nrjmx")
  -nri_add_hostname
    	Add hostname attribute to the samples.
  -nri_cluster string
    	Optional. Cluster name
  -nri_service string
    	Optional. Service name
  -preferred_listener string
    	Override which broker listener to attempt to connect to. Defaults to the first that works
  -pretty
    	Print pretty formatted JSON.
  -producers string
    	JSON array of producer key:value maps with the keys 'name', 'host', 'port', 'user', 'password'. The 'name' key is required, the others default to the specified defaults in the default_jmx_* options.   (default "[]")
  -sasl_gssapi_disable_fast_negotiation
    	Disable FAST negotiation.
  -sasl_gssapi_kerberos_config_path string
    	Kerberos config path (default "/etc/krb5.conf")
  -sasl_gssapi_key_tab_path string
    	Kerberos key tab path
  -sasl_gssapi_realm string
    	Kerberos realm
  -sasl_gssapi_service_name string
    	Kerberos service name
  -sasl_gssapi_username string
    	Kerberos username
  -sasl_mechanism string
    	SASL mechanism to use for authentication. One of 'PLAIN', 'SCRAM-SHA-256', 'SCRAM-SHA-512', or 'GSSAPI' (default "GSSAPI")
  -sasl_password string
    	SASL password for use with the PLAIN and SCRAM mechanisms
  -sasl_username string
    	SASL username for use with the PLAIN and SCRAM mechanisms
  -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 int
    	Timeout in milliseconds per single JMX query. (default 10000)
  -tls_ca_file string
    	CA file for broker connection
  -tls_cert_file string
    	Cert file for broker connection
  -tls_insecure_skip_verify
    	Enabled TLS insecure skip verify
  -tls_key_file string
    	Key file for broker connection
  -topic_bucket string
    	Allows the partitioning of topic collection across multiple instances. The second number is the number of instances topics are partitioned across. The first number is the bucket number of the current instance, which should be between 1 and the second number. (default "1/1")
  -topic_list string
    	JSON array of strings with the names of topics to monitor. Only used if collect_topics is set to 'List' (default "[]")
  -topic_mode string
    	Possible options are All, None, or List. If List, must also specify the list of topics to collect with the topic_list option. (default "None")
  -topic_regex string
    	A regex pattern that matches the list of topics to collect. Only used if collect_topics is set to 'Regex'
  -topic_source string
    	Collect topics list from either the Broker or Zookeeper (default "broker")
  -trust_store string
    	The location for the keystore containing JMX Server's SSL certificate
  -trust_store_password string
    	Password for the SSL Trust Store
  -verbose
    	Print more information to logs.
  -zookeeper_auth_scheme string
    	ACL scheme for authenticating ZooKeeper connection.
  -zookeeper_auth_secret string
    	Authentication string for ZooKeeper.
  -zookeeper_hosts string
    	JSON array of ZooKeeper hosts with the following fields: host, port. Port defaults to 2181 (default "[]")
  -zookeeper_path string
    	The Zookeeper path which contains the Kafka configuration. A leading slash is required.
Options (70)
OptionDescriptionSource
-autodiscover_strategy stringHow to discover broker nodes to collect metrics from.help
-bootstrap_broker_host stringThe bootstrap broker host (default "localhost")help
-bootstrap_broker_jmx_password stringThe JMX password for the bootstrap brokerhelp
-bootstrap_broker_jmx_port intThe JMX port for the bootstrap brokerhelp
-bootstrap_broker_jmx_user stringThe JMX username for the bootstrap brokerhelp
-bootstrap_broker_kafka_port intThe bootstrap broker Kafka port (default 9092)help
-bootstrap_broker_kafka_protocol stringThe protocol to connect to the bootstrap broker with.help
-cache_ttl durationOptional.help
-cluster_name stringA user-defined name to uniquely identify the clusterhelp
-collect_broker_extended_metricsCollect broker.isActiveController, broker.leaderCount, broker.underMinIsrPartitionCount, replication.maxLag, and broker JVM heap memory/GC time rate on KafkaBrokerSample.help
-collect_cluster_metricsCollect cluster-wide metrics from the Kafka controller.help
-collect_consumer_offset_extended_metricsCollect consumer.earliestOffset (the partition's current log-start offset) on KafkaOffsetSample.help
-collect_topic_extended_metricsCollect topic.replicationFactor on KafkaTopicSample.help
-collect_topic_offsetEnablement of Topic offsets collection.help
-collect_topic_sizeEnablement of on disk Topic size metric collection.help
-consumer_group_offset_by_topicReport consumer-group offset metrics by topichelp
-consumer_group_regex stringA regex pattern matching the consumer groups to collecthelp
-consumer_offsetPopulate consumer offset datahelp
-consumers stringJSON array of consumer key:value maps with the keys 'name', 'host', 'port', 'user', 'password'.help
-default_jmx_host stringDefault host for JMX collection.help
-default_jmx_password stringDefault JMX password.help
-default_jmx_port intDefault port for JMX collection.help
-default_jmx_user stringDefault JMX username.help
-disable_attributes stringJSON array of attribute names to omit from every sample that would otherwise include them.help
-eventsPublish events data.help
-force_topic_sample_collectionIf LocalOnlyCollection=true it enforces the collection of the topicSample for every instance, possibly causing duplication.help
-inactive_consumer_group_offsetCollect offset from consumer-groups with inactive consumershelp
-inventoryPublish inventory data.help
-kafka_version stringWhat version of the API to use for connecting to Kafka.help
-key_store stringThe location for the keystore containing JMX Client's SSL certificatehelp
-key_store_password stringPassword for the SSL Key Storehelp
-local_only_collectionCollect only the metrics related to the configured bootstrap broker.help
-max_jmx_connections intMaximum concurrent JMX connections.help
-metadataAdd customer defined key-value attributes to the samples.help
-metricsPublish metrics data.help
-nr_jmx stringPath to the nrjmx executable (default "nrjmx")help
-nri_add_hostnameAdd hostname attribute to the samples.help
-nri_cluster stringOptional.help
-nri_service stringOptional.help
-preferred_listener stringOverride which broker listener to attempt to connect to.help
-prettyPrint pretty formatted JSON.help
-producers stringJSON array of producer key:value maps with the keys 'name', 'host', 'port', 'user', 'password'.help
-sasl_gssapi_disable_fast_negotiationDisable FAST negotiation.help
-sasl_gssapi_kerberos_config_path stringKerberos config path (default "/etc/krb5.conf")help
-sasl_gssapi_key_tab_path stringKerberos key tab pathhelp
-sasl_gssapi_realm stringKerberos realmhelp
-sasl_gssapi_service_name stringKerberos service namehelp
-sasl_gssapi_username stringKerberos usernamehelp
-sasl_mechanism stringSASL mechanism to use for authentication.help
-sasl_password stringSASL password for use with the PLAIN and SCRAM mechanismshelp
-sasl_username stringSASL username for use with the PLAIN and SCRAM mechanismshelp
-show_versionPrint build information and exithelp
-temp_dir stringOptional.help
-timeout intTimeout in milliseconds per single JMX query.help
-tls_ca_file stringCA file for broker connectionhelp
-tls_cert_file stringCert file for broker connectionhelp
-tls_insecure_skip_verifyEnabled TLS insecure skip verifyhelp
-tls_key_file stringKey file for broker connectionhelp
-topic_bucket stringAllows the partitioning of topic collection across multiple instances.help
-topic_list stringJSON array of strings with the names of topics to monitor.help
-topic_mode stringPossible options are All, None, or List.help
-topic_regex stringA regex pattern that matches the list of topics to collect.help
-topic_source stringCollect topics list from either the Broker or Zookeeper (default "broker")help
-trust_store stringThe location for the keystore containing JMX Server's SSL certificatehelp
-trust_store_password stringPassword for the SSL Trust Storehelp
-verbosePrint more information to logs.help
-zookeeper_auth_scheme stringACL scheme for authenticating ZooKeeper connection.help
-zookeeper_auth_secret stringAuthentication string for ZooKeeper.help
-zookeeper_hosts stringJSON array of ZooKeeper hosts with the following fields: host, port.help
-zookeeper_path stringThe Zookeeper path which contains the Kafka configuration.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.