--- title: Reporter configuration options description: Reference for reporter configuration options that control how the agent connects to the APM Server, including server URL, authentication, and data buffering settings. url: https://www.elastic.co/elastic/docs-builder/docs/4572/reference/apm/agents/dotnet/config-reporter products: - APM .NET Agent - APM Agent applies_to: - Serverless Observability projects: Generally available - Elastic Stack: Generally available - Application Performance Monitoring Agent for .NET: Generally available --- # Reporter configuration options ## `ServerUrl` The 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 | |---------------------------|----------------------------------| | `ELASTIC_APM_SERVER_URL` | `ElasticApm:ServerUrl` | | Default | Type | |-------------------------|--------| | `http://localhost:8200` | String | ## `SecretToken` A 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 if the APM Server requires a secret token, for example, when using our hosted Elasticsearch Service on 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 | |----------------------------|----------------------------------| | `ELASTIC_APM_SECRET_TOKEN` | `ElasticApm:SecretToken` | | Default | Type | |----------|--------| | `` | String | ## `ApiKey` ([1.4]) A 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 one of the methods described in [API keys for Elastic APM](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/4572/solutions/observability/apm/api-keys). 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 | |---------------------------|----------------------------------| | `ELASTIC_APM_API_KEY` | `ElasticApm:ApiKey` | | Default | Type | |----------|-------------------------| | `` | A base64-encoded string | ## `VerifyServerCert` - Application Performance Monitoring Agent for .NET: Generally available since 1.3 By default, the agent verifies the SSL certificate if you use an HTTPS connection to the APM Server. Verification can be turned off by changing this setting to false. | Environment variable name | IConfiguration or Web.config key | |----------------------------------|----------------------------------| | `ELASTIC_APM_VERIFY_SERVER_CERT` | `ElasticApm:VerifyServerCert` | | Default | Type | |---------|---------| | `true` | Boolean | This configuration setting has no effect on .NET Framework versions 4.6.2 to 4.7.1. Upgrade to .NET Framework 4.7.2 or newer to use this setting. ## `ServerCert` - Application Performance Monitoring Agent for .NET: Generally available since 1.9 The path to a PEM-encoded certificate used for SSL/TLS by APM Server. Used to perform validation through certificate pinning. This can be specified when using a certificate signed by a Certificate Authority (CA) that is not in the trust store, such as a self-signed certificate. | Environment variable name | IConfiguration or Web.config key | |---------------------------|----------------------------------| | `ELASTIC_APM_SERVER_CERT` | `ElasticApm:ServerCert` | | Default | Type | |----------|--------| | `` | String | This configuration setting has no effect on .NET Framework versions 4.6.2 to 4.7.1. Upgrade to .NET Framework 4.7.2 or newer to use this setting. ## `ServerConnectionLifetime` - Application Performance Monitoring Agent for .NET: Planned The maximum amount of time a connection to APM Server is reused before the agent replaces it with a new one. Without periodic replacement, the agent keeps using the same connection for as long as it stays open. It therefore doesn't notice when the DNS name of APM Server starts resolving to a different address, for example after a failover or a migration, and it doesn't spread across the instances behind a load balancer that balances per connection. Replacing connections periodically makes the agent look the name up again and connect to whichever address it currently resolves to. The agent picks up a DNS change within about this value plus the time-to-live (TTL) of the DNS record. Supports the duration suffixes `ms`, `s` and `m`. Example: `5m`. The default unit for this option is `s`. A connection that is in use is never interrupted. A connection that is older than this value is replaced when the next request is sent. If `ServerConnectionLifetime` is set to `0` (or `0s`, `0ms`, and so on), connections are not replaced because of their age. This is the behavior of previous agent versions on .NET 8 or later. Setting `ServerConnectionLifetime` to a negative value (for example `-1`, `-54s`, `-89ms`, and so on) is invalid and in that case the agent uses the default value instead. Very small values cause the agent to open a new connection, including a new TLS handshake, for nearly every request. Use the default unless you have a specific reason to change it. If you use [`UseWindowsCredentials`](/elastic/docs-builder/docs/4572/reference/apm/agents/dotnet/config-http#config-use-windows-credentials) with a proxy that uses connection-based authentication (NTLM or Negotiate), each new connection repeats the authentication handshake. Increase this value if that is a concern. | Environment variable name | IConfiguration or Web.config key | |------------------------------------------|---------------------------------------| | `ELASTIC_APM_SERVER_CONNECTION_LIFETIME` | `ElasticApm:ServerConnectionLifetime` | | Default | Type | |---------|--------------| | `1m` | TimeDuration | On .NET Framework this option configures `ServicePoint.ConnectionLeaseTimeout`, which has applied a fixed one-minute value in previous agent versions. .NET Framework also caches DNS results for up to two minutes (`ServicePointManager.DnsRefreshTimeout`), and the setting is applied once per process, using the configuration of the first agent that connects to APM Server.This option has no effect on .NET Core 3.x to .NET 7, which are served by the `netstandard2.1` build of the agent. These runtimes are out of support. ## `FlushInterval` - Application Performance Monitoring Agent for .NET: Generally available since 1.1 The 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`](#config-max-batch-event-count) 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`, and so on) and there’s no event sending operation still in progress, then the Agent won’t hold events in the queue and will send them immediately. Setting `FlushInterval` to a negative value (for example `-1`, `-54s`, `-89ms`, and so on) is invalid and in that case agent uses the default value instead. | Environment variable name | IConfiguration or Web.config key | |------------------------------|----------------------------------| | `ELASTIC_APM_FLUSH_INTERVAL` | `ElasticApm:FlushInterval` | | Default | Type | |---------|--------------| | `10s` | TimeDuration | ## `MaxBatchEventCount` - Application Performance Monitoring Agent for .NET: Generally available since 1.1 The maximum 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`](#config-flush-interval)). Setting `MaxBatchEventCount` to `0` or a negative value is invalid and the Agent will use the default value instead. | Environment variable name | IConfiguration or Web.config key | |-------------------------------------|----------------------------------| | `ELASTIC_APM_MAX_BATCH_EVENT_COUNT` | `ElasticApm:MaxBatchEventCount` | | Default | Type | |---------|---------| | 10 | Integer | ## `MaxQueueEventCount` - Application Performance Monitoring Agent for .NET: Generally available since 1.1 The 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 the Agent will use the default value instead. | Environment variable name | IConfiguration or Web.config key | |-------------------------------------|----------------------------------| | `ELASTIC_APM_MAX_QUEUE_EVENT_COUNT` | `ElasticApm:MaxQueueEventCount` | | Default | Type | |---------|---------| | 1000 | Integer | ## `MetricsInterval` - Application Performance Monitoring Agent for .NET: Generally available since 1.0 The interval at which the agent sends metrics to the APM Server. This must be at least `1s`. Set this to `0s` to deactivate. Supports the duration suffixes `ms`, `s` and `m`. Example: `30s`. The default unit for this option is `s`. | Default | Type | |---------|--------------| | `30s` | TimeDuration | | Environment variable name | IConfiguration or Web.config key | |--------------------------------|----------------------------------| | `ELASTIC_APM_METRICS_INTERVAL` | `ElasticApm:MetricsInterval` | ## `DisableMetrics` - Application Performance Monitoring Agent for .NET: Generally available since 1.3 This turns off 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*](https://www.elastic.co/elastic/docs-builder/docs/4572/reference/apm/agents/dotnet/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 | |---------|------------------------| | | Comma separated string | | Environment variable name | IConfiguration or Web.config key | |-------------------------------|----------------------------------| | `ELASTIC_APM_DISABLE_METRICS` | `ElasticApm:DisableMetrics` | ## `CloudProvider` - Application Performance Monitoring Agent for .NET: Generally available since 1.7 Specify which cloud provider should be assumed for metadata collection. By default, the agent attempts to detect the cloud provider and, if that fails, uses 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 | |------------------------------|----------------------------------| | `ELASTIC_APM_CLOUD_PROVIDER` | `ElasticApm:CloudProvider` | | Default | Type | |---------|--------| | `auto` | String |