Install New Relic eBPF agent for Linux hosts

licenseKey

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

String

"22387565c...FFFFNRAL"

deploymentName

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

String

"my-deployment"

region

If using a customSecretLicenseKey, you must supply your region "US"/"EU"/"JP"/"GOV". Otherwise, leave this value as an empty string.

String

""

customOtlpEndpoint

Custom OTLP endpoint URL. When set, this takes precedence over the region-based static endpoints.

String

""

customOtlpEndpointTlsEnabled

Whether TLS is enabled on the custom OTLP endpoint. Only applicable when customOtlpEndpoint is set.

Boolean

true

customOtlpEndpointTlsCertPath

Path to custom CA certificates for OTLP endpoint TLS validation. If empty, system default CA certificates are used.

String

""

otlpProxy.host

HTTP/HTTPS proxy hostname for routing OTLP telemetry data through a corporate proxy. If empty, no proxy is used.

String

"proxy.example.com"

otlpProxy.port

Proxy port for the OTLP proxy.

Integer

""

otlpProxy.scheme

Proxy URL scheme. Accepted values: http, https.

String

"http"

otlpProxy.user

Username for proxy Basic Authentication. If empty, no authentication is used.

String

""

otlpProxy.password

Password for proxy Basic Authentication. Only used together with otlpProxy.user.

String

""

otlpProxy.url

Complete proxy URL. When set, this overrides the individual otlpProxy.host, port, scheme, user, and password settings. Format: http://[user:pass@]host:port.

String

""

logLevel

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

String

"INFO"

logFilePath

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

String

"/var/log/newrelic-ebpf-agent"

reportApmData

Controls APM data reporting. Accepted values: "true" (always send), "false" (never send), "auto" (send only when neither APM nor OTel agent is attached).

String

"auto"

reportNetworkMetrics

Controls network metrics reporting. When enabled, the agent collects and reports network metrics including TCP statistics. Accepted values: "true" (always send), "false" (never send), "auto".

String

"auto"

reportLogs

Controls application log reporting. Accepted values: "true" (always send), "false" (never send), "auto" (send unless the attached APM agent is actively collecting logs itself, or an OTel agent is attached at all). See Automatic detection and backoff for details.

String

"false"

agentMetadataReporting

Enables agent and entity metadata reporting. By default, the agent exports agent and entity metadata to New Relic over HTTP. Set this to false to disable the metadata reporting HTTP export path entirely.

Boolean

true

ai_monitoring.enabled

Controls GenAI telemetry reporting. Accepted values: "true" (always send), "false" (never send), "auto" (send only when no language APM or OTel agent is already reporting AI monitoring data for the entity).

String

"false"

ai_monitoring.samplingLatency

Defines the latency-based sampling threshold for exporting GenAI spans. Supports values from p0 to p99.

String

"p50"

ai_monitoring.samplingErrorRate

Defines the error-rate threshold for a GenAI route where surpassing it means the corresponding spans of the route are exported. Options: 1-100.

String

""

ai_monitoring.genAICaptureMessageContent

When true, captures full prompt and completion content for GenAI interactions. Only takes effect when ai_monitoring.enabled is true or auto. Use with caution.

Boolean

false

httpPathNormalizationPatterns

Defines HTTP path normalization patterns. Each pattern must contain at least one * wildcard. Use a ! prefix for exclusion patterns to preserve paths as is (skip auto-clustering). The agent applies these patterns before auto-clustering, and they take precedence over it.

List

["/api/users/*", "/api/orders/*", "!/health/*"]

httpBodyLimitBytes

Sets the maximum number of bytes captured from an HTTP request/response body. Default: 1048576 (1 MB) when ai_monitoring.enabled is true or auto, otherwise 1024 (1 KB). Increase this value if New Relic truncates AI monitoring payloads.

Integer

2097152

includePortInServerEntityIdentification

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 such as python:frosty_merkle.

Boolean

true

entityLabels

