Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/reference/config-all-options-summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/config-all-options-summary.html
applies_to:
stack:
serverless:
observability:
product:
apm_agent_dotnet: ga
---

# All options summary [config-all-options-summary]
Expand Down
90 changes: 76 additions & 14 deletions docs/reference/config-core.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/config-core.html
applies_to:
stack:
serverless:
observability:
product:
apm_agent_dotnet: ga
---

# Core configuration options [config-core]


## `Recording` ([1.7.0]) [config-recording]
## `Recording` [config-recording]

```{applies_to}
apm_agent_dotnet: ga 1.7.0
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -28,7 +38,11 @@ Setting `Recording` to `false` influences the behavior of the [*Public API*](/re
| `true` | Boolean |


## `Enabled` ([1.7.0]) [config-enabled]
## `Enabled` [config-enabled]

```{applies_to}
apm_agent_dotnet: ga 1.7.0
```

Setting this to `false` will completely disable the agent, including instrumentation and remote config polling. If you want to dynamically change the status of the agent, use [`recording`](#config-recording) instead.

Expand Down Expand Up @@ -64,7 +78,11 @@ The service name must conform to this regular expression: `^[a-zA-Z0-9 _-]+$`. I
| Name of the entry assembly | String |


## `ServiceNodeName` ([1.3]) [config-service-node-name]
## `ServiceNodeName` [config-service-node-name]

```{applies_to}
apm_agent_dotnet: ga 1.3
```

This is an optional name used to differentiate between nodes in a service. If this is not set, data aggregations are done based on a container ID (where valid) or on the reported hostname (automatically discovered).

Expand Down Expand Up @@ -95,7 +113,11 @@ A version string for the currently deployed version of the service. If you don
| Informational version of the entry assembly | String |


## `HostName` ([1.7]) [config-hostname]
## `HostName` [config-hostname]

```{applies_to}
apm_agent_dotnet: ga 1.7
```

This allows for the reported hostname to be manually specified. If this is not set, the hostname will be looked up.

Expand All @@ -108,7 +130,11 @@ This allows for the reported hostname to be manually specified. If this is not s
| `<none>` | String |


## `Environment` ([1.1]) [config-environment]
## `Environment` [config-environment]

```{applies_to}
apm_agent_dotnet: ga 1.1
```

The name of the environment that this service is deployed in, e.g. "production" or "staging".

Expand Down Expand Up @@ -155,7 +181,11 @@ This setting can be changed after the agent starts.
| 1.0 | Double |


## `TransactionMaxSpans` (performance) ([1.1.1]) [config-transaction-max-spans]
## `TransactionMaxSpans` (performance) [config-transaction-max-spans]

```{applies_to}
apm_agent_dotnet: ga 1.1.1
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -177,7 +207,11 @@ This setting can be changed after agent starts.
| `500` | Integer |


## `CentralConfig` ([1.1]) [config-central-config]
## `CentralConfig` [config-central-config]

```{applies_to}
apm_agent_dotnet: ga 1.1
```

If set to `true`, the agent makes periodic requests to the APM Server to fetch the latest [APM Agent configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md).

Expand All @@ -190,7 +224,11 @@ If set to `true`, the agent makes periodic requests to the APM Server to fetch t
| true | Boolean |


## `SanitizeFieldNames` ([1.2]) [config-sanitize-field-names]
## `SanitizeFieldNames` [config-sanitize-field-names]

```{applies_to}
apm_agent_dotnet: ga 1.2
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand Down Expand Up @@ -223,7 +261,11 @@ The `Cookie` header is automatically redacted for incoming HTTP request transact
| `password, passwd, pwd, secret, *key, *token*, *session*, *credit*, *card*, *auth*, set-cookie, *principal*` | Comma separated string |


## `GlobalLabels` ([1.2]) [config-global-labels]
## `GlobalLabels` [config-global-labels]

```{applies_to}
apm_agent_dotnet: ga 1.2
```

Labels are added to all events with the format `key=value[,key=value[,...]]`. Any labels set by the application via the agent’s public API will override global labels with the same keys.

Expand All @@ -241,7 +283,11 @@ This option requires APM Server 7.2 or later. It will have no effect on older ve



## `SpanCompressionEnabled` ([1.14]) [config-span-compression-enabled]
## `SpanCompressionEnabled` [config-span-compression-enabled]

```{applies_to}
apm_agent_dotnet: ga 1.14
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -256,7 +302,11 @@ Setting this option to true will enable span compression feature. Span compressi
| `true` | Boolean |


## `SpanCompressionExactMatchMaxDuration` ([1.14]) [config-span-compression-exact-match-max-duration]
## `SpanCompressionExactMatchMaxDuration` [config-span-compression-exact-match-max-duration]

