Reporter configuration options
editReporter configuration options
editServerUrl
editThe URL for your APM Server. The URL must be fully qualified, including protocol (http
or https
) and port.
Use of ServerUrls
is deprecated. Use ServerUrl
.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
String |
SecretToken
editA string used to ensure that only your agents can send data to your APM server.
Both the agents and the APM server have to be configured with the same secret token. Use this setting in case the APM Server requires a token (e.g. APM Server in Elastic Cloud).
the SecretToken
is sent as plain-text in every request to the server, so you should also secure
your communications using HTTPS. Unless you do so, your API Key could be observed by an attacker.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
String |
ApiKey
(
[1.4]
Added in 1.4.
)
editA base64-encoded string used to ensure that only your agents can send data to your APM server. You must have created the API key using the APM server’s command line tool.
This feature is fully supported in the APM Server versions >= 7.6.
the APIKey
is sent as plain-text in every request to the server, so you should also secure
your communications using HTTPS. Unless you do so, your API Key could be observed by an attacker.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
A base64-encoded string |
VerifyServerCert
(
[1.3]
Added in 1.3.
)
editBy default, the agent verifies the SSL certificate if you use an HTTPS connection to the APM server.
Verification can be disabled by changing this setting to false.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
Boolean |
FlushInterval
(
[1.1]
Added in 1.1.
)
editThe maximal amount of time events are held in the queue until there is enough to send a batch.
It’s possible for a batch to contain less than MaxBatchEventCount
events
if there are events that need to be sent out because they were held for too long.
A lower value will increase the load on your APM server,
while a higher value can increase the memory pressure on your app.
A higher value also impacts the time until transactions are indexed and searchable in Elasticsearch.
Supports the duration suffixes ms
, s
and m
.
Example: 30s
.
The default unit for this option is s
.
If FlushInterval
is set to 0
(or 0s
, 0ms
, etc.) and
there’s no event sending operation still in progress
then the Agent won’t hold events in the queue and instead will send them immediately.
Setting FlushInterval
to a negative value (for example -1
, -54s
, -89ms
, etc.) is invalid and
in that case agent uses the default value instead.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
TimeDuration |
MaxBatchEventCount
(
[1.1]
Added in 1.1.
)
editThe maximal number of events to send in a batch.
It’s possible for a batch to contain less then the maximum events
if there are events that need to be sent out because they were held for too long
(see FlushInterval
).
Setting MaxBatchEventCount
to 0 or a negative value is invalid and
in that case the Agent will use the default value instead.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
10 |
Integer |
MaxQueueEventCount
(
[1.1]
Added in 1.1.
)
editThe maximum number of events to hold in the queue as candidates to be sent. If the queue is at its maximum capacity then the agent discards the new events until the queue has free space.
Setting MaxQueueEventCount
to 0 or a negative value is invalid and
in that case the Agent will use the default value instead.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
1000 |
Integer |
MetricsInterval
(
[1.0.0-beta1]
Added in 1.0.0-beta1.
)
editThe interval at which the agent sends metrics to the APM Server.
Must be at least 1s
.
Set to 0s
to deactivate.
Supports the duration suffixes ms
, s
and m
.
Example: 30s
.
The default unit for this option is s
.
Default | Type |
---|---|
|
TimeDuration |
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
DisableMetrics
(
[1.3.0]
Added in 1.3.0.
)
editDisables the collection of certain metrics. If the name of a metric matches any of the wildcard expressions, it will not be collected. Example: foo.*,bar.*
You can find the name of the available metrics in Metrics.
This option supports the wildcard *
, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*
. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.
Default | Type |
---|---|
<none> |
List<string> |
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
CloudProvider
(
[1.7.0]
Added in 1.7.0.
)
editAllows you to specify which cloud provider should be assumed for metadata collection. By default, the agent will attempt to detect the cloud provider and, if that fails, use trial and error to collect the metadata.
Valid options are "auto"
, "aws"
, "gcp"
, "azure"
, and "none"
. If this config value is set to "none"
, no cloud metadata will be collected. If set to any of
"aws"
, "gcp"
, or "azure"
, attempts to collect metadata will only be performed
from the chosen provider.
Environment variable name | IConfiguration or Web.config key |
---|---|
|
|
Default | Type |
---|---|
|
String |