Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
1 change: 1 addition & 0 deletions docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ cross_links:
- apm-agent-dotnet
- apm-agent-go
- apm-agent-ios
- apm-agent-java
- apm-aws-lambda
- apm-k8s-attacher
- asciidocalypse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,12 +118,12 @@ To send APM data to Elastic, you must install an APM agent and configure it to s
java -javaagent:/path/to/elastic-apm-agent-<version>.jar -Delastic.apm.service_name=my-cool-service -Delastic.apm.application_packages=org.example,org.another.example -Delastic.apm.server_url=http://127.0.0.1:8200 -jar my-application.jar
```

Refer to [Manual setup with `-javaagent` flag](asciidocalypse://docs/apm-agent-java/docs/reference/setup-javaagent.md) to learn more.
Refer to [Manual setup with `-javaagent` flag](apm-agent-java://reference/setup-javaagent.md) to learn more.

**Alternate setup methods**

* **Automatic setup with `apm-agent-attach-cli.jar`** Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach** Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-api.md) for more information on this setup method.
* **Automatic setup with `apm-agent-attach-cli.jar`** Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach** Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-api.md) for more information on this setup method.

</div>
<div tabindex="0" role="tabpanel" id="apm-apm-get-started-net-panel" aria-labelledby="apm-apm-get-started-net-button" hidden="">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To set up log ECS reformatting:

Log ECS reformatting is controlled by the `log_ecs_reformatting` configuration option, and is disabled by default. Refer to the guide for your framework for information on enabling:

* [Java](asciidocalypse://docs/apm-agent-java/docs/reference/config-logging.md#config-log-ecs-reformatting)
* [Java](apm-agent-java://reference/config-logging.md#config-log-ecs-reformatting)
* [Ruby](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-log-ecs-formatting)
* [Python](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-log_ecs_reformatting)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ Log correlation works on two levels:
Learn about correlating plaintext logs in the agent-specific ingestion guides:

* [Go](apm-agent-go://reference/logs.md)
* [Java](asciidocalypse://docs/apm-agent-java/docs/reference/logs.md#log-correlation-ids)
* [Java](apm-agent-java://reference/logs.md#log-correlation-ids)
* [.NET](apm-agent-dotnet://reference/logs.md)
* [Node.js](asciidocalypse://docs/apm-agent-nodejs/docs/reference/logs.md)
* [Python](asciidocalypse://docs/apm-agent-python/docs/reference/logs.md#log-correlation-ids)
Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ You can now apply your newly created API keys in the configuration of each of yo
* **Go agent**: [`ELASTIC_APM_API_KEY`](apm-agent-go://reference/configuration.md#config-api-key)
* **.NET agent**: [`ApiKey`](apm-agent-dotnet://reference/config-reporter.md#config-api-key)
* **iOS**: [`withApiKey`](apm-agent-ios://reference/configuration.md#withapikey)
* **Java agent**: [`api_key`](asciidocalypse://docs/apm-agent-java/docs/reference/config-reporter.md#config-api-key)
* **Java agent**: [`api_key`](apm-agent-java://reference/config-reporter.md#config-api-key)
* **Node.js agent**: [`apiKey`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#api-key)
* **PHP agent**: [`api_key`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-api-key)
* **Python agent**: [`api_key`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-api-key)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ iOS agent
: [Configuration reference](apm-agent-ios://reference/configuration.md)

Java agent
: [Configuration reference](asciidocalypse://docs/apm-agent-java/docs/reference/configuration.md)
: [Configuration reference](apm-agent-java://reference/configuration.md)

.NET agent
: [Configuration reference](apm-agent-dotnet://reference/configuration.md)
Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apps/apm-agent-tls-communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ When the APM server uses a certificate that is not chained to a publicly-trusted
* **Ruby agent**: certificate pinning through [`server_ca_cert`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-ssl-ca-cert)
* **.NET agent**: [`ServerCert`](apm-agent-dotnet://reference/config-reporter.md#config-server-cert)
* **Node.js agent**: custom CA setting through [`serverCaCertFile`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#server-ca-cert-file)
* **Java agent**: adding the certificate to the JVM `trustStore`. See [APM Server authentication](asciidocalypse://docs/apm-agent-java/docs/reference/ssl-configuration.md#ssl-server-authentication) for more details.
* **Java agent**: adding the certificate to the JVM `trustStore`. See [APM Server authentication](apm-agent-java://reference/ssl-configuration.md#ssl-server-authentication) for more details.

We do not recommend disabling {{apm-agent}} verification of the server’s certificate, but it is possible:

* **Go agent**: [`ELASTIC_APM_VERIFY_SERVER_CERT`](apm-agent-go://reference/configuration.md#config-verify-server-cert)
* **.NET agent**: [`VerifyServerCert`](apm-agent-dotnet://reference/config-reporter.md#config-verify-server-cert)
* **Java agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-java/docs/reference/config-reporter.md#config-verify-server-cert)
* **Java agent**: [`verify_server_cert`](apm-agent-java://reference/config-reporter.md#config-verify-server-cert)
* **PHP agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-verify-server-cert)
* **Python agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-verify-server-cert)
* **Ruby agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-verify-server-cert)
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/apps/apm-server-binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,12 +383,12 @@ Different application servers have different ways of setting the `-javaagent` fl
java -javaagent:/path/to/elastic-apm-agent-<version>.jar -Delastic.apm.service_name=my-cool-service -Delastic.apm.application_packages=org.example,org.another.example -Delastic.apm.server_url=http://127.0.0.1:8200 -jar my-application.jar
```

