diff --git a/docs/reference/config-core.md b/docs/reference/config-core.md index a318ac70d..b6956bfd8 100644 --- a/docs/reference/config-core.md +++ b/docs/reference/config-core.md @@ -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. @@ -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 | | --- | --- | diff --git a/docs/reference/config-http.md b/docs/reference/config-http.md index 1b7bda983..c1d0ce63c 100644 --- a/docs/reference/config-http.md +++ b/docs/reference/config-http.md @@ -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. diff --git a/docs/reference/config-reporter.md b/docs/reference/config-reporter.md index f1b7250ed..8160005a4 100644 --- a/docs/reference/config-reporter.md +++ b/docs/reference/config-reporter.md @@ -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. diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 9bd50deb0..a8159cc9b 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -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). diff --git a/docs/reference/index.md b/docs/reference/index.md index 23b6648bc..38a02d55a 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -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). diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md index d66ad06c4..f1f56e700 100644 --- a/docs/reference/metrics.md +++ b/docs/reference/metrics.md @@ -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 diff --git a/docs/reference/public-api.md b/docs/reference/public-api.md index d2296808b..e1f490ef7 100644 --- a/docs/reference/public-api.md +++ b/docs/reference/public-api.md @@ -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. @@ -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. :::: @@ -659,7 +659,7 @@ Similar to [`Dictionary 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. :::: diff --git a/docs/reference/setup-auto-instrumentation.md b/docs/reference/setup-auto-instrumentation.md index 15aa01d0c..ba1db0def 100644 --- a/docs/reference/setup-auto-instrumentation.md +++ b/docs/reference/setup-auto-instrumentation.md @@ -85,7 +85,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S 1. `` 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 @@ -100,7 +100,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S 1. `` 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 @@ -115,7 +115,7 @@ The general steps in configuring profiler auto instrumentation are as follows; S 1. `` 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. @@ -207,7 +207,7 @@ Set-ItemProperty HKLM:SYSTEM\CurrentControlSet\Services\ -Name Env 1. `` 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. `` is the name of the Windows service. @@ -248,7 +248,7 @@ $environment.Keys | ForEach-Object { 2. `` 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 @@ -273,7 +273,7 @@ $environment.Keys | ForEach-Object { 1. `` is the name of the Application Pool your application uses. For example, `IIS APPPOOL\DefaultAppPool`. 2. `` 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} @@ -306,7 +306,7 @@ ELASTIC_APM_SECRET_TOKEN= <3> 1. `` 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 diff --git a/docs/reference/setup-azure-functions.md b/docs/reference/setup-azure-functions.md index 44b02f240..5fa8aa579 100644 --- a/docs/reference/setup-azure-functions.md +++ b/docs/reference/setup-azure-functions.md @@ -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. diff --git a/docs/reference/upgrading.md b/docs/reference/upgrading.md index 1a4eb4eb6..f0592c389 100644 --- a/docs/reference/upgrading.md +++ b/docs/reference/upgrading.md @@ -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]