Install New Relic eBPF agent for Linux hosts

NEW_RELIC_LICENSE_KEY

Specifies your New Relic license key, which is required to send data.

String

22387565c...FFFFNRAL

DEPLOYMENT_NAME

Specifies a unique name for your deployment to help identify its data in New Relic.

String

fe

OTLP_ENDPOINT

Defines the OTLP endpoint where the agent sends telemetry data.

String (Host:Port)

otlp.nr-data.net:443

NEW_RELIC_LOG_LEVEL

Sets the agent's log level. Options are OFF, FATAL, ERROR, WARNING, INFO, DEBUG in increasing order of verbosity.

String

INFO

NEW_RELIC_LOG_FILE_PATH

Specifies the file path for agent logs. If empty or the path is invalid, logs are sent to standard output (stdout).

String (Path)

""

VIZIER_PORT

Vizier server port on which agent receives pxl scripts from the client. Default to 12345.

String

"12345"

APM_DATA_REPORTING

Enable APM data reporting. When enabled, the agent collects and reports application performance monitoring data.

String

"true"

TCP_STATS_REPORTING

Enable TCP statistics reporting. When enabled, the agent collects and reports low level tcp metrics and starts network monitoring.

String

"true"

DROP_DATA_FOR_ENTITY

Regular expression pattern to match the specific name(s) of the entity set that you wish to exclude.

String

""

INCLUDE_PORT_IN_SERVER_ENTITY_IDENTIFICATION

The configuration allows you to include or exclude ports from auto-discovered entity names. Typically, names appear as processName:cwd/container_name:[port], e.g., python:frosty_merkle:[80]. To exclude port details, set this option to false for names like python:frosty_merkle.

String

"true"

TLS_ENABLED

Enables or disables TLS for communication between the eBPF client and agent.

String

"true"

TLS_AUTOGENERATE_CERT_ENABLED

If set to true, automatically generates a self-signed certificate for TLS. Set to false if you are providing your own certificates.

String

"true"

TLS_CERT_PATH

Specifies the directory path where autogenerated TLS certificates are stored.

String (Path)

/tmp/ebpf/certs/

TLS_CERT_FILE

Specifies the path to your custom PEM-encoded public certificate file. Required if TLS_AUTOGENERATE_CERT_ENABLED is false.

String (Path)

""

TLS_KEY_FILE

Specifies the path to your custom PEM-encoded private key file. Required if TLS_AUTOGENERATE_CERT_ENABLED is false.

String (Path)

""

TLS_CA_FILE

Specifies the path to your custom PEM-encoded Certificate Authority (CA) file. Required if TLS_AUTOGENERATE_CERT_ENABLED is false.

String (Path)

""

TABLE_STORE_DATA_LIMIT_MB

Sets the maximum memory (in MiB) that the eBPF agent can use for its internal data table store. This is the primary way to control the agent's RAM usage.

Integer

250

DOWNLOADED_PACKAGED_HEADERS_PATH

Sets the absolute path of the complete directory where the required linux headers are manually downloaded and placed for the eBPF agent to use. This is useful under restricted environments where agent is not able to download required linux headers. The required headers are identified by the agent based on the kernel version. Use only after NR support recommendation.

String (Path)

"/path/to/downloaded/headers/dir"

DISTRO_KERNEL_HEADERS_PATH

Sets the absolute path of the complete directory where the linux headers are present for the eBPF agent to use. This is useful where required linux headers could not be installed or path could not be determined. Use only after NR support recommendation.

String (Path)

"/usr/src/kernels"

PROTOCOLS_HTTP_ENABLED

Enables or disables all HTTP protocol tracing (metrics and spans).

String

"true"

PROTOCOLS_HTTP_SPANS_ENABLED

Enables or disables the exporting of spans for HTTP requests.

String

"true"

PROTOCOLS_HTTP_SPANS_SAMPLING_LATENCY

Sets the sampling latency threshold for exporting HTTP spans. Spans for requests slower than this percentile are exported. Options: p1, p10, p50, p90, p99.

String

"p50"

PROTOCOLS_HTTP_SPANS_SAMPLING_ERROR_RATE

Sets an error rate percentage (1-100) for an HTTP route. If a route's error rate exceeds this value, its corresponding spans are exported.

String

""

PROTOCOLS_MYSQL_ENABLED

Enables or disables all MySQL protocol tracing.

String

"true"

PROTOCOLS_MYSQL_SPANS_ENABLED

Enables or disables exporting of spans for MySQL queries.

String

"false"

PROTOCOLS_PGSQL_ENABLED

Enables or disables all PostgreSQL protocol tracing.

String

"true"

PROTOCOLS_PGSQL_SPANS_ENABLED

Enables or disables exporting of spans for PostgreSQL queries.

String

"false"

PROTOCOLS_CASS_ENABLED

Enables or disables all Cassandra protocol tracing.

String

"true"

PROTOCOLS_CASS_SPANS_ENABLED

Enables or disables exporting of spans for Cassandra queries.

String

"false"

PROTOCOLS_REDIS_ENABLED

Enables or disables all Redis protocol tracing.

String

"true"

PROTOCOLS_REDIS_SPANS_ENABLED

Enables or disables exporting of spans for Redis commands.

String

"false"

PROTOCOLS_MONGODB_ENABLED

Enables or disables all MongoDB protocol tracing.

String

"true"

PROTOCOLS_MONGODB_SPANS_ENABLED

Enables or disables exporting of spans for MongoDB queries.

String

"false"

PROTOCOLS_KAFKA_SPANS_ENABLED

Enables or disables exporting of spans for Kafka messages. Note: Kafka tracing does not report metrics.

String

"false"

PROTOCOLS_AMQP_SPANS_ENABLED

Enables or disables exporting of spans for AMQP (e.g., RabbitMQ) messages. Note: AMQP tracing does not report metrics.

String

"false"

PROTOCOLS_DNS_SPANS_ENABLED

Enables or disables exporting of spans for DNS queries. Note: DNS tracing does not report metrics.

String

"false"