OS Manuals

/usr/bin/nri-postgresql

New Relic Infrastructure Postgresql Integration

From nri-postgresql 2.32.1-r0 (os), captured 2026-11-05 by running nri-postgresql --help (exit 0). permalink

Also provided by 1 other package version
Usage of /usr/bin/nri-postgresql:
  -cache_ttl duration
    	Optional. The time the integration considers a temporal stored value as valid (defaults to 6 minutes left empty). (default 6m0s)
  -collect_bloat_metrics
    	Enable collecting bloat metrics which can be performance intensive (default true)
  -collect_db_lock_metrics
    	If true, enables collection of lock metrics for the specified database. (Note: requires that the 'tablefunc' extension is installed)
  -collection_ignore_database_list string
    	A JSON array that list databases that will be excluded from collection. Nothing is excluded by default. (default "[]")
  -collection_ignore_table_list string
    	A JSON array that list tables that will be excluded from collection. Nothing is excluded by default. (default "[]")
  -collection_list string
    	A JSON object which defines the databases, schemas, tables, and indexes to collect. Can also be a JSON array that list databases to be collected. Can also be the string literal 'ALL' to collect everything. Collects nothing by default. (default "{}")
  -custom_metrics_config string
    	YAML configuration with one or more custom SQL queries to collect
  -custom_metrics_query string
    	A SQL query to collect custom metrics. Must have the columns metric_name, metric_type, and metric_value. Additional columns are added as attributes
  -database string
    	The PostgreSQL database name to connect to (default "postgres")
  -enable_query_monitoring
    	Enable collection of detailed query performance metrics.
  -enable_ssl
    	If true will use SSL encryption, false will not use encryption
  -events
    	Publish events data.
  -hostname string
    	The PostgreSQL hostname to connect to (default "localhost")
  -inventory
    	Publish inventory data.
  -is_rds
    	If true, the integration will support on AWS RDS. This will enable RDS-specific metrics and configurations.
  -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
  -password string
    	The password for the specified username
  -pgbouncer
    	Collects metrics from PgBouncer instance. Assumes connection is through PgBouncer.
  -port string
    	The port to connect to the PostgreSQL database (default "5432")
  -pretty
    	Print pretty formatted JSON.
  -query_monitoring_count_threshold int
    	The number of records for each query performance metrics (default 20)
  -query_monitoring_response_time_threshold int
    	Threshold in milliseconds for query response time. If response time for the individual query exceeds this threshold, the individual query is reported in metrics (default 1)
  -show_version
    	Print build information and exit
  -ssl_cert_location string
    	Absolute path to PEM encoded client cert file
  -ssl_key_location string
    	Absolute path to PEM encoded client key file
  -ssl_root_cert_location string
    	Absolute path to PEM encoded root certificate file
  -temp_dir string
    	Optional. Integrations path to store temporal data (defaults to os.tempDir if left empty).
  -timeout string
    	Maximum wait for connection, in seconds. Set 0 for no timeout (default "10")
  -trust_server_certificate
    	If true server certificate is not verified for SSL. If false certificate will be verified against supplied certificate
  -username string
    	The username for the PostgreSQL database
  -verbose
    	Print more information to logs.
Options (35)
OptionDescriptionSource
-cache_ttl durationOptional.help
-collect_bloat_metricsEnable collecting bloat metrics which can be performance intensive (default true)help
-collect_db_lock_metricsIf true, enables collection of lock metrics for the specified database.help
-collection_ignore_database_list stringA JSON array that list databases that will be excluded from collection.help
-collection_ignore_table_list stringA JSON array that list tables that will be excluded from collection.help
-collection_list stringA JSON object which defines the databases, schemas, tables, and indexes to collect.help
-custom_metrics_config stringYAML configuration with one or more custom SQL queries to collecthelp
-custom_metrics_query stringA SQL query to collect custom metrics.help
-database stringThe PostgreSQL database name to connect to (default "postgres")help
-enable_query_monitoringEnable collection of detailed query performance metrics.help
-enable_sslIf true will use SSL encryption, false will not use encryptionhelp
-eventsPublish events data.help
-hostname stringThe PostgreSQL hostname to connect to (default "localhost")help
-inventoryPublish inventory data.help
-is_rdsIf true, the integration will support on AWS RDS.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
-password stringThe password for the specified usernamehelp
-pgbouncerCollects metrics from PgBouncer instance.help
-port stringThe port to connect to the PostgreSQL database (default "5432")help
-prettyPrint pretty formatted JSON.help
-query_monitoring_count_threshold intThe number of records for each query performance metrics (default 20)help
-query_monitoring_response_time_threshold intThreshold in milliseconds for query response time.help
-show_versionPrint build information and exithelp
-ssl_cert_location stringAbsolute path to PEM encoded client cert filehelp
-ssl_key_location stringAbsolute path to PEM encoded client key filehelp
-ssl_root_cert_location stringAbsolute path to PEM encoded root certificate filehelp
-temp_dir stringOptional.help
-timeout stringMaximum wait for connection, in seconds.help
-trust_server_certificateIf true server certificate is not verified for SSL.help
-username stringThe username for the PostgreSQL databasehelp
-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.