From 12c1a86d6e7c726a5e5d61f6b9e4db727ae1c280 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 12 Mar 2025 15:14:08 +0100 Subject: [PATCH 1/3] Updates links pointing to apm-agent-rum-js. --- .../observability/apps/apm-agent-central-configuration.md | 2 +- solutions/observability/apps/apm-server-binary.md | 4 ++-- solutions/observability/apps/built-in-data-filters.md | 2 +- .../apps/configure-real-user-monitoring-rum.md | 4 ++-- solutions/observability/apps/filter-application-data.md | 2 +- solutions/observability/apps/fleet-managed-apm-server.md | 4 ++-- solutions/observability/apps/metadata.md | 6 +++--- solutions/observability/apps/traces.md | 2 +- .../apm-real-user-monitoring-javascript-agent.md | 2 +- troubleshoot/observability/apm/common-problems.md | 6 +++--- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/solutions/observability/apps/apm-agent-central-configuration.md b/solutions/observability/apps/apm-agent-central-configuration.md index df3b37fe4a..ffdaae2e53 100644 --- a/solutions/observability/apps/apm-agent-central-configuration.md +++ b/solutions/observability/apps/apm-agent-central-configuration.md @@ -59,7 +59,7 @@ Ruby agent : [Configuration reference](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md) Real User Monitoring (RUM) agent -: [Configuration reference](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md) +: [Configuration reference](apm-agent-rum-js://reference/configuration.md) ## APM Server configuration [_apm_server_configuration] diff --git a/solutions/observability/apps/apm-server-binary.md b/solutions/observability/apps/apm-server-binary.md index daf19e4ec3..a85b4b2c4b 100644 --- a/solutions/observability/apps/apm-server-binary.md +++ b/solutions/observability/apps/apm-server-binary.md @@ -749,8 +749,8 @@ const apm = initApm({ **Learn more in the agent reference** -* [Supported technologies](asciidocalypse://docs/apm-agent-rum-js/docs/reference/supported-technologies.md) -* [Advanced configuration](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md) +* [Supported technologies](apm-agent-rum-js://reference/supported-technologies.md) +* [Advanced configuration](apm-agent-rum-js://reference/configuration.md) :::::: ::::::{tab-item} OpenTelemetry diff --git a/solutions/observability/apps/built-in-data-filters.md b/solutions/observability/apps/built-in-data-filters.md index cc83446eb7..474dff704c 100644 --- a/solutions/observability/apps/built-in-data-filters.md +++ b/solutions/observability/apps/built-in-data-filters.md @@ -71,7 +71,7 @@ This setting only prevents APM Server from capturing already ingested personal d ## Real user monitoring data [apm-filters-real-user-data] -Protecting user data is important. For that reason, individual RUM instrumentations can be disabled in the RUM agent with the [`disableInstrumentations`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md#disable-instrumentations) configuration variable. Disabled instrumentations produce no spans or transactions. +Protecting user data is important. For that reason, individual RUM instrumentations can be disabled in the RUM agent with the [`disableInstrumentations`](apm-agent-rum-js://reference/configuration.md#disable-instrumentations) configuration variable. Disabled instrumentations produce no spans or transactions. | Disable | Configuration value | | --- | --- | diff --git a/solutions/observability/apps/configure-real-user-monitoring-rum.md b/solutions/observability/apps/configure-real-user-monitoring-rum.md index 2e1cacf2fe..7932500ab8 100644 --- a/solutions/observability/apps/configure-real-user-monitoring-rum.md +++ b/solutions/observability/apps/configure-real-user-monitoring-rum.md @@ -19,7 +19,7 @@ Most options in this section are supported by all APM Server deployment methods. :::: -The [Real User Monitoring (RUM) agent](asciidocalypse://docs/apm-agent-rum-js/docs/reference/index.md) captures user interactions with clients such as web browsers. These interactions are sent as events to the APM Server. Because the RUM agent runs on the client side, the connection between agent and server is unauthenticated. As a security precaution, RUM is therefore disabled by default. +The [Real User Monitoring (RUM) agent](apm-agent-rum-js://reference/index.md) captures user interactions with clients such as web browsers. These interactions are sent as events to the APM Server. Because the RUM agent runs on the client side, the connection between agent and server is unauthenticated. As a security precaution, RUM is therefore disabled by default. :::::::{tab-set} @@ -55,7 +55,7 @@ Configure and customize Fleet-managed APM settings directly in {{kib}}: :::::: ::::::: -In addition, if APM Server is deployed in an origin different than the page’s origin, you will need to configure [Cross-Origin Resource Sharing (CORS)](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuring-cors.md) in the Agent. +In addition, if APM Server is deployed in an origin different than the page’s origin, you will need to configure [Cross-Origin Resource Sharing (CORS)](apm-agent-rum-js://reference/configuring-cors.md) in the Agent. ## Configuration reference [apm-enable-rum-support] diff --git a/solutions/observability/apps/filter-application-data.md b/solutions/observability/apps/filter-application-data.md index dc9b737331..9ee6ee2e1a 100644 --- a/solutions/observability/apps/filter-application-data.md +++ b/solutions/observability/apps/filter-application-data.md @@ -42,4 +42,4 @@ Service environments are defined when configuring your APM agents. It’s vital * **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment) * **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/ingestion-tools/apm-agent-python/configuration.md#config-environment) * **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/ingestion-tools/apm-agent-ruby/configuration.md#config-environment) -* **Real User Monitoring (Elastic Stack only):** [`environment`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/ingestion-tools/apm-agent-rum-js/configuration.md#environment) \ No newline at end of file +* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/ingestion-tools/apm-agent-rum-js/configuration.md#environment) \ No newline at end of file diff --git a/solutions/observability/apps/fleet-managed-apm-server.md b/solutions/observability/apps/fleet-managed-apm-server.md index 116f54cfa5..e76a4be7ad 100644 --- a/solutions/observability/apps/fleet-managed-apm-server.md +++ b/solutions/observability/apps/fleet-managed-apm-server.md @@ -794,8 +794,8 @@ const apm = initApm({ **Learn more in the agent reference** -* [Supported technologies](asciidocalypse://docs/apm-agent-rum-js/docs/reference/supported-technologies.md) -* [Advanced configuration](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md) +* [Supported technologies](apm-agent-rum-js://reference/supported-technologies.md) +* [Advanced configuration](apm-agent-rum-js://reference/configuration.md) :::::: ::::::{tab-item} OpenTelemetry diff --git a/solutions/observability/apps/metadata.md b/solutions/observability/apps/metadata.md index 5a77fe72d3..a95b0f1929 100644 --- a/solutions/observability/apps/metadata.md +++ b/solutions/observability/apps/metadata.md @@ -34,7 +34,7 @@ Avoid defining too many user-specified labels. Defining too many unique fields i * 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) * Python: [`elasticapm.label()`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-label) * Ruby: [`set_label`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-label) -* Rum: [`addLabels`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-add-labels) +* Rum: [`addLabels`](apm-agent-rum-js://reference/agent-api.md#apm-add-labels) ## Custom context [apm-data-model-custom] @@ -64,7 +64,7 @@ Setting a circular object, a large object, or a non JSON serializable object can * PHP: *coming soon* * Python: [`set_custom_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-custom-context) * Ruby: [`set_custom_context`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-custom-context) -* Rum: [`setCustomContext`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-set-custom-context) +* Rum: [`setCustomContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-custom-context) ## User context [apm-data-model-user] @@ -87,5 +87,5 @@ User context adds **indexed** user information to transactions and errors. Index * PHP: *coming soon* * Python: [`set_user_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-user-context) * Ruby: [`set_user`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-user) -* Rum: [`setUserContext`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-set-user-context) +* Rum: [`setUserContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-user-context) diff --git a/solutions/observability/apps/traces.md b/solutions/observability/apps/traces.md index fa3108a40d..ae868e8ed2 100644 --- a/solutions/observability/apps/traces.md +++ b/solutions/observability/apps/traces.md @@ -429,4 +429,4 @@ end Some additional setup may be required to correlate requests correctly with the Real User Monitoring (RUM) agent. -See the [RUM distributed tracing guide](asciidocalypse://docs/apm-agent-rum-js/docs/reference/distributed-tracing.md) for information on enabling cross-origin requests, setting up server configuration, and working with dynamically-generated HTML. \ No newline at end of file +See the [RUM distributed tracing guide](apm-agent-rum-js://reference/distributed-tracing.md) for information on enabling cross-origin requests, setting up server configuration, and working with dynamically-generated HTML. \ No newline at end of file diff --git a/troubleshoot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md b/troubleshoot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md index 4212827643..7be6c7e082 100644 --- a/troubleshoot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md +++ b/troubleshoot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md @@ -80,7 +80,7 @@ The effect of this will remain until the tab or browser is closed. In the unlikely event the agent causes disruptions to a production application, you can disable the agent while you troubleshoot. -To disable the agent, set [`active`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md#active) to `false`. +To disable the agent, set [`active`](apm-agent-rum-js://reference/configuration.md#active) to `false`. ## Get in touch [get-in-touch] diff --git a/troubleshoot/observability/apm/common-problems.md b/troubleshoot/observability/apm/common-problems.md index 8f3c7e0499..6c31c63315 100644 --- a/troubleshoot/observability/apm/common-problems.md +++ b/troubleshoot/observability/apm/common-problems.md @@ -223,9 +223,9 @@ You will see this warning if your results have more than `1000` unique transacti **More information** -While this can happen with any APM agent, it typically occurs with the RUM agent. For more information on how to correctly set `transaction.name` in the RUM agent, see [custom initial page load transaction names](asciidocalypse://docs/apm-agent-rum-js/docs/reference/custom-transaction-name.md). +While this can happen with any APM agent, it typically occurs with the RUM agent. For more information on how to correctly set `transaction.name` in the RUM agent, see [custom initial page load transaction names](apm-agent-rum-js://reference/custom-transaction-name.md). -The RUM agent can also set the `transaction.name` when observing for transaction events. See [`apm.observe()`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#observe) for more information. +The RUM agent can also set the `transaction.name` when observing for transaction events. See [`apm.observe()`](apm-agent-rum-js://reference/agent-api.md#observe) for more information. If your problem is occurring in a different APM agent, the tips above still apply. See the relevant [Agent API documentation](https://www.elastic.co/guide/en/apm/agent) to adjust how you’re naming your transactions. @@ -266,7 +266,7 @@ As an example, some APM agents store cookie values in `http.request.cookies`. Si stack: all ``` -If the service map is not showing an expected connection between the client and server, it’s likely because you haven’t configured [`distributedTracingOrigins`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/distributed-tracing.md). +If the service map is not showing an expected connection between the client and server, it’s likely because you haven’t configured [`distributedTracingOrigins`](apm-agent-rum-js://reference/distributed-tracing.md). This setting is necessary, for example, for cross-origin requests. If you have a basic web application that provides data via an API on `localhost:4000`, and serves HTML from `localhost:4001`, you’d need to set `distributedTracingOrigins: ['https://localhost:4000']` to ensure the origin is monitored as a part of distributed tracing. In other words, `distributedTracingOrigins` is consulted prior to the APM agent adding the distributed tracing `traceparent` header to each request. From d11c8dd9fb2f13c54a0466eeb76c0655344428de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 12 Mar 2025 15:19:16 +0100 Subject: [PATCH 2/3] Adds apm-agent-rum-js to docset.yml. --- docset.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docset.yml b/docset.yml index 6d80ca5ac7..f50115a06e 100644 --- a/docset.yml +++ b/docset.yml @@ -11,6 +11,7 @@ cross_links: - apm-agent-dotnet - apm-agent-go - apm-agent-ios + - apm-agent-rum-js - apm-aws-lambda - apm-k8s-attacher - asciidocalypse From 6968484def46e061c5fe142b2c9866340e7137af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 12 Mar 2025 15:26:39 +0100 Subject: [PATCH 3/3] Fixes link. --- solutions/observability/apps/filter-application-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/solutions/observability/apps/filter-application-data.md b/solutions/observability/apps/filter-application-data.md index 9ee6ee2e1a..f511509b74 100644 --- a/solutions/observability/apps/filter-application-data.md +++ b/solutions/observability/apps/filter-application-data.md @@ -42,4 +42,4 @@ Service environments are defined when configuring your APM agents. It’s vital * **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment) * **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/ingestion-tools/apm-agent-python/configuration.md#config-environment) * **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/ingestion-tools/apm-agent-ruby/configuration.md#config-environment) -* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/ingestion-tools/apm-agent-rum-js/configuration.md#environment) \ No newline at end of file +* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/configuration.md#environment) \ No newline at end of file