You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/agent-api.asciidoc
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
=== `Agent` API
4
4
5
-
You can access agent API after initializing the agent:
5
+
You can access agent API after initializing the agent:
6
6
7
7
[source,js]
8
8
----
@@ -45,7 +45,7 @@ The given `context` argument must be an object and can contain the following pro
45
45
46
46
The provided user context is stored under `context.user` in Elasticsearch on both errors and transactions.
47
47
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.
49
49
For each call, the properties of the context argument are shallow merged with the context previously given.
50
50
51
51
@@ -62,13 +62,13 @@ Call this to enrich collected errors and transactions with any information that
62
62
63
63
The provided custom context is stored under `context.custom` in Elasticsearch on both errors and transactions.
64
64
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.
66
66
For each call, the properties of the context argument are shallow merged with the context previously given.
67
67
68
68
The given `context` argument must be an object and can contain any property that can be JSON encoded.
69
69
70
70
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.
72
72
73
73
74
74
[float]
@@ -80,13 +80,13 @@ TIP: Before using custom context, ensure you understand the different types of
80
80
apm.addLabels({ [name]: value })
81
81
----
82
82
83
-
Set labels on transactions and errors.
83
+
Set labels on transactions and errors.
84
84
Starting with APM Server 7.6+, the labels are added to spans as well.
85
85
86
86
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.
87
87
88
88
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.
90
90
91
91
Arguments:
92
92
@@ -153,12 +153,12 @@ Arguments:
153
153
154
154
* `type` - The type of the transaction (string). Defaults to `custom`
155
155
156
-
* `options` - Options to modify the created transaction (object).
156
+
* `options` - Options to modify the created transaction (object).
157
157
This argument is optional. The following options are supported:
158
158
159
159
** `managed` - Controls whether the transaction is managed by the agent or not. Defaults to `false`.
160
160
161
-
Use this method to create a custom transaction.
161
+
Use this method to create a custom transaction.
162
162
163
163
By default, custom transactions are not managed by the agent, however, you can start a managed transaction
164
164
by passing `{ managed: true }` as the `options` argument.
@@ -276,11 +276,11 @@ Arguments:
276
276
* `callback` - A callback function to execute once the event is fired.
277
277
278
278
279
-
Use this method to listen for RUM agent internal events.
279
+
Use this method to listen for RUM agent internal events.
280
280
281
281
The following events are supported for the transaction lifecycle:
282
282
283
-
* `transaction:start` event is fired on every transaction start.
283
+
* `transaction:start` event is fired on every transaction start.
284
284
* `transaction:end` event is fired on transaction end and before it is added to the queue to be sent to APM Server.
285
285
286
286
The callback function for these events receives the corresponding transaction object
Copy file name to clipboardExpand all lines: docs/intro.asciidoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,8 +31,8 @@ captures the following information:
31
31
[[additional-components]]
32
32
=== Additional Components
33
33
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].
Copy file name to clipboardExpand all lines: docs/transaction-api.asciidoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -126,7 +126,7 @@ it will also get tagged with the same labels.
126
126
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()`>>).
127
127
128
128
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.
0 commit comments