Reporter 配置选项

编辑

secret_token

编辑

此字符串用于确保只有您的代理才能将数据发送到您的 APM 服务器。

代理和 APM 服务器都必须配置相同的密钥令牌。如果 APM 服务器需要令牌,请使用此选项。

dynamic config

默认值 类型 动态

<无>

字符串

true

Java 系统属性 属性文件 环境变量

elastic.apm.secret_token

secret_token

ELASTIC_APM_SECRET_TOKEN

api_key

编辑

此字符串用于确保只有您的代理才能将数据发送到您的 APM 服务器。

代理可以使用 API 密钥替换密钥令牌,APM 服务器可以有多个 API 密钥。同时使用密钥令牌和 API 密钥时,API 密钥优先,密钥令牌将被忽略。如果 APM 服务器需要 API 密钥,请使用此选项。

dynamic config

默认值 类型 动态

<无>

字符串

true

Java 系统属性 属性文件 环境变量

elastic.apm.api_key

api_key

ELASTIC_APM_API_KEY

server_url

编辑

URL 必须是完全限定的,包括协议 (http 或 https) 和端口。

如果在 APM 服务器上启用了 SSL,请使用 https 协议。有关更多信息,请参见 与 APM 服务器的 SSL/TLS 通信

如果传出的 HTTP 流量必须通过代理,则可以使用 Java 系统属性 http.proxyHosthttp.proxyPort 进行设置。有关更多信息,另请参见 Java 的代理文档

从 1.8.0 开始,此配置只能动态重新加载。

dynamic config

默认值 类型 动态

http://127.0.0.1:8200

URL

true

Java 系统属性 属性文件 环境变量

elastic.apm.server_url

server_url

ELASTIC_APM_SERVER_URL

server_urls

编辑

URL 必须是完全限定的,包括协议 (http 或 https) 和端口。

在发生连接错误时故障转移到下一个 APM 服务器 URL。通过随机排列配置的 URL 列表来实现负载均衡。当多个代理处于活动状态时,由于随机性,它们往往会均匀地分布在服务器集中。

如果在 APM 服务器上启用了 SSL,请使用 https 协议。有关更多信息,请参见 与 APM 服务器的 SSL/TLS 通信

如果传出的 HTTP 流量必须通过代理,则可以使用 Java 系统属性 http.proxyHosthttp.proxyPort 进行设置。有关更多信息,另请参见 Java 的代理文档

此配置特定于 Java 代理,与任何其他 APM 代理都不一致。为了使用跨代理配置,请改用 server_url,这是无论您是否只设置单个 URL 都推荐的选项。

dynamic config

默认值 类型 动态

<无>

列表

true

Java 系统属性 属性文件 环境变量

elastic.apm.server_urls

server_urls

ELASTIC_APM_SERVER_URLS

disable_send

编辑

如果设置为 true,代理将照常工作,但任何需要与 APM 服务器通信的任务除外。事件将被丢弃,并且代理将无法接收中央配置,这意味着在这种状态下,任何其他配置都无法更改,除非重新启动服务。此功能的一个示例用例是维护通过日志关联功能创建跟踪和记录跟踪/事务/跨度 ID 的能力,而无需设置 APM 服务器。

默认值 类型 动态

false

布尔值

false

Java 系统属性 属性文件 环境变量

elastic.apm.disable_send

disable_send

ELASTIC_APM_DISABLE_SEND

server_timeout

编辑

如果对 APM 服务器的请求花费的时间超过配置的超时时间,则请求将被取消,并且事件(异常或事务)将被丢弃。设置为 0 可禁用超时。

如果禁用超时或将其设置为较高的值,如果 APM 服务器超时,您的应用程序可能会遇到内存问题。

dynamic config

支持持续时间后缀 mssm。示例:5s

默认值 类型 动态

5s

时间持续时间

true

Java 系统属性 属性文件 环境变量

elastic.apm.server_timeout

server_timeout

ELASTIC_APM_SERVER_TIMEOUT

verify_server_cert

编辑

默认情况下,如果使用 HTTPS 连接到 APM 服务器,代理将验证 SSL 证书。

可以通过将此设置更改为 false 来禁用验证。

默认值 类型 动态

true

布尔值

false

Java 系统属性 属性文件 环境变量

elastic.apm.verify_server_cert

verify_server_cert

ELASTIC_APM_VERIFY_SERVER_CERT

max_queue_size

编辑

缓冲事件的最大大小。

当代理无法跟上将事务和跨度发送到 APM 服务器的速度或 APM 服务器关闭时,事务和跨度等事件将被缓冲。

如果队列已满,则会拒绝事件,这意味着在这种情况下您将丢失事务和跨度。这可以保护应用程序在 APM 服务器长时间不可用时不会崩溃。

较低的值将降低代理的堆开销,而较高的值则可以降低在吞吐量暂时激增时丢失事件的可能性。

默认值 类型 动态

512

整数

false

Java 系统属性 属性文件 环境变量

elastic.apm.max_queue_size

max_queue_size

ELASTIC_APM_MAX_QUEUE_SIZE

include_process_args

编辑

是否应为每个事务附加进程参数。默认情况下禁用此选项以节省磁盘空间。

默认值 类型 动态

false

布尔值

false

Java 系统属性 属性文件 环境变量

elastic.apm.include_process_args

include_process_args

ELASTIC_APM_INCLUDE_PROCESS_ARGS

api_request_time

编辑

保持与 APM 服务器打开的 HTTP 请求的最大时间。

此值必须低于 APM 服务器的 read_timeout 设置。

dynamic config

支持持续时间后缀 mssm。示例:10s

默认值 类型 动态

10s

时间持续时间

true

Java 系统属性 属性文件 环境变量

elastic.apm.api_request_time

api_request_time

ELASTIC_APM_API_REQUEST_TIME

api_request_size

编辑

通过分块编码(HTTP 流)发送到 APM 服务器接收 API 的请求正文的最大总压缩大小。请注意,可能会有少量超量。

允许的字节单位为 bkbmb1kb 等于 1024b

dynamic config

默认值 类型 动态

768kb

字节值

true

Java 系统属性 属性文件 环境变量

elastic.apm.api_request_size

api_request_size

ELASTIC_APM_API_REQUEST_SIZE

metrics_interval ( [1.3.0] 在 1.3.0 中添加。 )

编辑

代理将指标发送到 APM 服务器的间隔,向下舍入到最接近的秒(即 3783ms 将应用为 3000ms)。如果在 Meter 中定义了间隔(步长),则将改为使用该间隔(最接近的秒),用于该 Meter。如果 Meter 步长间隔小于 1 秒,则不会报告该指标。必须至少为 1s。设置为 0s 可停用。

支持持续时间后缀 mssm。示例:30s

默认值 类型 动态

30s

时间持续时间

false

Java 系统属性 属性文件 环境变量

elastic.apm.metrics_interval

metrics_interval

ELASTIC_APM_METRICS_INTERVAL

disable_metrics ( [1.3.0] 在 1.3.0 中添加。 )

编辑

禁用某些指标的收集。如果指标的名称与任何通配符表达式匹配,则不会收集该指标。示例:foo.*,bar.*

此选项支持通配符 *,它匹配零个或多个字符。示例:/foo/*/bar/*/baz**foo*。默认情况下匹配不区分大小写。在元素前加上 (?-i) 将使匹配区分大小写。

默认值 类型 动态

<无>

列表

false

Java 系统属性 属性文件 环境变量

elastic.apm.disable_metrics

disable_metrics

ELASTIC_APM_DISABLE_METRICS