OS Manuals

/usr/bin/nri-mssql

New Relic Infrastructure mssql Integration (FIPS)

From nri-mssql-fips 2.39.1-r0 (enterprise-packages), captured 2026-11-08 by running nri-mssql --help (exit 0). permalink

Usage of /usr/bin/nri-mssql:
  -cache_ttl duration
    	Optional. The time the integration considers a temporal stored value as valid (defaults to 6 minutes left empty). (default 6m0s)
  -certificate_location string
    	Certificate file to verify SSL encryption against
  -client_id string
    	Azure AD Service Principal client ID
  -client_secret string
    	Azure AD Service Principal client secret
  -custom_metrics_config string
    	YAML configuration with one or more SQL queries to collect custom metrics
  -custom_metrics_query string
    	A SQL query to collect custom metrics. Query results 'metric_name', 'metric_value', and 'metric_type' have special meanings
  -enable_buffer_metrics
    	Enable collection of buffer space metrics. (default true)
  -enable_database_reserve_metrics
    	Enable collection of database reserve space metrics. (default true)
  -enable_disk_metrics_in_bytes
    	Enable collection of instance.diskInBytes. (default true)
  -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.
  -extra_connection_url_args string
    	Appends additional parameters to connection url. Ex. 'applicationintent=readonly&foo=bar'
  -hostname string
    	The Microsoft SQL Server connection host name (default "127.0.0.1")
  -instance string
    	The Microsoft SQL Server instance to connect to
  -inventory
    	Publish inventory data.
  -max_concurrent_workers int
    	Maximum number of simultaneous database connections to be used while collecting metrics. (default 10)
  -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 Microsoft SQL Server connection password
  -port string
    	The Microsoft SQL Server port to connect to. Only needed when instance not specified
  -pretty
    	Print pretty formatted JSON.
  -query_monitoring_count_threshold int
    	Maximum number of queries returned in query analysis results. (default 20)
  -query_monitoring_disable_historical_information
    	QPM queries will not fetch on all historical informations and to increase performance of the queries.
  -query_monitoring_fetch_interval int
    	Interval in seconds for fetching grouped slow queries; Should always be same as mysql-config interval. (default 15)
  -query_monitoring_response_time_threshold int
    	Threshold in milliseconds for query response time. If response time exceeds this threshold, the query will be considered slow. (default 1)
  -show_version
    	Print build information and exit
  -temp_dir string
    	Optional. Integrations path to store temporal data (defaults to os.tempDir if left empty).
  -tenant_id string
    	Azure AD Service Principal tenant ID
  -timeout string
    	Timeout in seconds for a single SQL Query. Set 0 for no timeout (default "30")
  -trust_server_certificate
    	If true server certificate is not verified for SSL. If false certificate will be verified against supplied certificate
  -username string
    	The Microsoft SQL Server connection user name
  -verbose
    	Print more information to logs.
Options (36)
OptionDescriptionSource
-cache_ttl durationOptional.help
-certificate_location stringCertificate file to verify SSL encryption againsthelp
-client_id stringAzure AD Service Principal client IDhelp
-client_secret stringAzure AD Service Principal client secrethelp
-custom_metrics_config stringYAML configuration with one or more SQL queries to collect custom metricshelp
-custom_metrics_query stringA SQL query to collect custom metrics.help
-enable_buffer_metricsEnable collection of buffer space metrics.help
-enable_database_reserve_metricsEnable collection of database reserve space metrics.help
-enable_disk_metrics_in_bytesEnable collection of instance.diskInBytes.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
-extra_connection_url_args stringAppends additional parameters to connection url.help
-hostname stringThe Microsoft SQL Server connection host name (default "127.0.0.1")help
-instance stringThe Microsoft SQL Server instance to connect tohelp
-inventoryPublish inventory data.help
-max_concurrent_workers intMaximum number of simultaneous database connections to be used while collecting metrics.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 Microsoft SQL Server connection passwordhelp
-port stringThe Microsoft SQL Server port to connect to.help
-prettyPrint pretty formatted JSON.help
-query_monitoring_count_threshold intMaximum number of queries returned in query analysis results.help
-query_monitoring_disable_historical_informationQPM queries will not fetch on all historical informations and to increase performance of the queries.help
-query_monitoring_fetch_interval intInterval in seconds for fetching grouped slow queries;help
-query_monitoring_response_time_threshold intThreshold in milliseconds for query response time.help
-show_versionPrint build information and exithelp
-temp_dir stringOptional.help
-tenant_id stringAzure AD Service Principal tenant IDhelp
-timeout stringTimeout in seconds for a single SQL Query.help
-trust_server_certificateIf true server certificate is not verified for SSL.help
-username stringThe Microsoft SQL Server connection user namehelp
-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.