Reporter 配置选项

编辑

ServerUrl

编辑

你的 APM Server 的 URL。该 URL 必须是完全限定的,包括协议(httphttps)和端口。

不建议使用 ServerUrls。请使用 ServerUrl

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_SERVER_URL

ElasticApm:ServerUrl

默认值 类型

https://127.0.0.1:8200

字符串

SecretToken

编辑

一个字符串,用于确保只有你的代理可以向你的 APM Server 发送数据。

代理和 APM Server 都必须配置相同的密钥令牌。如果 APM Server 需要密钥令牌,例如,当在 Elastic Cloud 上使用我们托管的 Elasticsearch 服务时,请使用此设置。

SecretToken 在每次向服务器发出的请求中都以明文发送,因此你应该使用 HTTPS 保护你的通信。否则,你的 API 密钥可能会被攻击者观察到。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_SECRET_TOKEN

ElasticApm:SecretToken

默认值 类型

<无>

字符串

ApiKey ( [1.4] 在 1.4 中添加。 )

编辑

一个 base64 编码的字符串,用于确保只有你的代理可以向你的 APM Server 发送数据。你必须使用 APM Server 的 命令行工具创建 API 密钥。

APM Server 版本 >= 7.6 完全支持此功能。

APIKey 在每次向服务器发出的请求中都以明文发送,因此你应该使用 HTTPS 保护你的通信。否则,你的 API 密钥可能会被攻击者观察到。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_API_KEY

ElasticApm:ApiKey

默认值 类型

<无>

一个 base64 编码的字符串

VerifyServerCert ( [1.3] 在 1.3 中添加。 )

编辑

默认情况下,如果你使用 HTTPS 连接到 APM Server,代理会验证 SSL 证书。

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

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_VERIFY_SERVER_CERT

ElasticApm:VerifyServerCert

默认值 类型

true

布尔值

此配置设置对 .NET Framework 版本 4.6.2-4.7.1 没有影响。我们建议升级到 .NET Framework 4.7.2 或更高版本以使用此配置设置。

ServerCert ( [1.9] 在 1.9 中添加。 )

编辑

APM Server 用于 SSL/TLS 的 PEM 编码证书的路径。用于通过证书绑定执行验证。

当使用由不在信任存储中的证书颁发机构 (CA) 签名的证书(例如自签名证书)时,可以指定此项。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_SERVER_CERT

ElasticApm:ServerCert

默认值 类型

<无>

字符串

此配置设置对 .NET Framework 版本 4.6.2-4.7.1 没有影响。我们建议升级到 .NET Framework 4.7.2 或更高版本以使用此配置设置。

FlushInterval ( [1.1] 在 1.1 中添加。 )

编辑

事件在队列中保留的最大时间量,直到有足够的事件可以发送一个批次。如果存在需要发送的事件,因为它们被保留的时间太长,则批次可能包含少于 MaxBatchEventCount 个事件。较低的值会增加 APM Server 的负载,而较高的值会增加应用程序的内存压力。较高的值还会影响事务在 Elasticsearch 中被索引和可搜索的时间。

支持持续时间后缀 mssm。示例:30s。此选项的默认单位为 s

如果 FlushInterval 设置为 0(或 0s0ms 等),并且没有仍在进行的事件发送操作,则代理不会将事件保留在队列中,而是会立即发送它们。

FlushInterval 设置为负值(例如 -1-54s-89ms 等)是无效的,在这种情况下,代理将使用默认值。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_FLUSH_INTERVAL

ElasticApm:FlushInterval

默认值 类型

10s

TimeDuration

MaxBatchEventCount ( [1.1] 在 1.1 中添加。 )

编辑

在批次中发送的最大事件数。如果存在需要发送的事件,因为它们被保留的时间太长(请参阅 FlushInterval),则批次可能包含少于最大事件数。

MaxBatchEventCount 设置为 0 或负值是无效的,代理将使用默认值。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_MAX_BATCH_EVENT_COUNT

ElasticApm:MaxBatchEventCount

默认值 类型

10

整数

MaxQueueEventCount ( [1.1] 在 1.1 中添加。 )

编辑

在队列中保留作为发送候选者的最大事件数。如果队列达到最大容量,则代理会丢弃新事件,直到队列有可用空间。

MaxQueueEventCount 设置为 0 或负值是无效的,代理将使用默认值。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_MAX_QUEUE_EVENT_COUNT

ElasticApm:MaxQueueEventCount

默认值 类型

1000

整数

MetricsInterval ( [1.0.0-beta1] 在 1.0.0-beta1 中添加。 )

编辑

代理向 APM Server 发送指标的间隔。这必须至少为 1s。将其设置为 0s 以停用。

支持持续时间后缀 mssm。示例:30s。此选项的默认单位为 s

默认值 类型

30s

TimeDuration

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_METRICS_INTERVAL

ElasticApm:MetricsInterval

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

编辑

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

你可以在指标中找到可用指标的名称。

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

默认值 类型

<无>

逗号分隔的字符串

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_DISABLE_METRICS

ElasticApm:DisableMetrics

CloudProvider ( [1.7.0] 在 1.7.0 中添加。 )

编辑

指定应该假设哪个云提供商进行元数据收集。默认情况下,代理会尝试检测云提供商,如果失败,则使用试错法来收集元数据。

有效选项为 "auto""aws""gcp""azure""none"。如果此配置值设置为 "none",则不会收集任何云元数据。如果设置为 "aws""gcp""azure" 中的任何一个,则只会从所选提供商执行元数据收集尝试。

环境变量名 IConfiguration 或 Web.config 键

ELASTIC_APM_CLOUD_PROVIDER

ElasticApm:CloudProvider

默认值 类型

auto

字符串