Custom labels to be added to all entities reported by the eBPF agent. These labels appear as tags.* attributes in New Relic (e.g., tags.environment, tags.datacenter).

Map

{datacenter: "us-east-1", environment: "production"}

downloadedPackagedHeadersPath

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

""

distroKernelHeadersPath

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

""

allDataFilters.dropServiceNameRegex

Regular expression pattern to match entity names for dropping ALL data (network metrics + APM data). For example: "java-app|otel-collector|\\bservice1\\b". Use either dropServiceNameRegex or keepServiceNameRegex to filter service names, not both. If both are provided, keepServiceNameRegex takes precedence.

String

""

allDataFilters.keepServiceNameRegex

Regular expression pattern to match entity names to always keep ALL data for. This bypasses all drop filters. For example: "critical-service|important-app|\\bmust-monitor\\b". Use either dropServiceNameRegex or keepServiceNameRegex to filter service names, not both. If both are provided, keepServiceNameRegex takes precedence.

String

""

allDataFilters.dropApmAgentEnabledEntity

Drop all data for applications/entities that have NewRelic/OpenTelemetry APM agents running.

Boolean

false

apmDataFilters.dropEntityName

List of entity names for dropping eBPF APM data. For example: ["kube-dns", "otel-collector", "service1"].

List

[]

apmDataFilters.keepEntityName

List of entity names to always keep eBPF APM data. By default all entities are kept/enabled. This bypasses apmDataFilters.dropEntityName filter. For example: ["critical-service", "important-app"].

List

[]

apmDataFilters.jvmMetricsReporting

Enable JVM metrics reporting. When enabled, the agent collects and reports JVM metrics for Java applications.

Boolean

true

networkMetricsDataFilter.dropEntityName

List of entity names for dropping network metrics data. For example: ["kube-dns", "otel-collector", "service1"].

List

[]

networkMetricsDataFilter.keepEntityName

List of entity names to always keep network metrics data. By default all entities are kept/enabled. This bypasses networkMetricsDataFilter.dropEntityName filter. For example: ["critical-service", "important-app"].

List

[]

logDataFilters.applicationLogReporting.enabled

Enables log collection from entities matching the filters below.

Boolean

true

logDataFilters.applicationLogReporting.fileRegex

Regular expression to match log file names to include.

String

".*.log$"

logDataFilters.applicationLogReporting.logLevelThreshold

Minimum log level to report (for example, TRACE, DEBUG, INFO, WARN, ERROR).

String

"INFO"

logDataFilters.applicationLogReporting.maxSamplesPerMinute

Maximum number of log samples to collect per minute from an entity. Once this limit is reached, events are sampled to maintain an even distribution across the harvest cycle.

Integer

10000

logDataFilters.applicationLogReporting.keepStdStreamEntityRegex

Regular expression to match entity names to keep logs from STDOUT and STDERR. Use .* to forward logs for all entities.

String

".*"

logDataFilters.applicationLogReporting.keepFileEntityRegex

Regular expression to match entity names to keep logs from log files. Use .* to forward logs for all entities.

String

".*"

protocols.global.max_unlinked_spans

Controls maximum unlinked spans reported per protocol. Set to 0 to disable limit. Unlinked spans are spans that the eBPF agent captures but cannot associate with its parent.

Integer

100

protocols.global.unlinked_spans_error_quota_percentage

Reserves a configurable percentage of the unlinked span quota for error spans, ensuring error visibility even when normal spans arrive first.

Integer

30

protocols.<protocol-name>.enabled

If true, enables monitoring for the specified protocol (for example, http, mysql, and any others).

Boolean

true

protocols.<protocol-name>.spans.enabled

If true, exports trace spans for the enabled protocol.

Boolean

true

protocols.<protocol-name>.spans.samplingLatency

Defines the latency-based sampling threshold for exporting spans. Supports values from p0 to p99.

String

"p50"

protocols.<protocol-name>.spans.samplingErrorRate

For HTTP and Thrift only. Exports spans from any route where the error rate exceeds the specified percentage (1-100).

String

""