Skip to content

Commit 34b137b

Browse files
committed
Add applies_to metadata
1 parent adf18bf commit 34b137b

32 files changed

Lines changed: 388 additions & 21 deletions

docs/reference/advanced-topics.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/advanced-topics.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Advanced topics [advanced-topics]

docs/reference/aiohttp-server-support.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/aiohttp-server-support.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Aiohttp Server support [aiohttp-server-support]

docs/reference/api-reference.md

Lines changed: 77 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/api.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# API reference [api]
@@ -15,7 +25,9 @@ The public Client API consists of several methods on the `Client` class. This AP
1525

1626
### Instantiation [client-api-init]
1727

18-
Added in v1.0.0.
28+
```{applies_to}
29+
apm_agent_python: ga 1.0.0
30+
```
1931

2032
To create a `Client` instance, import it and call its constructor:
2133

@@ -36,7 +48,9 @@ framework integrations like [Django](/reference/django-support.md) and [Flask](/
3648

3749
#### `elasticapm.get_client()` [api-get-client]
3850

39-
[small]#Added in v6.1.0.
51+
```{applies_to}
52+
apm_agent_python: ga 6.1.0
53+
```
4054

4155
Retrieves the `Client` singleton. This is useful for many framework integrations, where the client is instantiated automatically.
4256

@@ -51,7 +65,11 @@ client.capture_message('foo')
5165

5266
#### `Client.capture_exception()` [client-api-capture-exception]
5367

54-
Added in v1.0.0. `handled` added in v2.0.0.
68+
```{applies_to}
69+
apm_agent_python: ga 1.0.0
70+
```
71+
72+
`handled` added in v2.0.0.
5573

5674
Captures an exception object:
5775

@@ -73,7 +91,9 @@ Returns the id of the error as a string.
7391

7492
#### `Client.capture_message()` [client-api-capture-message]
7593

76-
Added in v1.0.0.
94+
```{applies_to}
95+
apm_agent_python: ga 1.0.0
96+
```
7797

7898
Captures a message with optional added contextual data. Example:
7999

@@ -110,7 +130,11 @@ Either the `message` or the `param_message` argument is required.
110130

111131
#### `Client.begin_transaction()` [client-api-begin-transaction]
112132

113-
Added in v1.0.0. `trace_parent` support added in v5.6.0.
133+
```{applies_to}
134+
apm_agent_python: ga 1.0.0
135+
```
136+
137+
`trace_parent` support added in v5.6.0.
114138

115139
Begin tracking a transaction. Should be called e.g. at the beginning of a request or when starting a background task. Example:
116140

@@ -125,7 +149,9 @@ client.begin_transaction('processors')
125149

126150
#### `Client.end_transaction()` [client-api-end-transaction]
127151

128-
Added in v1.0.0.
152+
```{applies_to}
153+
apm_agent_python: ga 1.0.0
154+
```
129155

130156
End tracking the transaction. Should be called e.g. at the end of a request or when ending a background task. Example:
131157

@@ -149,7 +175,9 @@ Transactions can be started with a `TraceParent` object. This creates a transact
149175

150176
#### `elasticapm.trace_parent_from_string()` [api-traceparent-from-string]
151177

152-
Added in v5.6.0.
178+
```{applies_to}
179+
apm_agent_python: ga 5.6.0
180+
```
153181

154182
Create a `TraceParent` object from the string representation generated by `TraceParent.to_string()`:
155183

@@ -163,7 +191,9 @@ client.begin_transaction('processors', trace_parent=parent)
163191

164192
#### `elasticapm.trace_parent_from_headers()` [api-traceparent-from-headers]
165193

166-
Added in v5.6.0.
194+
```{applies_to}
195+
apm_agent_python: ga 5.6.0
196+
```
167197

168198
Create a `TraceParent` object from HTTP headers (usually generated by another Elastic APM agent):
169199

@@ -177,7 +207,9 @@ client.begin_transaction('processors', trace_parent=parent)
177207

178208
#### `elasticapm.get_trace_parent_header()` [api-traceparent-get-header]
179209

180-
Added in v5.10.0.
210+
```{applies_to}
211+
apm_agent_python: ga 5.10.0
212+
```
181213

182214
Return the string representation of the current transaction `TraceParent` object:
183215

@@ -191,7 +223,9 @@ elasticapm.get_trace_parent_header()
191223

192224
### `elasticapm.instrument()` [api-elasticapm-instrument]
193225

194-
Added in v1.0.0.
226+
```{applies_to}
227+
apm_agent_python: ga 1.0.0
228+
```
195229

196230
Instruments libraries automatically. This includes a wide range of standard library and 3rd party modules. A list of instrumented modules can be found in `elasticapm.instrumentation.register`. This function should be called as early as possibly in the startup of your application. For [supported frameworks](/reference/supported-technologies.md#framework-support), this is called automatically. Example:
197231

@@ -204,7 +238,9 @@ elasticapm.instrument()
204238

205239
### `elasticapm.set_transaction_name()` [api-set-transaction-name]
206240

207-
Added in v1.0.0.
241+
```{applies_to}
242+
apm_agent_python: ga 1.0.0
243+
```
208244

209245
Set the name of the current transaction. For supported frameworks, the transaction name is determined automatically, and can be overridden using this function. Example:
210246

@@ -220,7 +256,9 @@ elasticapm.set_transaction_name('myapp.billing_process')
220256

221257
### `elasticapm.set_transaction_result()` [api-set-transaction-result]
222258

223-
Added in v2.2.0.
259+
```{applies_to}
260+
apm_agent_python: ga 2.2.0
261+
```
224262

225263
Set the result of the current transaction. For supported frameworks, the transaction result is determined automatically, and can be overridden using this function. Example:
226264

@@ -236,7 +274,9 @@ elasticapm.set_transaction_result('SUCCESS')
236274

237275
### `elasticapm.set_transaction_outcome()` [api-set-transaction-outcome]
238276

239-
Added in v5.9.0.
277+
```{applies_to}
278+
apm_agent_python: ga 5.9.0
279+
```
240280

241281
Sets the outcome of the transaction. The value can either be `"success"`, `"failure"` or `"unknown"`. This should only be called at the end of a transaction after the outcome is determined.
242282

@@ -277,7 +317,9 @@ elasticapm.set_transaction_outcome(OUTCOME.UNKNOWN)
277317

278318
### `elasticapm.get_transaction_id()` [api-get-transaction-id]
279319

280-
Added in v5.2.0.
320+
```{applies_to}
321+
apm_agent_python: ga 5.2.0
322+
```
281323

282324
Get the id of the current transaction. Example:
283325

@@ -290,7 +332,9 @@ transaction_id = elasticapm.get_transaction_id()
290332

291333
### `elasticapm.get_trace_id()` [api-get-trace-id]
292334

293-
Added in v5.2.0.
335+
```{applies_to}
336+
apm_agent_python: ga 5.2.0
337+
```
294338

295339
Get the `trace_id` of the current transaction’s trace. Example:
296340

@@ -303,7 +347,9 @@ trace_id = elasticapm.get_trace_id()
303347

304348
### `elasticapm.get_span_id()` [api-get-span-id]
305349

306-
Added in v5.2.0.
350+
```{applies_to}
351+
apm_agent_python: ga 5.2.0
352+
```
307353

308354
Get the id of the current span. Example:
309355

@@ -316,7 +362,9 @@ span_id = elasticapm.get_span_id()
316362

317363
### `elasticapm.set_custom_context()` [api-set-custom-context]
318364

319-
Added in v2.0.0.
365+
```{applies_to}
366+
apm_agent_python: ga 2.0.0
367+
```
320368

321369
Attach custom contextual data to the current transaction and errors. Supported frameworks will automatically attach information about the HTTP request and the logged in user. You can attach further data using this function.
322370

@@ -345,7 +393,9 @@ Errors that happen after this call will also have the custom context attached to
345393

346394
### `elasticapm.set_user_context()` [api-set-user-context]
347395

348-
Added in v2.0.0.
396+
```{applies_to}
397+
apm_agent_python: ga 2.0.0
398+
```
349399

350400
Attach information about the currently logged in user to the current transaction and errors. Example:
351401

@@ -364,7 +414,9 @@ Errors that happen after this call will also have the user context attached to t
364414

365415
### `elasticapm.capture_span` [api-capture-span]
366416

367-
Added in v4.1.0.
417+
```{applies_to}
418+
apm_agent_python: ga 4.1.0
419+
```
368420

369421
Capture a custom span. This can be used either as a function decorator or as a context manager (in a `with` statement). When used as a decorator, the name of the span will be set to the name of the function. When used as a context manager, a name has to be provided.
370422

@@ -397,7 +449,9 @@ def coffee_maker(strength):
397449

398450
### `elasticapm.async_capture_span` [api-async-capture-span]
399451

400-
Added in v5.4.0.
452+
```{applies_to}
453+
apm_agent_python: ga 5.4.0
454+
```
401455

402456
Capture a custom async-aware span. This can be used either as a function decorator or as a context manager (in an `async with` statement). When used as a decorator, the name of the span will be set to the name of the function. When used as a context manager, a name has to be provided.
403457

@@ -435,7 +489,9 @@ async def coffee_maker(strength):
435489

436490
### `elasticapm.label()` [api-label]
437491

438-
Added in v5.0.0.
492+
```{applies_to}
493+
apm_agent_python: ga 5.0.0
494+
```
439495

440496
Attach labels to the the current transaction and errors.
441497

docs/reference/asgi-middleware.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/asgi-middleware.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# ASGI Middleware [asgi-middleware]

docs/reference/azure-functions-support.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/azure-functions-support.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Monitoring Azure Functions [azure-functions-support]

docs/reference/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Configuration [configuration]

docs/reference/django-support.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/django-support.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Django support [django-support]

docs/reference/flask-support.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/flask-support.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# Flask support [flask-support]

docs/reference/how-agent-works.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/how-the-agent-works.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_python: ga
10+
products:
11+
- id: cloud-serverless
12+
- id: observability
13+
- id: apm
414
---
515

616
# How the Agent works [how-the-agent-works]

0 commit comments

Comments
 (0)