Skip to content

Commit ec73797

Browse files
szabostevethekofimensah
authored andcommitted
Updates links pointing to apm-agent-rum-js (#746)
## Description Related to #673 This PR updates the links that point to the `apm-agent-rum-js` repo from `asciidocalypse://docs/apm-agent-rum-js/docs/reference/` to `apm-agent-rum-js://reference/`.
1 parent d4cd15d commit ec73797

11 files changed

+18
-17
lines changed

docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ cross_links:
1111
- apm-agent-dotnet
1212
- apm-agent-go
1313
- apm-agent-ios
14+
- apm-agent-rum-js
1415
- apm-aws-lambda
1516
- apm-k8s-attacher
1617
- asciidocalypse

solutions/observability/apps/apm-agent-central-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Ruby agent
5959
: [Configuration reference](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md)
6060

6161
Real User Monitoring (RUM) agent
62-
: [Configuration reference](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md)
62+
: [Configuration reference](apm-agent-rum-js://reference/configuration.md)
6363

6464

6565
## APM Server configuration [_apm_server_configuration]

solutions/observability/apps/apm-server-binary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -749,8 +749,8 @@ const apm = initApm({
749749
750750
**Learn more in the agent reference**
751751
752-
* [Supported technologies](asciidocalypse://docs/apm-agent-rum-js/docs/reference/supported-technologies.md)
753-
* [Advanced configuration](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md)
752+
* [Supported technologies](apm-agent-rum-js://reference/supported-technologies.md)
753+
* [Advanced configuration](apm-agent-rum-js://reference/configuration.md)
754754
::::::
755755
756756
::::::{tab-item} OpenTelemetry

solutions/observability/apps/built-in-data-filters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ This setting only prevents APM Server from capturing already ingested personal d
7171

7272
## Real user monitoring data [apm-filters-real-user-data]
7373

74-
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.
74+
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.
7575

7676
| Disable | Configuration value |
7777
| --- | --- |

solutions/observability/apps/configure-real-user-monitoring-rum.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Most options in this section are supported by all APM Server deployment methods.
1919
::::
2020

2121

22-
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.
22+
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.
2323

2424
:::::::{tab-set}
2525

@@ -55,7 +55,7 @@ Configure and customize Fleet-managed APM settings directly in {{kib}}:
5555
::::::
5656

5757
:::::::
58-
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.
58+
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.
5959

6060

6161
## Configuration reference [apm-enable-rum-support]

solutions/observability/apps/filter-application-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ Service environments are defined when configuring your APM agents. It’s vital
4242
* **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment)
4343
* **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/ingestion-tools/apm-agent-python/configuration.md#config-environment)
4444
* **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/ingestion-tools/apm-agent-ruby/configuration.md#config-environment)
45-
* **Real User Monitoring (Elastic Stack only):** [`environment`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/ingestion-tools/apm-agent-rum-js/configuration.md#environment)
45+
* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/configuration.md#environment)

solutions/observability/apps/fleet-managed-apm-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -794,8 +794,8 @@ const apm = initApm({
794794
795795
**Learn more in the agent reference**
796796
797-
* [Supported technologies](asciidocalypse://docs/apm-agent-rum-js/docs/reference/supported-technologies.md)
798-
* [Advanced configuration](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md)
797+
* [Supported technologies](apm-agent-rum-js://reference/supported-technologies.md)
798+
* [Advanced configuration](apm-agent-rum-js://reference/configuration.md)
799799
::::::
800800
801801
::::::{tab-item} OpenTelemetry

solutions/observability/apps/metadata.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Avoid defining too many user-specified labels. Defining too many unique fields i
3434
* 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)
3535
* Python: [`elasticapm.label()`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-label)
3636
* Ruby: [`set_label`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-label)
37-
* Rum: [`addLabels`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-add-labels)
37+
* Rum: [`addLabels`](apm-agent-rum-js://reference/agent-api.md#apm-add-labels)
3838

3939

4040
## Custom context [apm-data-model-custom]
@@ -64,7 +64,7 @@ Setting a circular object, a large object, or a non JSON serializable object can
6464
* PHP: *coming soon*
6565
* Python: [`set_custom_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-custom-context)
6666
* Ruby: [`set_custom_context`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-custom-context)
67-
* Rum: [`setCustomContext`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-set-custom-context)
67+
* Rum: [`setCustomContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-custom-context)
6868

6969

7070
## User context [apm-data-model-user]
@@ -87,5 +87,5 @@ User context adds **indexed** user information to transactions and errors. Index
8787
* PHP: *coming soon*
8888
* Python: [`set_user_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-user-context)
8989
* Ruby: [`set_user`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-user)
90-
* Rum: [`setUserContext`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/agent-api.md#apm-set-user-context)
90+
* Rum: [`setUserContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-user-context)
9191

solutions/observability/apps/traces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,4 +429,4 @@ end
429429

430430
Some additional setup may be required to correlate requests correctly with the Real User Monitoring (RUM) agent.
431431

432-
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.
432+
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.

troubleshoot/observability/apm-agent-rum-js/apm-real-user-monitoring-javascript-agent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ The effect of this will remain until the tab or browser is closed.
8080

8181
In the unlikely event the agent causes disruptions to a production application, you can disable the agent while you troubleshoot.
8282

83-
To disable the agent, set [`active`](asciidocalypse://docs/apm-agent-rum-js/docs/reference/configuration.md#active) to `false`.
83+
To disable the agent, set [`active`](apm-agent-rum-js://reference/configuration.md#active) to `false`.
8484

8585

8686
## Get in touch [get-in-touch]

troubleshoot/observability/apm/common-problems.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,9 @@ You will see this warning if your results have more than `1000` unique transacti
223223

224224
**More information**
225225

226-
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).
226+
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).
227227

228-
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.
228+
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.
229229

230230
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.
231231

@@ -266,7 +266,7 @@ As an example, some APM agents store cookie values in `http.request.cookies`. Si
266266
stack: all
267267
```
268268

269-
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).
269+
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).
270270

271271
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.
272272

0 commit comments

Comments
 (0)