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
4 changes: 2 additions & 2 deletions docs/reference/config-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ This allows for the reported hostname to be manually specified. If this is not s

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

Environments allow you to easily filter data on a global level in the APM app. It’s important to be consistent when naming environments across agents. See [environment selector](docs-content://solutions/observability/apps/filter-application-data.md#apm-filter-your-data-service-environment-filter) in the Kibana UI for more information.
Environments allow you to easily filter data on a global level in the APM app. It’s important to be consistent when naming environments across agents. See [environment selector](docs-content://solutions/observability/apm/filter-data.md#apm-filter-your-data-service-environment-filter) in the Kibana UI for more information.

::::{note}
This feature is fully supported in the APM app in Kibana versions >= 7.2. You must use the query bar to filter for a specific environment in versions prior to 7.2.
Expand Down Expand Up @@ -179,7 +179,7 @@ This setting can be changed after agent starts.

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

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

| Environment variable name | IConfiguration key |
| --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/config-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ This option supports the wildcard `*`, which matches zero or more characters. Ex

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

To enable [distributed tracing](docs-content://solutions/observability/apps/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.
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.

When this setting is `true`, the agent also adds the header `elasticapm-traceparent` for backwards compatibility with older versions of Elastic APM agents. Versions prior to `1.3.0` only read the `elasticapm-traceparent` header.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/config-reporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The `SecretToken` is sent as plain-text in every request to the server, so you s

## `ApiKey` ([1.4]) [config-api-key]

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 the APM server’s [command line tool](docs-content://solutions/observability/apps/api-keys.md).
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 the APM server’s [command line tool](docs-content://solutions/observability/apm/api-keys.md).

::::{note}
This feature is fully supported in the APM Server versions >= 7.6.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ By default, the agent uses environment variables. Additionally, on ASP.NET Core,

Configuration options that are marked with the ![dynamic config](/reference/images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.

The .NET Agent supports [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md), which allows you to fine-tune certain configurations via the APM app. This feature is enabled in the Agent by default, with [`CentralConfig` ([1.1])](/reference/config-core.md#config-central-config).
The .NET Agent supports [Central configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md), which allows you to fine-tune certain configurations via the APM app. This feature is enabled in the Agent by default, with [`CentralConfig` ([1.1])](/reference/config-core.md#config-central-config).



Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ The Agent automatically registers callback methods for built-in Diagnostic Sourc

## Additional Components [additional-components]

APM Agents work in conjunction with the [APM Server](docs-content://solutions/observability/apps/application-performance-monitoring-apm.md), [Elasticsearch](docs-content://get-started/index.md), and [Kibana](docs-content://get-started/the-stack.md). The [APM Guide](docs-content://solutions/observability/apps/application-performance-monitoring-apm.md) provides details on how these components work together, and provides a matrix outlining [Agent and Server compatibility](docs-content://solutions/observability/apps/apm-agent-compatibility.md).
APM Agents work in conjunction with the [APM Server](docs-content://solutions/observability/apm/index.md), [Elasticsearch](docs-content://get-started/index.md), and [Kibana](docs-content://get-started/the-stack.md). The [APM Guide](docs-content://solutions/observability/apm/index.md) provides details on how these components work together, and provides a matrix outlining [Agent and Server compatibility](docs-content://solutions/observability/apm/apm-agent-compatibility.md).
2 changes: 1 addition & 1 deletion docs/reference/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The approximate accumulated collection elapsed time in milliseconds.

## Built-in application metrics [metrics-application]

To power the [Time spent by span type](docs-content://solutions/observability/apps/transactions-2.md) graph, the agent collects summarized metrics about the timings of spans and transactions, broken down by span type.
To power the [Time spent by span type](docs-content://solutions/observability/apm/transactions-ui.md) graph, the agent collects summarized metrics about the timings of spans and transactions, broken down by span type.

**`transaction.duration`**
: type: simple timer
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/public-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Agent.Tracer.CaptureErrorLog(errorLog);

## Transaction API [api-transaction]

A transaction describes an event captured by an Elastic APM agent monitoring a service. Transactions help combine multiple [Spans](#api-span) into logical groups, and they are the first [Span](#api-span) of a service. More information on Transactions and Spans is available in the [APM data model](docs-content://solutions/observability/apps/learn-about-application-data-types.md) documentation.
A transaction describes an event captured by an Elastic APM agent monitoring a service. Transactions help combine multiple [Spans](#api-span) into logical groups, and they are the first [Span](#api-span) of a service. More information on Transactions and Spans is available in the [APM data model](docs-content://solutions/observability/apm/data-types.md) documentation.

See [`ITransaction CurrentTransaction`](#api-current-transaction) on how to get a reference of the current transaction.

Expand Down Expand Up @@ -363,7 +363,7 @@ A flat mapping of user-defined labels with string values.
If the key contains any special characters (`.`,`*`, `"`), they will be replaced with underscores. For example `a.b` will be stored as `a_b`.

::::{tip}
Before using custom labels, ensure you understand the different types of [metadata](docs-content://solutions/observability/apps/metadata.md) that are available.
Before using custom labels, ensure you understand the different types of [metadata](docs-content://solutions/observability/apm/metadata.md) that are available.
::::


Expand Down Expand Up @@ -659,7 +659,7 @@ Similar to [`Dictionary<string,string> Labels`](#api-transaction-tags) on the [T
If the key contains any special characters (`.`,`*`, `"`), they will be replaced with underscores. For example `a.b` will be stored as `a_b`.

::::{tip}
Before using custom labels, ensure you understand the different types of [metadata](docs-content://solutions/observability/apps/metadata.md) that are available.
Before using custom labels, ensure you understand the different types of [metadata](docs-content://solutions/observability/apm/metadata.md) that are available.
::::


Expand Down
14 changes: 7 additions & 7 deletions docs/reference/setup-auto-instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S

1. `<unzipped directory>` is the directory to which the zip file was unzipped in step 2.
2. The URL of the APM server intake to which traces and metrics should be sent.
3. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
3. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


```sh
Expand All @@ -100,7 +100,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S

1. `<unzipped directory>` is the directory to which the zip file was unzipped in step 2.
2. The URL of the APM server intake to which traces and metrics should be sent.
3. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
3. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


```sh
Expand All @@ -115,7 +115,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S

1. `<unzipped directory>` is the directory to which the zip file was unzipped in step 2.
2. The URL of the APM server intake to which traces and metrics should be sent.
3. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
3. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


Ensure you start your application in a context where the set environment variables are visible.
Expand Down Expand Up @@ -207,7 +207,7 @@ Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\<service-name> -Name Env

1. `<unzipped directory>` is the directory to which the zip file was unzipped.
2. The URL of the APM server intake to which traces and metrics should be sent.
3. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
3. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.
4. `<service-name>` is the name of the Windows service.


Expand Down Expand Up @@ -248,7 +248,7 @@ $environment.Keys | ForEach-Object {
2. `<unzipped directory>` is the full path to the directory in which the zip file was unzipped
3. Forces assemblies **not** to be loaded domain-neutral. There is currently a limitation where Profiler auto-instrumentation cannot instrument assemblies when they are loaded domain-neutral. This limitation is expected to be removed in future, but for now, can be worked around by setting this environment variable. See the [Microsoft documentation for further details](https://docs.microsoft.com/en-us/dotnet/framework/app-domains/application-domains#the-complus_loaderoptimization-environment-variable).
4. The URL of the APM server intake to which traces and metrics should be sent.
5. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
5. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


```powershell
Expand All @@ -273,7 +273,7 @@ $environment.Keys | ForEach-Object {
1. `<application-pool>` is the name of the Application Pool your application uses. For example, `IIS APPPOOL\DefaultAppPool`.
2. `<unzipped directory>` is the full path to the directory in which the zip file was unzipped.
3. The URL of the APM server intake to which traces and metrics should be sent.
4. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
4. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


::::{important}
Expand Down Expand Up @@ -306,7 +306,7 @@ ELASTIC_APM_SECRET_TOKEN=<secret token> <3>

1. `<unzipped directory>` is the directory to which the zip file was unzipped.
2. The URL of the APM server intake to which traces and metrics should be sent.
3. The [secret token](docs-content://solutions/observability/apps/secret-token.md) used by the APM Agent to authenticate with APM server.
3. The [secret token](docs-content://solutions/observability/apm/secret-token.md) used by the APM Agent to authenticate with APM server.


Then adding an [`EnvironmentFile`](https://www.freedesktop.org/software/systemd/man/systemd.service.html#Command%20lines) entry to the service’s configuration file that references the path to the environment.env file
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/setup-azure-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The .NET APM Agent can trace HTTP triggered function invocations in an [Azure Fu

## Prerequisites [_prerequisites]

You need an APM Server to send APM data to. Follow the [APM Quick start](docs-content://solutions/observability/apps/get-started-with-apm.md) if you have not set one up yet. You will need your **APM server URL** and an APM server **secret token** (or **API key**) for configuring the APM agent below.
You need an APM Server to send APM data to. Follow the [APM Quick start](docs-content://solutions/observability/apm/get-started.md) if you have not set one up yet. You will need your **APM server URL** and an APM server **secret token** (or **API key**) for configuring the APM agent below.

You will also need an Azure Function app to monitor. If you do not have an existing one, you can follow [this Azure guide](https://learn.microsoft.com/en-us/azure/azure-functions/create-first-function-cli-csharp) to create one.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Upgrades between minor versions of the agent, like from 1.1 to 1.2 are always ba
Before upgrading the agent, be sure to review the:

* [Agent release notes](/release-notes/index.md)
* [Agent and Server compatibility chart](docs-content://solutions/observability/apps/apm-agent-compatibility.md)
* [Agent and Server compatibility chart](docs-content://solutions/observability/apm/apm-agent-compatibility.md)


## End of life dates [end-of-life-dates]
Expand Down