Skip to content

Commit f8c9090

Browse files
update apm links (#4044)
1 parent 66bca99 commit f8c9090

11 files changed

+20
-20
lines changed

docs/reference/aws-lambda.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To get started with APM for your Java AWS Lambda functions, follow the steps bel
2222

2323
### Prerequisites [aws-lambda-java-prerequisites]
2424

25-
1. 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. For the best-possible performance, we recommend setting up APM on {{ecloud}} in the same AWS region as your AWS Lambda functions.
25+
1. 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. For the best-possible performance, we recommend setting up APM on {{ecloud}} in the same AWS region as your AWS Lambda functions.
2626
2. Make sure you are using one of the supported AWS Lambda Java runtimes:
2727

2828
| Tags | Java Runtime | Operating System | Supported |
@@ -143,7 +143,7 @@ COPY --from=java-agent /usr/agent/ /opt/
143143

144144
The {{apm-lambda-ext}} and the APM Java agent are configured through environment variables on the AWS Lambda function.
145145

146-
For the minimal configuration, you will need the *APM Server URL* to set the destination for APM data and an [APM Secret Token](docs-content://solutions/observability/apps/secret-token.md). If you prefer to use an [APM API key](docs-content://solutions/observability/apps/api-keys.md) instead of the APM secret token, use the `ELASTIC_APM_API_KEY` environment variable instead of `ELASTIC_APM_SECRET_TOKEN` in the following configuration.
146+
For the minimal configuration, you will need the *APM Server URL* to set the destination for APM data and an [APM Secret Token](docs-content://solutions/observability/apm/secret-token.md). If you prefer to use an [APM API key](docs-content://solutions/observability/apm/api-keys.md) instead of the APM secret token, use the `ELASTIC_APM_API_KEY` environment variable instead of `ELASTIC_APM_SECRET_TOKEN` in the following configuration.
147147

148148
For production environments, we recommend [using the AWS Secrets Manager to store your APM authentication key](apm-aws-lambda://reference/aws-lambda-secrets-manager.md) instead of providing the secret value as plaintext in the environment variables.
149149

docs/reference/config-core.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Allows for the reported hostname to be manually specified. If unset the hostname
190190

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

193-
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 APM app for more information.
193+
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 APM app for more information.
194194

195195
::::{note}
196196
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.
@@ -252,7 +252,7 @@ The following transaction, span, and error fields will be truncated at this numb
252252
* `transaction.context.message.body`, `error.context.message.body`
253253
* `span.context.db.statement`
254254

255-
Note that tracing data is limited at the upstream APM server to [`max_event_size`](docs-content://solutions/observability/apps/general-configuration-options.md#apm-max_event_size), which defaults to 300kB. If you configure `long_field_max_length` too large, it could result in transactions, spans, or errors that are rejected by APM server.
255+
Note that tracing data is limited at the upstream APM server to [`max_event_size`](docs-content://solutions/observability/apm/general-configuration-options.md#apm-max_event_size), which defaults to 300kB. If you configure `long_field_max_length` too large, it could result in transactions, spans, or errors that are rejected by APM server.
256256

257257
| Default | Type | Dynamic |
258258
| --- | --- | --- |
@@ -687,7 +687,7 @@ Use the `apm-agent-plugin-sdk` and the `apm-agent-api` artifacts to create a jar
687687

688688
## `use_elastic_traceparent_header` ([1.14.0]) [config-use-elastic-traceparent-header]
689689

690-
To enable [distributed tracing](docs-content://solutions/observability/apps/traces.md), the agent adds trace context headers to outgoing requests (like HTTP requests, Kafka records, gRPC requests etc.). These headers (`traceparent` and `tracestate`) are defined in the [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification.
690+
To enable [distributed tracing](docs-content://solutions/observability/apm/traces.md), the agent adds trace context headers to outgoing requests (like HTTP requests, Kafka records, gRPC requests etc.). These headers (`traceparent` and `tracestate`) are defined in the [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification.
691691

692692
When this setting is `true`, the agent will also add the header `elastic-apm-traceparent` for backwards compatibility with older versions of Elastic APM agents.
693693

@@ -707,7 +707,7 @@ When this setting is `true`, the agent will also add the header `elastic-apm-tra
707707
Use this option to disable `tracecontext` headers injection to any outgoing communication.
708708

709709
::::{note}
710-
Disabling `tracecontext` headers injection means that [distributed tracing](docs-content://solutions/observability/apps/traces.md) will not work on downstream services.
710+
Disabling `tracecontext` headers injection means that [distributed tracing](docs-content://solutions/observability/apm/traces.md) will not work on downstream services.
711711
::::
712712

713713

docs/reference/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ mapped_pages:
77

88
To adapt the Elastic APM Java agent to your needs, you can configure it using one of the methods below, listed in descending order of precedence:
99

10-
1) [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md)
10+
1) [Central configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md)
1111
: Configure the Agent in the Kibana APM app. [![dynamic config](/reference/images/dynamic-config.svg "") ](#configuration-dynamic)
1212

1313
2) Properties file
@@ -33,7 +33,7 @@ To adapt the Elastic APM Java agent to your needs, you can configure it using on
3333

3434
Configuration options marked with Dynamic true can be changed at runtime when set from supported sources:
3535

36-
* [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md)
36+
* [Central configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md)
3737
* `elasticapm.properties` file
3838
* Java system properties, but only when set from within the application
3939

docs/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ More detailed information on how the Agent works can be found in the [FAQ](/refe
2525

2626
## Additional components [additional-components]
2727

28-
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).
28+
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).
2929

docs/reference/logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The [`ecs-logging-java`](ecs-logging-java://reference/index.md) library can also
1919

2020
## Log correlation [log-correlation-ids]
2121

22-
[Log correlation](docs-content://solutions/observability/apps/logs.md) allows you to navigate to all logs belonging to a particular trace and vice-versa: for a specific log, see in which context it has been logged and which parameters the user provided.
22+
[Log correlation](docs-content://solutions/observability/apm/logs.md) allows you to navigate to all logs belonging to a particular trace and vice-versa: for a specific log, see in which context it has been logged and which parameters the user provided.
2323

2424
::::{note}
2525
Starting in APM agent version 1.30.0, log correlation is enabled by default. In previous versions, log correlation must be explicitly enabled by setting the `enable_log_correlation` configuration variable to `true`.
@@ -66,7 +66,7 @@ As a result, when an exception is reported to the logger:
6666

6767
Please note we capture the exception, not the message passed to the `logger.error`.
6868

69-
To collect the message passed to the `logger.error`, you would need to ingest the logs of the application (see [Log correlation](docs-content://solutions/observability/apps/logs.md)).
69+
To collect the message passed to the `logger.error`, you would need to ingest the logs of the application (see [Log correlation](docs-content://solutions/observability/apm/logs.md)).
7070

7171

7272
## Log sending (experimental) [log-sending]

docs/reference/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ JMX metrics to capture need to be configured through the [`capture_jmx_metrics`]
279279

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

282-
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.
282+
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.
283283

284284
**`span.self_time`**
285285
: type: simple timer

docs/reference/opentelemetry-bridge.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ mapped_pages:
88
The Elastic APM OpenTelemetry bridge allows creating Elastic APM `Transactions` and `Spans` using the OpenTelemetry API. OpenTelemetry metrics are also collected. In other words, it translates the calls to the OpenTelemetry API to Elastic APM and thus allows for reusing existing instrumentation.
99

1010
::::{note}
11-
While manual instrumentations using the OpenTelemetry API can be adapted to the Elastic APM Java agent, it’s not possible to use the instrumentations from [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) in the context of the Elastic APM Java agent.<br> However, you can use [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) (aka the OpenTelemetry Java agent) and send the data to APM Server. See the [OpenTelemetry integration docs](docs-content://solutions/observability/apps/use-opentelemetry-with-apm.md) for more details.
11+
While manual instrumentations using the OpenTelemetry API can be adapted to the Elastic APM Java agent, it’s not possible to use the instrumentations from [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) in the context of the Elastic APM Java agent.<br> However, you can use [opentelemetry-java-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation) (aka the OpenTelemetry Java agent) and send the data to APM Server. See the [OpenTelemetry integration docs](docs-content://solutions/observability/apm/use-opentelemetry-with-apm.md) for more details.
1212
::::
1313

1414

15-
The first span of a service will be converted to an Elastic APM [`Transaction`](docs-content://solutions/observability/apps/transactions.md), subsequent spans are mapped to Elastic APM [`Span`](docs-content://solutions/observability/apps/spans.md).
15+
The first span of a service will be converted to an Elastic APM [`Transaction`](docs-content://solutions/observability/apm/transactions.md), subsequent spans are mapped to Elastic APM [`Span`](docs-content://solutions/observability/apm/spans.md).
1616

1717

1818
## Getting started [otel-getting-started]

docs/reference/opentracing-bridge.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ OpenTracing is discontinued in favor of OpenTelemetry. Consider using the [OpenT
1212

1313
The Elastic APM OpenTracing bridge allows creating Elastic APM `Transactions` and `Spans`, using the OpenTracing API. In other words, it translates the calls to the OpenTracing API to Elastic APM and thus allows for reusing existing instrumentation.
1414

15-
The first span of a service will be converted to an Elastic APM [`Transaction`](docs-content://solutions/observability/apps/transactions.md), subsequent spans are mapped to Elastic APM [`Span`](docs-content://solutions/observability/apps/spans.md).
15+
The first span of a service will be converted to an Elastic APM [`Transaction`](docs-content://solutions/observability/apm/transactions.md), subsequent spans are mapped to Elastic APM [`Span`](docs-content://solutions/observability/apm/spans.md).
1616

1717

1818
## Getting started [opentracing-getting-started]
@@ -81,7 +81,7 @@ The `Span.setBaggageItem(String, String)` method is not supported. Baggage items
8181

8282
### Logs [opentracing-logs]
8383

84-
Only exception logging is supported. Logging an Exception on the OpenTracing span will create an Elastic APM [`Error`](docs-content://solutions/observability/apps/errors.md). Example:
84+
Only exception logging is supported. Logging an Exception on the OpenTracing span will create an Elastic APM [`Error`](docs-content://solutions/observability/apm/errors.md). Example:
8585

8686
```java
8787
Exception e = ...

docs/reference/set-up-apm-java-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Once you’ve set up the Agent, see the [configuration guide](/reference/configu
1919

2020
## SSL/TLS communication with APM Server [ssl-setup]
2121

22-
If [SSL/TLS communication](docs-content://solutions/observability/apps/apm-agent-tls-communication.md) is enabled on the APM Server, make sure to check out the [SSL setup guide](/reference/ssl-configuration.md).
22+
If [SSL/TLS communication](docs-content://solutions/observability/apm/apm-agent-tls-communication.md) is enabled on the APM Server, make sure to check out the [SSL setup guide](/reference/ssl-configuration.md).
2323

2424

2525
## Monitoring AWS Lambda Functions (Experimental) [aws-lambda-setup]

docs/reference/ssl-configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# SSL/TLS communication with APM Server [ssl-configuration]
77

8-
If [SSL/TLS communication](docs-content://solutions/observability/apps/apm-agent-tls-communication.md) is enabled on the APM Server, use the `https` protocol when configuring [`server_url`](/reference/config-reporter.md#config-server-url).
8+
If [SSL/TLS communication](docs-content://solutions/observability/apm/apm-agent-tls-communication.md) is enabled on the APM Server, use the `https` protocol when configuring [`server_url`](/reference/config-reporter.md#config-server-url).
99

1010

1111
## APM Server certificate authentication [ssl-server-authentication]
@@ -17,7 +17,7 @@ If the certificate used by the APM Server is self-signed, you would need to add
1717

1818
## Agent certificate authentication [ssl-client-authentication]
1919

20-
If [SSL client authentication](docs-content://solutions/observability/apps/apm-agent-tls-communication.md#apm-agent-client-cert) is enabled on the APM server, the agent will be required to send a proper certificate as part of the HTTPS handshake. There is currently no configuration on the Java agent that supports that and no one straightforward option to do that that is suitable for all cases. Generally speaking, the agent will send a certificate from the JVM keystore. So, if your JVM does not use a keystore already, add the certificate file and the corresponding private key into a keystore and configure your JVM to use it:
20+
If [SSL client authentication](docs-content://solutions/observability/apm/apm-agent-tls-communication.md#apm-agent-client-cert) is enabled on the APM server, the agent will be required to send a proper certificate as part of the HTTPS handshake. There is currently no configuration on the Java agent that supports that and no one straightforward option to do that that is suitable for all cases. Generally speaking, the agent will send a certificate from the JVM keystore. So, if your JVM does not use a keystore already, add the certificate file and the corresponding private key into a keystore and configure your JVM to use it:
2121

2222
```
2323
-Djavax.net.ssl.keyStore=keystore.p12

docs/reference/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Upgrades between minor versions of the agent, like from 1.1 to 1.2 are always ba
1010
Before upgrading the agent, be sure to review the:
1111

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

1515

1616
## Recommended upgrade steps [upgrade-steps]

0 commit comments

Comments
 (0)