Infrastructure agent configuration settings

The infrastructure agent has a large set of configuration settings to fine-tune its behavior. Here we:

  • List all the configuration options (in both their YAML and the environment variable names).
  • Explain what the settings do and when to use them.
  • Give the variable type and default value (if any).
  • List the minimum required agent version as applicable.

For an example of how all these variables can be used, see our sample configuration template.

license_key is the only required setting.

Agent variables

Specifies the license key for your New Relic account. The agent uses this key to associate your server's metrics with your New Relic account. This setting is created as part of the standard installation process.

YML option name Environment variable Type Default Version
license_key NRIA_LICENSE_KEY string

Example:

license_key: 1234567890abcdefghijklmnopqrstuvwxyz1234

Specifies the number of logical processors available to the agent. Increasing this value helps to distribute the load between different cores.

If set to -1, the agent will try to read the environment variable GOMAXPROCS. If this variable is not set, the default value will be the total number of cores available in the host.

YML option name Environment variable Type Default Version
max_procs NRIA_MAX_PROCS integer 1 1.0.1002

Since version 1.0.804 or higher, data sent from the agent is compressed by default. To disable payload compression, set payload_compression_level to 0.

Recommendation: Do not change this setting.

YML option name Environment variable Type Default Version
payload_compression_level NRIA_PAYLOAD_COMPRESSION_LEVEL integer 6 1.0.804

Number of times the agent will retry the request to check New Relic's platform availability at startup before throwing an error.

If set to a negative value, the agent will keep checking the connection until it succeeds.

YML option name Environment variable Type Default Version
startup_connection_retries NRIA_STARTUP_CONNECTION_RETRIES integer 6 1.0.936

After a request has timed out, time the agent waits to retry a request to check New Relic's platform availability at startup.

YML option name Environment variable Type Default Version
startup_connection_retry_time NRIA_STARTUP_CONNECTION_RETRY_TIME string 5s 1.0.936 - 1.2.30

Time the agent waits until a request to check New Relic's platform availability at startup is considered timed out.

YML option name Environment variable Type Default Version
startup_connection_timeout NRIA_STARTUP_CONNECTION_TIMEOUT string 10s 1.0.936

Cloud variables

If the agent is running in a cloud instance, the agent will try to detect the cloud type and fetch metadata.

Sets the number of times the agent retries to connect in case that cloud detection fails.

If cloud detection fails during the initialization of the agent, the agent will retry after waiting for CloudRetryBackOffSec seconds.

YML option name Environment variable Type Default Version
cloud_max_retry_count NRIA_CLOUD_MAX_RETRY_COUNT integer 10 1.2.6

Sets the interval of time the agent will wait until discarding the metadata, in seconds. After this period metadata expires and the agent will fetch it again.

YML option name Environment variable Type Default Version
cloud_metadata_expiry_sec NRIA_CLOUD_METADATA_EXPIRY_SEC integer 300 1.2.6

Sets the interval of time the agent waits between cloud detection retries in case that cloud detection failed, in seconds.

If cloud detection fails during the initialization of the agent, it will retry for CloudMaxRetryCount times.

YML option name Environment variable Type Default Version
cloud_retry_backoff_sec NRIA_CLOUD_RETRY_BACKOFF_SEC integer 60 1.2.6

Similar to DisableCloudMetadata, but it disables the collection of cloud metadata only for the host alias plugin.

YML option name Environment variable Type Default Version
disable_cloud_instance_id NRIA_DISABLE_CLOUD_INSTANCE_ID boolean false 1.0.220

Disables the collection of cloud metadata.

YML option name Environment variable Type Default Version
disable_cloud_metadata NRIA_DISABLE_CLOUD_METADATA boolean false 1.0.690

Debug variables

Enables traces to be printed in the logs for the given features. Traces are additional log entries used for debugging purposes of specific features, they are only shown when the verbose log config option is enabled.

Currently two features have traces defined: connect and attributes.

YML option name Environment variable Type Default Version
trace NRIA_TRACE []string [] 1.0.1015

Example as a YAML attribute:

trace: connect, attributes

Example as an environment variable:

NRIA_TRACE='connect, attributes'

Docker variables