```{applies_to}
apm_agent_dotnet: ga 1.14
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -271,7 +321,11 @@ Consecutive spans that are exact match and that are under this threshold will be
| `50ms` | TimeDuration |


## `SpanCompressionSameKindMaxDuration` ([1.14]) [config-span-compression-same-kind-max-duration]
## `SpanCompressionSameKindMaxDuration` [config-span-compression-same-kind-max-duration]

```{applies_to}
apm_agent_dotnet: ga 1.14
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -286,7 +340,11 @@ Consecutive spans to the same destination that are under this threshold will be
| `0ms` | TimeDuration |


## `ExitSpanMinDuration` ([1.14]) [config-exit-span-min-duration]
## `ExitSpanMinDuration` [config-exit-span-min-duration]

```{applies_to}
apm_agent_dotnet: ga 1.14
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -301,7 +359,11 @@ Sets the minimum duration of exit spans. Exit spans with a duration lesser than
| `0ms` | TimeDuration |


## `OpentelemetryBridgeEnabled` ([1.13]) [config-opentelemetry-bridge-enabled]
## `OpentelemetryBridgeEnabled` [config-opentelemetry-bridge-enabled]

```{applies_to}
apm_agent_dotnet: ga 1.13
```

Setting this option to `false` will disable the [OpenTelemetry Bridge](/reference/opentelemetry-bridge.md). This will disable the use of the vendor-neutral OpenTelemetry Tracing API (the [Activity API](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.activity?view=net-5.0) in .NET) to manually instrument your code, and have the Elastic .NET APM agent handle those API calls.

Expand Down
48 changes: 41 additions & 7 deletions docs/reference/config-http.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/config-http.html
applies_to:
stack:
serverless:
observability:
product:
apm_agent_dotnet: ga
---

# HTTP configuration options [config-http]


## `CaptureBody` (performance) ([1.0.1]) [config-capture-body]
## `CaptureBody` (performance) [config-capture-body]

```{applies_to}
apm_agent_dotnet: ga 1.0.1
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand Down Expand Up @@ -46,7 +56,11 @@ This setting can be changed after the agent starts.
| `off` | String |


## `CaptureBodyContentTypes` (performance) ([1.0.1]) [config-capture-body-content-types]
## `CaptureBodyContentTypes` (performance) [config-capture-body-content-types]

```{applies_to}
apm_agent_dotnet: ga 1.0.1
```

Configures the content types to be captured.

Expand Down Expand Up @@ -83,7 +97,11 @@ Setting this to `false` reduces memory allocations, network bandwidth, and disk
| `true` | Boolean |


## `TraceContinuationStrategy` (performance) ([1.17.0]) [config-trace-continuation-strategy]
## `TraceContinuationStrategy` (performance) [config-trace-continuation-strategy]

```{applies_to}
apm_agent_dotnet: ga 1.17.0
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand Down Expand Up @@ -149,7 +167,11 @@ Changing this configuration will overwrite the default value.



## `TransactionNameGroups` ([1.27.0]) [config-transaction-name-groups]
## `TransactionNameGroups` [config-transaction-name-groups]

```{applies_to}
apm_agent_dotnet: ga 1.27.0
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand All @@ -166,7 +188,11 @@ This option supports the wildcard `*`, which matches zero or more characters. Ex
| `<none>` | String |


## `UseElasticTraceparentHeader` ([1.3.0]) [config-use-elastic-apm-traceparent-header]
## `UseElasticTraceparentHeader` [config-use-elastic-apm-traceparent-header]

```{applies_to}
apm_agent_dotnet: ga 1.3.0
```

To enable [distributed tracing](docs-content://solutions/observability/apm/traces.md), the agent adds trace context headers to outgoing HTTP requests made with the `HttpClient` type. These headers (`traceparent` and `tracestate`) are defined in the [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification.

Expand All @@ -181,7 +207,11 @@ When this setting is `true`, the agent also adds the header `elasticapm-tracepar
| `true` | Boolean |


## `UsePathAsTransactionName` ([1.27.0]) [config-use-path-as-transaction-name]
## `UsePathAsTransactionName` [config-use-path-as-transaction-name]

```{applies_to}
apm_agent_dotnet: ga 1.27
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand Down Expand Up @@ -216,7 +246,11 @@ This is useful when using windows authentication on a proxy, that routes APM age
| `false` | Boolean |


## `BaggageToAttach` ([1.24]) [config-baggage-to-attach]
## `BaggageToAttach` [config-baggage-to-attach]

```{applies_to}
apm_agent_dotnet: ga 1.24
```

[![dynamic config](images/dynamic-config.svg "") ](/reference/configuration.md#dynamic-configuration)

Expand Down
12 changes: 11 additions & 1 deletion docs/reference/config-messaging.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/dotnet/current/config-messaging.html
applies_to:
stack:
serverless:
observability:
product:
apm_agent_dotnet: ga
---

# Messaging configuration options [config-messaging]


## `IgnoreMessageQueues` ([1.10]) [config-ignore-message-queues]
## `IgnoreMessageQueues` [config-ignore-message-queues]

```{applies_to}
apm_agent_dotnet: ga 1.10
```

Used to filter out specific messaging queues/topics/exchanges from being traced. When set, sends-to and receives-from the specified queues/topics/exchanges will be ignored.

Expand Down
Loading