Refer to [Manual setup with `-javaagent` flag](asciidocalypse://docs/apm-agent-java/docs/reference/setup-javaagent.md) to learn more.
Refer to [Manual setup with `-javaagent` flag](apm-agent-java://reference/setup-javaagent.md) to learn more.

**Alternate setup methods**

* **Automatic setup with `apm-agent-attach-cli.jar`**<br> Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach**<br> Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-api.md) for more information on this setup method.
* **Automatic setup with `apm-agent-attach-cli.jar`**<br> Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach**<br> Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-api.md) for more information on this setup method.
::::::

::::::{tab-item} .NET
Expand Down
8 changes: 4 additions & 4 deletions solutions/observability/apps/built-in-data-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The default list of sanitized fields attempts to target common field names for d
This setting supports [Central configuration](apm-agent-central-configuration.md), which means the list of sanitized fields can be updated without needing to redeploy your services:

* Go: [`ELASTIC_APM_SANITIZE_FIELD_NAMES`](apm-agent-go://reference/configuration.md#config-sanitize-field-names)
* Java: [`sanitize_field_names`](asciidocalypse://docs/apm-agent-java/docs/reference/config-core.md#config-sanitize-field-names)
* Java: [`sanitize_field_names`](apm-agent-java://reference/config-core.md#config-sanitize-field-names)
* .NET: [`sanitizeFieldNames`](apm-agent-dotnet://reference/config-core.md#config-sanitize-field-names)
* Node.js: [`sanitizeFieldNames`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#sanitize-field-names)
* Python: [`sanitize_field_names`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-sanitize-field-names)
Expand All @@ -34,7 +34,7 @@ This setting supports [Central configuration](apm-agent-central-configuration.md
Alternatively, you can completely disable the capturing of HTTP headers. This setting also supports [Central configuration](apm-agent-central-configuration.md):

* Go: [`ELASTIC_APM_CAPTURE_HEADERS`](apm-agent-go://reference/configuration.md#config-capture-headers)
* Java: [`capture_headers`](asciidocalypse://docs/apm-agent-java/docs/reference/config-core.md#config-capture-headers)
* Java: [`capture_headers`](apm-agent-java://reference/config-core.md#config-capture-headers)
* .NET: [`CaptureHeaders`](apm-agent-dotnet://reference/config-http.md#config-capture-headers)
* Node.js: [`captureHeaders`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#capture-headers)
* Python: [`capture_headers`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-capture-headers)
Expand All @@ -48,7 +48,7 @@ By default, the body of HTTP requests is not recorded. Request bodies often cont
This setting supports [Central configuration](apm-agent-central-configuration.md), which means the list of sanitized fields can be updated without needing to redeploy your services:

* Go: [`ELASTIC_APM_CAPTURE_BODY`](apm-agent-go://reference/configuration.md#config-capture-body)
* Java: [`capture_body`](asciidocalypse://docs/apm-agent-java/docs/reference/config-core.md#config-capture-body)
* Java: [`capture_body`](apm-agent-java://reference/config-core.md#config-capture-body)
* .NET: [`CaptureBody`](apm-agent-dotnet://reference/config-http.md#config-capture-body)
* Node.js: [`captureBody`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#capture-body)
* Python: [`capture_body`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-capture-body)
Expand Down Expand Up @@ -96,4 +96,4 @@ Certain agents offer additional filtering and obfuscating options:
**Agent configuration options**

* (Node.js) Remove errors raised by the server-side process: disable with [captureExceptions](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#capture-exceptions).
* (Java) Remove process arguments from transactions: disabled by default with [`include_process_args`](asciidocalypse://docs/apm-agent-java/docs/reference/config-reporter.md#config-include-process-args).
* (Java) Remove process arguments from transactions: disabled by default with [`include_process_args`](apm-agent-java://reference/config-reporter.md#config-include-process-args).
10 changes: 5 additions & 5 deletions solutions/observability/apps/elastic-apm-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ Spans are grouped in transactions—by default, one for each incoming HTTP reque

If you're ready to give Elastic APM a try, see [Get started with traces and APM](../../../solutions/observability/apps/get-started-with-apm.md).

See the [Java agent reference](asciidocalypse://docs/apm-agent-java/docs/reference/index.md) for full documentation, including:
See the [Java agent reference](apm-agent-java://reference/index.md) for full documentation, including:

* [Supported technologies](asciidocalypse://docs/apm-agent-java/docs/reference/supported-technologies.md)
* [Set up](asciidocalypse://docs/apm-agent-java/docs/reference/set-up-apm-java-agent.md)
* [Configuration reference](asciidocalypse://docs/apm-agent-java/docs/reference/configuration.md)
* [API reference](asciidocalypse://docs/apm-agent-java/docs/reference/tracing-apis.md)
* [Supported technologies](apm-agent-java://reference/supported-technologies.md)
* [Set up](apm-agent-java://reference/set-up-apm-java-agent.md)
* [Configuration reference](apm-agent-java://reference/configuration.md)
* [API reference](apm-agent-java://reference/tracing-apis.md)

::::{important}
Not all APM agent configuration options are compatible with Elastic Cloud serverless.
Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/filter-application-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Service environments are defined when configuring your APM agents. It’s vital

* **Go:** [`ELASTIC_APM_ENVIRONMENT`](apm-agent-go://reference/configuration.md#config-environment)
* **iOS agent:** *Not yet supported*
* **Java:** [`environment`](asciidocalypse://docs/apm-agent-java/docs/reference/ingestion-tools/apm-agent-java/config-core.md#config-environment)
* **Java:** [`environment`](apm-agent-java://reference/config-core.md#config-environment)
* **.NET:** [`Environment`](apm-agent-dotnet://reference/config-core.md#config-environment)
* **Node.js:** [`environment`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/ingestion-tools/apm-agent-nodejs/configuration.md#environment)
* **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment)
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/apps/fleet-managed-apm-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -428,12 +428,12 @@ Different application servers have different ways of setting the `-javaagent` fl
java -javaagent:/path/to/elastic-apm-agent-<version>.jar -Delastic.apm.service_name=my-cool-service -Delastic.apm.application_packages=org.example,org.another.example -Delastic.apm.server_url=http://127.0.0.1:8200 -jar my-application.jar
```

Refer to [Manual setup with `-javaagent` flag](asciidocalypse://docs/apm-agent-java/docs/reference/setup-javaagent.md) to learn more.
Refer to [Manual setup with `-javaagent` flag](apm-agent-java://reference/setup-javaagent.md) to learn more.

**Alternate setup methods**

* **Automatic setup with `apm-agent-attach-cli.jar`**<br> Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach**<br> Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](asciidocalypse://docs/apm-agent-java/docs/reference/setup-attach-api.md) for more information on this setup method.
* **Automatic setup with `apm-agent-attach-cli.jar`**<br> Automatically set up the agent without needing to alter the configuration of your JVM or application server. This method requires no changes to application code or JVM options, and allows attaching to a running JVM. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-cli.md) for more information on this setup method.
* **Programmatic API setup to self-attach**<br> Set up the agent with a one-line code change and an extra `apm-agent-attach` dependency. This method requires no changes to JVM options, and the agent artifact is embedded within the packaged application binary. Refer to the [Java agent documentation](apm-agent-java://reference/setup-attach-api.md) for more information on this setup method.
::::::

::::::{tab-item} .NET
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/apps/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Avoid defining too many user-specified labels. Defining too many unique fields i
### Agent API reference [_agent_api_reference]

* Go: [`SetLabel`](apm-agent-go://reference/api-documentation.md#context-set-label)
* Java: [`setLabel`](asciidocalypse://docs/apm-agent-java/docs/reference/public-api.md#api-transaction-add-tag)
* Java: [`setLabel`](apm-agent-java://reference/public-api.md#api-transaction-add-tag)
* .NET: [`SetLabel`](apm-agent-dotnet://reference/public-api.md#api-transaction-set-label)
* Node.js: [`setLabel`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-add-labels)
* PHP: [`Transaction` `setLabel`](asciidocalypse://docs/apm-agent-php/docs/reference/public-api.md#api-transaction-interface-set-label) | [`Span` `setLabel`](asciidocalypse://docs/apm-agent-php/docs/reference/public-api.md#api-span-interface-set-label)
Expand Down Expand Up @@ -58,7 +58,7 @@ Setting a circular object, a large object, or a non JSON serializable object can

* Go: [`SetCustom`](apm-agent-go://reference/api-documentation.md#context-set-custom)
* iOS: *coming soon*
* Java: [`addCustomContext`](asciidocalypse://docs/apm-agent-java/docs/reference/public-api.md#api-transaction-add-custom-context)
* Java: [`addCustomContext`](apm-agent-java://reference/public-api.md#api-transaction-add-custom-context)
* .NET: *coming soon*
* Node.js: [`setCustomContext`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-set-custom-context)
* PHP: *coming soon*
Expand All @@ -81,7 +81,7 @@ User context adds **indexed** user information to transactions and errors. Index

* Go: [`SetUsername`](apm-agent-go://reference/api-documentation.md#context-set-user-email)
* iOS: *coming soon*
* Java: [`setUser`](asciidocalypse://docs/apm-agent-java/docs/reference/public-api.md#api-transaction-set-user)
* Java: [`setUser`](apm-agent-java://reference/public-api.md#api-transaction-set-user)
* .NET *coming soon*
* Node.js: [`setUserContext`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-set-user-context)
* PHP: *coming soon*
Expand Down
Loading