Skip to content

Commit d3154e2

Browse files
docs: update apm guide links to observability guide links (#1528) (#1529)
1 parent 2a90572 commit d3154e2

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

docs/agent-api.asciidoc

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

33
=== `Agent` API
44

5-
You can access agent API after initializing the agent:
5+
You can access agent API after initializing the agent:
66

77
[source,js]
88
----
@@ -45,7 +45,7 @@ The given `context` argument must be an object and can contain the following pro
4545

4646
The provided user context is stored under `context.user` in Elasticsearch on both errors and transactions.
4747

48-
It’s possible to call this function multiple times within the scope of the same active transaction.
48+
It’s possible to call this function multiple times within the scope of the same active transaction.
4949
For each call, the properties of the context argument are shallow merged with the context previously given.
5050

5151

@@ -62,13 +62,13 @@ Call this to enrich collected errors and transactions with any information that
6262

6363
The provided custom context is stored under `context.custom` in Elasticsearch on both errors and transactions.
6464

65-
It’s possible to call this function multiple times within the scope of the same active transaction.
65+
It’s possible to call this function multiple times within the scope of the same active transaction.
6666
For each call, the properties of the context argument are shallow merged with the context previously given.
6767

6868
The given `context` argument must be an object and can contain any property that can be JSON encoded.
6969

7070
TIP: Before using custom context, ensure you understand the different types of
71-
{apm-guide-ref}/metadata.html[metadata] that are available.
71+
{observability-guide}/apm-api-metadata.html[metadata] that are available.
7272

7373

7474
[float]
@@ -80,13 +80,13 @@ TIP: Before using custom context, ensure you understand the different types of
8080
apm.addLabels({ [name]: value })
8181
----
8282

83-
Set labels on transactions and errors.
83+
Set labels on transactions and errors.
8484
Starting with APM Server 7.6+, the labels are added to spans as well.
8585

8686
Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable (as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>). You can set multiple labels.
8787

8888
TIP: Before using custom labels, ensure you understand the different types of
89-
{apm-guide-ref}/metadata.html[metadata] that are available.
89+
{observability-guide}/apm-api-metadata.html[metadata] that are available.
9090

9191
Arguments:
9292

@@ -153,12 +153,12 @@ Arguments:
153153

154154
* `type` - The type of the transaction (string). Defaults to `custom`
155155

156-
* `options` - Options to modify the created transaction (object).
156+
* `options` - Options to modify the created transaction (object).
157157
This argument is optional. The following options are supported:
158158

159159
** `managed` - Controls whether the transaction is managed by the agent or not. Defaults to `false`.
160160

161-
Use this method to create a custom transaction.
161+
Use this method to create a custom transaction.
162162

163163
By default, custom transactions are not managed by the agent, however, you can start a managed transaction
164164
by passing `{ managed: true }` as the `options` argument.
@@ -276,11 +276,11 @@ Arguments:
276276
* `callback` - A callback function to execute once the event is fired.
277277

278278

279-
Use this method to listen for RUM agent internal events.
279+
Use this method to listen for RUM agent internal events.
280280

281281
The following events are supported for the transaction lifecycle:
282282

283-
* `transaction:start` event is fired on every transaction start.
283+
* `transaction:start` event is fired on every transaction start.
284284
* `transaction:end` event is fired on transaction end and before it is added to the queue to be sent to APM Server.
285285

286286
The callback function for these events receives the corresponding transaction object

docs/intro.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ captures the following information:
3131
[[additional-components]]
3232
=== Additional Components
3333

34-
APM Agents work in conjunction with the {apm-guide-ref}/index.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
35-
The {apm-guide-ref}/index.html[APM Guide] provides details on how these components work together,
36-
and provides a matrix outlining {apm-guide-ref}/agent-server-compatibility.html[Agent and Server compatibility].
34+
APM Agents work in conjunction with the {observability-guide}/apm.html[APM Server], {ref}/index.html[Elasticsearch], and {kibana-ref}/index.html[Kibana].
35+
The {observability-guide}/apm.html[APM Guide] provides details on how these components work together,
36+
and provides a matrix outlining {observability-guide}/apm-agent-server-compatibility.html[Agent and Server compatibility].
3737

3838
include::./set-up.asciidoc[]

docs/set-up.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
== Set up the Agent
33

44
To start reporting your web page performance to Elastic APM,
5-
you must first {apm-guide-ref}/configuration-rum.html[enable the RUM endpoint] in your `apm-server` configuration.
5+
you must first {observability-guide}/apm-configuration-rum.html[enable the RUM endpoint] in your `apm-server` configuration.
66

77
Once the APM Server endpoint has been configured, you can:
88

@@ -78,7 +78,7 @@ Install the Real User Monitoring APM agent as a dependency to your application:
7878

7979
[source,bash]
8080
----
81-
npm install @elastic/apm-rum --save
81+
npm install @elastic/apm-rum --save
8282
----
8383

8484
Configure the agent:
@@ -88,13 +88,13 @@ Configure the agent:
8888
import { init as initApm } from '@elastic/apm-rum'
8989
9090
const apm = initApm({
91-
91+
9292
// Set required service name (allowed characters: a-z, A-Z, 0-9, -, _, and space)
9393
serviceName: '',
9494
9595
// Set custom APM Server URL (default: http://localhost:8200)
9696
serverUrl: 'http://localhost:8200',
97-
97+
9898
// Set service version (required for sourcemap feature)
9999
serviceVersion: ''
100100
})
@@ -130,7 +130,7 @@ You can learn more about this in https://webpack.js.org/plugins/environment-plug
130130
[float]
131131
==== Rollup
132132

133-
For optimized rollup production build, include the replace plugin which ensures the right build environment is used.
133+
For optimized rollup production build, include the replace plugin which ensures the right build environment is used.
134134

135135
[source, js]
136136
----
@@ -152,7 +152,7 @@ If APM Server is deployed in an origin different than the page's origin,
152152
you will need to configure Cross-Origin Resource Sharing (CORS).
153153

154154
A list of permitted origins can be supplied to the
155-
{apm-guide-ref}/configuration-rum.html#rum-allow-origins[`apm-server.rum.allow_origins`]
155+
{observability-guide}/apm-configuration-rum.html#apm-rum-allow-origins[`apm-server.rum.allow_origins`]
156156
configuration option.
157157
By default, APM Server allows all origins.
158158

docs/sourcemap.asciidoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ without losing the ability to quickly and easily debug your applications.
1010

1111
There are three steps required to enable, upload, and apply a source map to error stack traces.
1212
An overview is listed below, and a complete walk-through is available in the
13-
{apm-guide-ref}/sourcemaps.html[generate and upload a source map] guide.
13+
{observability-guide}/apm-source-map-how-to.html[generate and upload a source map] guide.
1414

1515
1. Set the <<service-version,`serviceVersion`>> when initializing the RUM Agent.
16-
2. {apm-guide-ref}/sourcemaps.html#sourcemap-rum-generate[Generate a source map]
16+
2. {observability-guide}/apm-source-map-how-to.html#apm-source-map-rum-generate[Generate a source map]
1717
for your application with the `serviceVersion` from step one.
18-
3. {apm-guide-ref}/sourcemaps.html#sourcemap-rum-upload[Enable and upload the source map file] to APM Server.
18+
3. {observability-guide}/apm-source-map-how-to.html#apm-source-map-rum-upload[Enable and upload the source map file] to APM Server.
1919

2020
// Don't link to this section
2121
[[secret-token]]
22-
You can also configure a {apm-guide-ref}/secret-token.html[secret token] or
23-
{apm-guide-ref}/api-key.html[API key] to restrict the uploading of sourcemaps.
22+
You can also configure a {observability-guide}/apm-secret-token.html[secret token] or
23+
{observability-guide}/apm-api-key.html[API key] to restrict the uploading of sourcemaps.
2424

2525
TIP: Don't forget,
26-
you must enable {apm-guide-ref}/configuration-rum.html[RUM support] in the APM Server for this endpoint to work.
26+
you must enable {observability-guide}/apm-configuration-rum.html[RUM support] in the APM Server for this endpoint to work.

docs/transaction-api.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ it will also get tagged with the same labels.
126126
Labels are key/value pairs that are indexed by Elasticsearch and therefore searchable (as opposed to data set via <<apm-set-custom-context,`apm.setCustomContext()`>>).
127127

128128
TIP: Before using custom labels, ensure you understand the different types of
129-
{apm-guide-ref}/metadata.html[metadata] that are available.
129+
{observability-guide}/apm-api-metadata.html[metadata] that are available.
130130

131131
Arguments:
132132

docs/upgrading.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Upgrades that involve a major version bump often come with some backwards incomp
66
Before upgrading the agent, be sure to review the:
77

88
* <<release-notes,Agent release notes>>
9-
* {apm-guide-ref}/agent-server-compatibility.html[Agent and Server compatibility chart]
9+
* {observability-guide}/apm-agent-server-compatibility.html[Agent and Server compatibility chart]
1010

1111
The following upgrade guides are also available:
1212

0 commit comments

Comments
 (0)