报告器配置选项
编辑报告器配置选项编辑
ServerUrl
编辑
APM 服务器的 URL。URL 必须是完全限定的,包括协议(http
或 https
)和端口。
不建议使用 ServerUrls
。请使用 ServerUrl
。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
字符串 |
SecretToken
编辑
用于确保只有您的代理可以将数据发送到 APM 服务器的字符串。
代理和 APM 服务器都必须配置相同的密钥。如果 APM 服务器需要密钥,例如,在 Elastic Cloud 上使用我们托管的 Elasticsearch Service 时,请使用此设置。
SecretToken
在发送到服务器的每个请求中都以纯文本形式发送,因此您还应该使用 HTTPS 来保护您的通信安全。除非您这样做,否则您的 API 密钥可能会被攻击者观察到。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
字符串 |
ApiKey
( [1.4] 在 1.4 中添加。 )编辑
一个 base64 编码的字符串,用于确保只有您的代理可以将数据发送到您的 APM 服务器。您必须使用 APM 服务器的命令行工具创建 API 密钥。
APM 服务器版本 >= 7.6 完全支持此功能。
APIKey
在发送到服务器的每个请求中都以纯文本形式发送,因此您还应该使用 HTTPS 来保护您的通信安全。除非您这样做,否则您的 API 密钥可能会被攻击者观察到。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
一个 base64 编码的字符串 |
VerifyServerCert
( [1.3] 在 1.3 中添加。 )编辑
默认情况下,如果您使用 HTTPS 连接到 APM 服务器,代理会验证 SSL 证书。
可以通过将此设置更改为 false 来禁用验证。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
布尔值 |
此配置设置对 .NET Framework 版本 4.6.2-4.7.1 无效。我们建议升级到 .NET Framework 4.7.2 或更高版本以使用此配置设置。
ServerCert
( [1.9] 在 1.9 中添加。 )编辑
APM 服务器用于 SSL/TLS 的 PEM 编码证书的路径。用于通过证书固定执行验证。
当使用由不受信任存储区中的证书颁发机构 (CA) 签署的证书(例如自签名证书)时,可以指定此选项。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
字符串 |
此配置设置对 .NET Framework 版本 4.6.2-4.7.1 无效。我们建议升级到 .NET Framework 4.7.2 或更高版本以使用此配置设置。
FlushInterval
( [1.1] 在 1.1 中添加。 )编辑
在队列中保存事件的最长时间,直到有足够的事件发送批处理。如果存在需要发送的事件,因为它们被保存的时间过长,则批处理中包含的事件数量可能少于 MaxBatchEventCount
个事件。较低的值会增加 APM 服务器的负载,而较高的值会增加应用程序的内存压力。较高的值还会影响事务在 Elasticsearch 中建立索引和可搜索的时间。
支持持续时间后缀 ms
、s
和 m
。例如:30s
。此选项的默认单位是 s
。
如果 FlushInterval
设置为 0
(或 0s
、0ms
等),并且没有仍在进行的事件发送操作,则代理不会将事件保存在队列中,而是会立即发送它们。
将 FlushInterval
设置为负值(例如 -1
、-54s
、-89ms
等)无效,在这种情况下,代理将使用默认值。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
TimeDuration |
MaxBatchEventCount
( [1.1] 在 1.1 中添加。 )编辑
要在批处理中发送的最大事件数。如果存在需要发送的事件,因为它们被保存的时间过长(请参阅 FlushInterval
),则批处理中包含的事件数量可能少于最大事件数。
将 MaxBatchEventCount
设置为 0
或负值无效,代理将使用默认值。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
10 |
整数 |
MaxQueueEventCount
( [1.1] 在 1.1 中添加。 )编辑
要在队列中保存为候选事件的最大事件数。如果队列已满,则代理会丢弃新事件,直到队列中有可用空间。
将 MaxQueueEventCount
设置为 0
或负值无效,代理将使用默认值。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
1000 |
整数 |
MetricsInterval
( [1.0.0-beta1] 在 1.0.0-beta1 中添加。 )编辑
代理将指标发送到 APM 服务器的时间间隔。此值必须至少为 1s
。将其设置为 0s
可停用。
支持持续时间后缀 ms
、s
和 m
。例如:30s
。此选项的默认单位是 s
。
默认值 | 类型 |
---|---|
|
TimeDuration |
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
DisableMetrics
( [1.3.0] 在 1.3.0 中添加。 )编辑
这将禁用某些指标的收集。如果指标的名称与任何通配符表达式匹配,则不会收集该指标。例如:foo.*,bar.*
您可以在指标中找到可用指标的名称。
此选项支持通配符 *
,它匹配零个或多个字符。例如:/foo/*/bar/*/baz*, *foo*
。默认情况下,匹配不区分大小写。在元素前面加上 (?-i) 使匹配区分大小写。
默认值 | 类型 |
---|---|
<无> |
逗号分隔的字符串 |
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
CloudProvider
( [1.7.0] 在 1.7.0 中添加。 )编辑
指定应为元数据收集假设哪个云提供商。默认情况下,代理会尝试检测云提供商,如果失败,则使用试错法来收集元数据。
有效选项为 "auto"
、"aws"
、"gcp"
、"azure"
和 "none"
。如果此配置值设置为 "none"
,则不会收集任何云元数据。如果设置为 "aws"
、"gcp"
或 "azure"
中的任何一个,则只会从所选提供商处尝试收集元数据。
环境变量名称 | IConfiguration 或 Web.config 键 |
---|---|
|
|
默认值 | 类型 |
---|---|
|
字符串 |