Skip to content

Updates links pointing to apm-agent-rum-js #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 12, 2025
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
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-rum-js
- apm-aws-lambda
- apm-k8s-attacher
- asciidocalypse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apps/apm-server-binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/built-in-data-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| --- | --- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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]
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 @@ -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)
* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/configuration.md#environment)
4 changes: 2 additions & 2 deletions solutions/observability/apps/fleet-managed-apm-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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 @@ -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]
Expand Down Expand Up @@ -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]
Expand All @@ -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)

2 changes: 1 addition & 1 deletion solutions/observability/apps/traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
6 changes: 3 additions & 3 deletions troubleshoot/observability/apm/common-problems.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down