Time, in seconds, before the cached containers metadata expires and the agent needs to fetch them again.

YML option name Environment variable Type Default Version
container_cache_metadata_limit NRIA_CONTAINER_CACHE_METADATA_LIMIT integer 60 1.0.801

Specifies the Docker client API version.

YML option name Environment variable Type Default Version
docker_api_version NRIA_DOCKER_API_VERSION string 1.24 1.1.4

File system variables

List of the types of file systems that the agent supports. This value needs to be a subset of the default list, and items that are not in the default list will be discarded.

YML option name Environment variable Type Default Version
custom_supported_file_systems NRIA_CUSTOM_SUPPORTED_FILESYSTEMS []string Linux: ["xfs", "btrfs", "ext", "ext2", "ext3", "ext4", "hfs", "vxfs"] Windows: ["NTFS", "ReFS"] 1.0.220

List of storage devices to be ignored by the agent when gathering StorageSample data.

YML option name Environment variable Type Default Version
file_devices_ignored​ NRIA_FILE_DEVICES_IGNORED []string 1.0.220

Example as a YAML attribute:

file_devices_ignored:
  - sda1
  - sda2

Example as an environment variable:

FILE_DEVICES_IGNORED="sda1,sda2"

Hostname variables

Overrides the auto-generated hostname for reporting. This is useful when you have multiple hosts with the same name, since our infrastructure monitoring uses the hostname as the unique identifier for each host. Keep in mind this value is also used for the loopback address replacement on entity names.

For more information, see our documentation on how entity name resolution works.

YML option name Environment variable Type Default Version

display_name

 NRIA_DISPLAY_NAME string empty 1.0.266

Example:

display_name: teslaOne

When true, the full hostname is resolved by performing a reverse lookup of the host's address. Otherwise, it will be retrieved with the hostname command on Linux and from the TCP/IP parameters of the registry on Windows.

YML option name Environment variable Type Default Version
dns_hostname_resolution NRIA_DNS_HOSTNAME_RESOLUTION boolean true 1.2.6

When set, this is the value that will be reported for the full hostname; otherwise, the agent will perform the normal lookup behavior.

YML option name Environment variable Type Default Version
override_hostname NRIA_OVERRIDE_HOSTNAME string 1.0.1015

Example:

my.custom-hostname.co.org

When set, this is the value that will be reported for the hostname; otherwise, the agent will perform the normal lookup behavior.

YML option name Environment variable Type Default Version
override_hostname_short NRIA_OVERRIDE_HOSTNAME_SHORT string 1.0.1015

Example:

my.custom-hostname

Installation variables

Directory where the agent stores files for cache, inventory, integrations, etc.

YML option name Environment variable Type Default Version
agent_dir NRIA_AGENT_DIR string

Linux: /var/db/newrelic-infra

Windows: C:\Program Files\NewRelic\newrelic-infra\

 1.0.2

Directory containing the configuration files of the integrations.

Each integration has its own configuration file, named by default <integration_name>-config.yml, placed in a predefined location from which the agent loads on initialization.

YML option name Environment variable Type Default Version
plugin_dir NRIA_PLUGIN_DIR string

Linux: etc/newrelic-infra/integrations.d/

Windows:

\Program Files\NewRelic\newrelic-infra\inregrations.d

 1.0.2

With secrets management, you can configure on-host integrations with New Relic Infrastructure's agent to use sensitive data (such as passwords) without having to write them as plain text into the integration's configuration file. For more information, see Secrets management.

Specifies a custom path to install integrations, which allows to install them outside the agent_dir. It has priority when the agent is looking for installed integrations.

YML option name Environment variable Type Default Version
custom_plugin_installation_dir NRIA_CUSTOM_PLUGIN_INSTALLATION_DIR string Empty 1.0.2

Integrations variables

passthrough_environment

A list of environment variables that will be passed to all integrations. If an integration already has an existing configuration option with the same name, then the environment variable takes precedence.

YML option name Environment variable Type Default Version
passthrough_environment NRIA_PASSTHROUGH_ENVIRONMENT []string Empty 1.0.719

Example as a YAML attribute (inside the agent's configuration file, located by default in /etc/newrelic-infra.yml):

passthrough_environment:
  - HOST
  - PORT

Example as an environment variable:

NRIA_PASSTHROUGH_ENVIRONMENT="HOST,PORT"

The agent enables loopback-address replacement on the entity name (and therefore key) automatically for version 3 of the integration protocol. If you are using version 2 of the protocol and want this behavior, enable the entityname_integrations_v2_update option.

YML option name Environment variable Type Default Version
entityname_integrations_v2_update NRIA_ENTITYNAME_INTEGRATIONS_V2_UPDATE boolean false 1.2.15

By setting this configuration parameter to true the agent will open an HTTP port (by default, 8001) to receive data from the New Relic StatsD backend.

YML option name Environment variable Type Default Version
http_server_enabled NRIA_HTTP_SERVER_ENABLED boolean false 1.0.818

By setting this value, the agent will start listening on the HTTPServerPort to receive data from the New Relic StatsD backend.

YML option name Environment variable Type Default Version
http_server_host NRIA_HTTP_SERVER_HOST string localhost 1.0.818

Sets the port for the http server to receive data from the New Relic StatsD backend.

YML option name Environment variable Type Default Version
http_server_port NRIA_HTTP_SERVER_PORT integer 8001 1.0.818

Starts the process of deleting entities that haven't reported information during this interval.

Valid time units: s (seconds), m (minutes), and h (hour).

YML option name Environment variable Type Default Version
remove_entities_period NRIA_REMOVE_ENTITIES_PERIOD string 48h 1.0.859

Example:

1h

Inventory variables

If the cached inventory becomes older than this value (for example, because the agent is offline), the agent automatically removes and recreates the delta store.

YML option name Environment variable Type Default Version
offline_time_to_reset NRIA_OFFLINE_TIME_TO_RESET string 24h 1.0.888

The list of inventory paths ignored by the agent.

YML option name Environment variable Type Default Version
ignored_inventory NRIA_IGNORED_INVENTORY string[] Empty list 1.0.336

Example as a YAML attribute:

ignored_inventory: 
  - files/config/stuff.bar 
  - files/config/stuff.foo
Example as an environment variable: 
NRIA_IGNORED_INVENTORY="files/config/stuff.bar,files/config/stuff.foo"

Linux variables

Location on Linux where the pid file of the agent process is created. It is used at startup to ensure that no other instances of the agent are running.

YML option name Environment variable Type Default Version
pid_file NRIA_PID_FILE string /var/run/newrelic-infra/newrelic-infra.pid 1.0.2

When true, formulation of the host virtual memory considers SReclaimable as available memory; otherwise SReclaimable will be considered part of the used memory.

YML option name Environment variable Type Default Version
ignore_reclaimable NRIA_IGNORE_RECLAIMABLE boolean false 1.2.6

Logging variables

Defines the file path for the logs.

The default installation creates a log directory and it sets this filepath value in the log_file configuration option for you. This log directory is different for each OS, as shown below.

Change this configuration option to customize the file path for the logs.

YML option name Environment variable Type Default Version
log_file NRIA_LOG_FILE string See below*

Default paths:

  • Linux: If not defined, it logs only in the standard output.

  • Windows, agent version 1.0.752 or lower:

    C:\Program Files\New Relic\newrelic-infra\newrelic-infra.log

  • Windows, agent version 1.0.775 to 1.0.944:

    C:\%APPDATA%\Roaming\New Relic\newrelic-infra\newrelic-infra.log

  • Windows, agent version 1.0.944 or higher:

    C:\%ProgramData%\New Relic\newrelic-infra\newrelic-infra.log

    If the directory can't be created:

    C:\Program Files\New Relic\newrelic-infra\newrelic-infra.log

Defines the log output format. Available values:

  • text: Plain text output, one line per log entry.
  • json: JSON-formatted output, one line per log entry.
YML option name Environment variable Type Default Version
log_format

NRIA_LOG_FORMAT

 string text 1.4.9

By default all logs are displayed in both standard output and a log file. To disable logs in the standard output, set this configuration option to false.

YML option name Environment variable Type Default Version
log_to_stdout NRIA_LOG_TO_STDOUT boolean true 1.0.703

When verbose is set to 0, verbose logging is off, but the agent still creates logs. Set this to 1 to create verbose logs to use in troubleshooting the agent; set verbose to 2 ito use the smart verbose mode logging. Smart verbose mode logs the last smart_verbose_mode_entry_limit debug messages when an error is logged. Setting verbose to 3 enables forwarding the agent logs to New Relic Logs.

Verbose logging can generate a lot of data very quickly. Run the agent in verbose mode only for as long as necessary to reproduce your issue, then set verbose: 0 and restart your agent to disable verbose logging. Alternatively, you can set verbose: 2, which will enable smart verbose mode.

YML option name Environment variable Type Default Version
verbose NRIA_VERBOSE Integer (0, 1, 2 or 3) 0

1.9.0 when using smart mode (2)

1.11.4 when forwarding the New Relic Logs (3)
smart_verbose_mode_entry_limit

smart_verbose_mode_entry_limit refers to the number of previous debug messages that will be logged when an error is logged. For example, if the limit is set to 5, debug logs will be cached in memory until an error is logged, at which point the previous 5 debug messages will also be logged

This configuration option is only used when verbose is set to 2 (Smart Verbose Mode enabled).

YML option name Environment variable Type Default Version
smart_verbose_mode_entry_limit NRIA_SMART_VERBOSE_MODE_ENTRY_LIMIT Integer 1000 1.9.0

Metrics variables

Custom attributes are key-value pairs (similar to tags in other tools) used to annotate the data from the Infrastructure agent. You can use this metadata to build filter sets, group your results, and annotate your data. For example, you might indicate a machine's environment (staging or production), the service a machine hosts (login service, for example), or the team responsible for that machine.

The agent collects many details about your environment as part of its default attributes, including Amazon Elastic Compute Cloud (Amazon EC2) tags.

YML option name Environment variable Type
custom_attributes NRIA_CUSTOM_ATTRIBUTES map[string]interface{}

Use a list of custom attributes to annotate the data from this agent instance. Separate keys and values with colons :, as in KEY: VALUE, and separate each key-value pair with a line break. Keys can be any valid YAML except slashes /. Values can be any YAML string, including spaces.

Example as a YAML attribute:

custom_attributes:
  environment: production
  service: login service
  team: alpha-team

Example as an environment variable:

NRIA_CUSTOM_ATTRIBUTES='{"customAttribute_1":"SOME_ATTRIBUTE","customAttribute_2": "SOME_ATTRIBUTE_2"}'

Accounts and subaccounts created before July 20, 2020 have enable_process_metrics set to true by default. This can be overridden by setting a different value in the config file.

Enables the sending of process metrics to New Relic.

By default, the infrastructure agent doesn't send data about the operating system's processes. The agent still collects such data, unless metrics_process_sample_rate is set to -1.

If you want to send metric data about all the operating system's processes to New Relic, set enable_process_metrics to true. To disable the sending of process data, set it to false.

Sending all process data could increase the volume of data sent to New Relic. To fine-tune which processes you want to monitor, configure include_matching_metrics.

YML option name Environment variable Type Default Version
enable_process_metrics NRIA_ENABLE_PROCESS_METRICS boolean false

Currently, this setting only applies to operating system's processes metrics.

You can optimize how much data is sent to New Relic by configuring include_matching_metrics, which allows you to restrict the transmission of metric data based on the values of metric attributes.

You include metric data by defining literal or partial values for any of the attributes of the metric. For example, you can choose to send the host.process.cpuPercent of all processes whose process.name match the ^java regular expression.

In this example, we include process metrics using executable files and names:

include_matching_metrics: # You can combine attributes from different metrics
    process.name:
      - regex “^java”    # Include all processes starting with "java"
    process.executable:
      - “/usr/bin/python2”              # Include the Python 2.x executable
      - regex “\\System32\\svchost”     # Include all svchost executables

If you need to include command line arguments in any of the values, set strip_command_line to false (the infrastructure agents removes CLI arguments by default to prevent secrets from leaking).

To configure include_matching_metrics as an environment variable for the Kubernetes integration, add it in the manifest inside the env: object:

env:
    - name: NRIA_INCLUDE_MATCHING_METRICS
      value: |
        process.name:
          - regex "^java"
        process.executable:
          - "/usr/bin/python2"
          - regex "\\System32\\svchost"

You can use the network interface filters configuration to hide unused or uninteresting network interfaces from the infrastructure agent. This helps reduce resource usage, work, and noise in your data.

Environment variables are not supported for this configuration setting.

The configuration uses a simple pattern-matching mechanism that can look for interfaces that start with a specific sequence of letters or numbers following either pattern:

  • {name}[other characters], where you specify the name using the prefix option
  • [number]{name}[other characters], where you specify the name using the index-1 option

New Relic infrastructure implements a curated default list of filters, available for both Linux and Windows, that you can modify.

YML option name Environment variable Type Default Version
network_interface_filters not supported map[string][]string 1.0.220

Default network interface filters for Linux:

  • Network interfaces that start with dummy, lo, vmnet, sit, tun, tap, or veth
  • Network interfaces that contain tun or tap

The following example (added to your configuration file) overrides the default filters. This will ignore network interfaces that start with dummy or lo , or contain tun preceded by a sequence of numbers, and followed by other characters:

network_interface_filters:
  prefix:
    - dummy
    - lo
  index-1:
    - tun

Default network interface filters for Windows:

  • Network interfaces that start with Loop, isatap, or Local

The following example (added to your configuration file) overrides the default filters. This will ignore network interfaces that start with Loop:

network_interface_filters:
  prefix:
    - Loop

The ZeroRSSFilter excludes processes that are not using memory from being sampled. Disable the filter so that the agent includes these processes in the ProcessSample.

YML option name Environment variable Type Default Version
disable_zero_mem_process_filter NRIA_DISABLE_ZERO_MEM_PROCESS_FILTER boolean false 1.0.832

Plugins variables

You can quickly disable all the variables by setting DisableAllPlugins to true, and turn on only those options you need.

To disable all the plugins, set this option to true.

YML option name Environment variable Type Default Version
disable_all_plugins NRIA_DISABLE_ALL_PLUGINS boolean false 1.2.1

Sampling period for the CloudSecurityGroups plugin, in seconds. The minimum value is 30. To disable it, set it to -1.

This plugin is activated only if the agent is running in an AWS instance.

YML option name Environment variable Type Default Version
cloud_security_group_refresh_sec NRIA_CLOUD_SECURITY_GROUP_REFRESH_SEC int64 60 1.0.692

Sampling period for the Daemontoolsplugin, in seconds. The minimum value is a 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
daemontools_interval_sec NRIA_DAEMONTOOLS_INTERVAL_SEC int64 15 1.0.316

Sampling period for the Dpkg plugin, in seconds. The minimum value is 30. To disable it, set it to -1. If the parameter is not explicitly set in the config file, it can be disabled by setting DisableAllPlugins to true.

This is only activated in root or privileged running modes and on Debian-based distributions.

YML option name Environment variable Type Default Version
dpkg_interval_sec NRIA_DPKG_INTERVAL_SEC int64 30 1.0.316

Sampling period for the Facter plugin, in seconds. The minimum value is 30. To disable it, set it to -1.

YML option name Environment variable Type Default Version
facter_interval_sec NRIA_FACTER_INTERVAL_SEC int64 30 1.0.316

Sampling period for the CloudSecurityGroups plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

kernel_modules_refresh_sec is only activated in root or privileged running modes.

YML option name Environment variable Type Default Version
kernel_modules_refresh_sec NRIA_KERNEL_MODULES_REFRESH_SEC int64 10 1.0.755

Sampling period for the NetworkInterface plugin, in seconds. The minimum value is 30. To disable it, set it to -1.

YML option name Environment variable Type Default Version
network_interface_interval_sec NRIA_NETWORK_INTERFACE_INTERVAL_SEC int64 60 1.0.329

Sampling period for the Rpm plugin, in seconds. The minimum value is 30. To disable it, set it to -1.

rpm_interval_sec is only activated when the agent runs in root or privileged modes for RedHat, RedHat AWS, or SUSE distributions.

YML option name Environment variable Type Default Version
rpm_interval_sec NRIA_RPM_INTERVAL_SEC int64 30 1.0.316

Sampling period for the SELinux plugin, in seconds. The minimum value is 30. To disable it, set it to -1. This option is ignored if SelinuxEnableSemodule is set to false. For more information, see our troubleshooting doc on disabling the SELinux module.

SELinux is only activated when the agent runs in root mode.

YML option name Environment variable Type Default Version
selinux_interval_sec NRIA_SELINUX_INTERVAL_SEC int64 30 1.0.316

Sampling period for the Sshd plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
sshd_config_refresh_sec NRIA_SSHD_CONFIG_REFRESH_SEC int64 15 1.0.755

Sampling period for the Supervisor plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
supervisor_interval_sec NRIA_SUPERVISOR_INTERVAL_SEC int64 15 1.0.316

Sampling period for the Sysctl plugin, in seconds. The minimum value is 30. To disable it, set it to -1.

YML option name Environment variable Type Default Version
sysctl_interval_sec NRIA_SYSCTL_INTERVAL_SEC int64 60 1.0.316

Sampling period for the Systemd plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
systemd_interval_sec NRIA_SYSTEMD_INTERVAL_SEC int64 30 1.0.316

Sampling period for the sysv plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
sysvinit_interval_sec NRIA_SYSVINIT_INTERVAL_SEC int64 30 1.0.316

Sampling period for the Upstart plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
upstart_interval_sec NRIA_UPSTART_INTERVAL_SEC int64 30 1.0.316

Sampling period for the Users plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
users_refresh_sec NRIA_USERS_REFRESH_SEC int64 30 1.0.755

Location of the supervisor socket.

YML option name Environment variable Type Default Version
supervisor_rpc_sock NRIA_SUPERVISOR_RPC_SOCK string /var/run/supervisor.sock 1.0.2

Sets the HOME environment variable for Puppet's Facter. If not defined, it defaults to the current user's home directory.

YML option name Environment variable Type Default Version
facter_home_dir NRIA_FACTER_HOME_DIR string 1.1.7

Proxy variables

For infrastructure agent version 1.3.1 or higher, the precedence of the proxy configuration settings is:

  • NRIA_PROXY
  • proxy
  • HTTP_PROXY
  • HTTPS_PROXY

Your system may have firewall rules that require the agent to use a proxy to communicate with New Relic. If so, set the proxy URL in the form https://user:password@hostname:port. It can be HTTP or HTTPS.

YML option name Environment variable Type Default Version
proxy NRIA_PROXY string Empty 1.0.308

Example:

https://proxy_user.access_10@proxy_01:1080

When set to true, the HTTPS_PROXY and HTTP_PROXY environment variables are ignored. This is useful when the agent needs to connect directly to the metrics collector and skip the existing system proxy.

YML option name Environment variable Type Default Version
ignore_system_proxy NRIA_IGNORE_SYSTEM_PROXY boolean false 1.0.1002

If the HTTPS_PROXY option references to a proxy with self-signed certificates, this option specifies the path to the the directory where the proxy certificate is available. The certificates in the directory must end with the .pem extension.

YML option name Environment variable Type Default Version
ca_bundle_dir NRIA_CA_BUNDLE_DIR string 1.0.296

If the HTTPS_PROXY option references to a proxy with self-signed certificates, this option specifies the path to the certificate file.

YML option name Environment variable Type Default Version
ca_bundle_file NRIA_CA_BUNDLE_FILE string 1.0.296

If set to true, when the proxy is configured to use an HTTPS connection, it will only work:

  • If the HTTPS proxy has certificates from a valid Certificate Authority.
  • If the ca_bundle_file or ca_bundle_dir configuration properties contain the HTTPS proxy certificates.
YML option name Environment variable Type Default Version
proxy_validate_certificates NRIA_PROXY_VALIDATE_CERTIFICATES boolean false 1.3.0

Sends the following proxy configuration information as inventory:

  • HTTPS_PROXY
  • HTTP_PROXY
  • proxy ca_bundle_dir
  • ca_bundle_file
  • ignore_system_proxy
  • proxy_validate_certificates
YML option name Environment variable Type Default Version
proxy_config_plugin NRIA_PROXY_CONFIG_PLUGIN boolean true 1.3.0

If you are having problems with proxy configuration, see Proxy troubleshooting.

Samples variables

Sample rate of network samples, in seconds. Minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
metrics_network_sample_rate NRIA_METRICS_NETWORK_SAMPLE_RATE integer 10 1.0.308

Sample rate of process samples, in seconds. Minimum value is 20. To disable process samples entirely, set metrics_process_sample_rate to -1.

YML option name Environment variable Type Default Version
metrics_process_sample_rate NRIA_METRICS_PROCESS_SAMPLE_RATE integer 20 1.0.308

Sample rate of storage samples, in seconds. Minimum value is 5. To disable it, set it to -1.

YML option name Environment variable Type Default Version
metrics_storage_sample_rate NRIA_METRICS_STORAGE_SAMPLE_RATE integer 5 1.0.308

Sample rate of system samples, in seconds. Minimum value is 5. To disable it, set it to -1.

YML option name Environment variable Type Default Version
metrics_system_sample_rate NRIA_METRICS_SYSTEM_SAMPLE_RATE integer 5 1.0.308

Sample rate of NFS storage samples, in seconds. Minimum value is 5. To disable it, set it to -1.

YML option name Environment variable Type Default Version
metrics_nfs_sample_rate NRIA_METRICS_NFS_SAMPLE_RATE integer 20 1.5.40

Detailed NFS metrics. When enabled, the agent will provide a complete list of NFS metrics.

YML option name Environment variable Type Default Version
detailed_nfs NRIA_DETAILED_NFS boolean false 1.5.40

Security variables

Get versions of policy modules installed using SEModule. If disabled, the SELinux plugin will only retrieve the status using SEStatus.

YML option name Environment variable Type Default Version
selinux_enable_semodule NRIA_SELINUX_ENABLE_SEMODULE boolean true 1.0.864

When true, the agent removes the command arguments from the commandLine attribute of the ProcessSample.

This is a security measure to prevent leaking sensitive information.

YML option name Environment variable Type Default Version
strip_command_line NRIA_STRIP_COMMAND_LINE boolean true 1.0.149

Windows variables

Sampling period for the Windows services plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
windows_services_refresh_sec NRIA_WINDOWS_SERVICES_REFRESH_SEC int64 30 1.0.755

Sampling period for the Windows updates plugin, in seconds. The minimum value is 10. To disable it, set it to -1.

YML option name Environment variable Type Default Version
windows_updates_refresh_sec NRIA_WINDOWS_UPDATES_REFRESH_SEC int64 60 1.0.755

Defines the path to store data in a different path than the program files directory:

  • %AppDir%/data: Used for storing the delta data
  • %AppDir%/user_data: External directory for user-generated JSON files
  • %AppDir%/newrelic-infra.log: If log file config option is not defined, then we use this directory path as default.
YML option name Environment variable Type Default Version
app_data_dir NRIA_APP_DATA_DIR string

Windows: env(ProgramData)\New Relic\newrelic-infra

Linux:

Not applicable

 1.0.755

Enables the Windows updates plugin, which retrieves the lists of hotfixes that are installed on the host.

YML option name Environment variable Type Default Version
enable_win_update_plugin NRIA_ENABLE_WIN_UPDATE_PLUGIN boolean false 1.0.274

If true, the agent will be forced to use Windows WMI (the agent's legacy method to grab metrics for Windows; for example, StorageSampler) and will disable the new method (which uses the PDH library).

YML option name Environment variable Type Default Version
legacy_storage_sampler NRIA_LEGACY_STORAGE_SAMPLER boolean 1.0.1051

This configuration option allows to increase the newrelic-infra.exe process priority to any of the following values:

  • Normal
  • Idle
  • High
  • RealTime
  • BelowNormal
  • AboveNormal
YML option name Environment variable Type Default Version
win_process_priority_class NRIA_WIN_PROCESS_PRIORITY_CLASS string 1.0.989

Example:

Normal

Enables the Windows agent to report drives A: and B: when they are mapped as removable drives.

YML option name Environment variable Type Default Version
win_removable_drives NRIA_WIN_REMOVABLE_DRIVES boolean true 1.3.1

What's next?

You can also:

For more help

If you need more help, check out these support and learning resources: