Skip to content

Commit c44a073

Browse files
Add applies_to metadata (#2414)
* Add applies_to metadata * Remove products * Update docs/reference/wrapper-support.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/reference/asgi-middleware.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/reference/lambda-support.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/release-notes/known-issues.md Co-authored-by: Colleen McGinnis <[email protected]> --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent 7288a75 commit c44a073

32 files changed

+260
-21
lines changed

docs/reference/advanced-topics.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

612
# Advanced topics [advanced-topics]

docs/reference/aiohttp-server-support.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

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

docs/reference/api-reference.md

Lines changed: 73 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

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

1622
### Instantiation [client-api-init]
1723

18-
Added in v1.0.0.
24+
```{applies_to}
25+
apm_agent_python: ga 1.0.0
26+
```
1927

2028
To create a `Client` instance, import it and call its constructor:
2129

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

3745
#### `elasticapm.get_client()` [api-get-client]
3846

39-
[small]#Added in v6.1.0.
47+
```{applies_to}
48+
apm_agent_python: ga 6.1.0
49+
```
4050

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

@@ -51,7 +61,11 @@ client.capture_message('foo')
5161

5262
#### `Client.capture_exception()` [client-api-capture-exception]
5363

54-
Added in v1.0.0. `handled` added in v2.0.0.
64+
```{applies_to}
65+
apm_agent_python: ga 1.0.0
66+
```
67+
68+
`handled` added in v2.0.0.
5569

5670
Captures an exception object:
5771

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

7488
#### `Client.capture_message()` [client-api-capture-message]
7589

76-
Added in v1.0.0.
90+
```{applies_to}
91+
apm_agent_python: ga 1.0.0
92+
```
7793

7894
Captures a message with optional added contextual data. Example:
7995

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

111127
#### `Client.begin_transaction()` [client-api-begin-transaction]
112128

113-
Added in v1.0.0. `trace_parent` support added in v5.6.0.
129+
```{applies_to}
130+
apm_agent_python: ga 1.0.0
131+
```
132+
133+
`trace_parent` support added in v5.6.0.
114134

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

@@ -125,7 +145,9 @@ client.begin_transaction('processors')
125145

126146
#### `Client.end_transaction()` [client-api-end-transaction]
127147

128-
Added in v1.0.0.
148+
```{applies_to}
149+
apm_agent_python: ga 1.0.0
150+
```
129151

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

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

150172
#### `elasticapm.trace_parent_from_string()` [api-traceparent-from-string]
151173

152-
Added in v5.6.0.
174+
```{applies_to}
175+
apm_agent_python: ga 5.6.0
176+
```
153177

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

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

164188
#### `elasticapm.trace_parent_from_headers()` [api-traceparent-from-headers]
165189

166-
Added in v5.6.0.
190+
```{applies_to}
191+
apm_agent_python: ga 5.6.0
192+
```
167193

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

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

178204
#### `elasticapm.get_trace_parent_header()` [api-traceparent-get-header]
179205

180-
Added in v5.10.0.
206+
```{applies_to}
207+
apm_agent_python: ga 5.10.0
208+
```
181209

182210
Return the string representation of the current transaction `TraceParent` object:
183211

@@ -191,7 +219,9 @@ elasticapm.get_trace_parent_header()
191219

192220
### `elasticapm.instrument()` [api-elasticapm-instrument]
193221

194-
Added in v1.0.0.
222+
```{applies_to}
223+
apm_agent_python: ga 1.0.0
224+
```
195225

196226
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:
197227

@@ -204,7 +234,9 @@ elasticapm.instrument()
204234

205235
### `elasticapm.set_transaction_name()` [api-set-transaction-name]
206236

207-
Added in v1.0.0.
237+
```{applies_to}
238+
apm_agent_python: ga 1.0.0
239+
```
208240

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

@@ -220,7 +252,9 @@ elasticapm.set_transaction_name('myapp.billing_process')
220252

221253
### `elasticapm.set_transaction_result()` [api-set-transaction-result]
222254

223-
Added in v2.2.0.
255+
```{applies_to}
256+
apm_agent_python: ga 2.2.0
257+
```
224258

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

@@ -236,7 +270,9 @@ elasticapm.set_transaction_result('SUCCESS')
236270

237271
### `elasticapm.set_transaction_outcome()` [api-set-transaction-outcome]
238272

239-
Added in v5.9.0.
273+
```{applies_to}
274+
apm_agent_python: ga 5.9.0
275+
```
240276

241277
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.
242278

@@ -277,7 +313,9 @@ elasticapm.set_transaction_outcome(OUTCOME.UNKNOWN)
277313

278314
### `elasticapm.get_transaction_id()` [api-get-transaction-id]
279315

280-
Added in v5.2.0.
316+
```{applies_to}
317+
apm_agent_python: ga 5.2.0
318+
```
281319

282320
Get the id of the current transaction. Example:
283321

@@ -290,7 +328,9 @@ transaction_id = elasticapm.get_transaction_id()
290328

291329
### `elasticapm.get_trace_id()` [api-get-trace-id]
292330

293-
Added in v5.2.0.
331+
```{applies_to}
332+
apm_agent_python: ga 5.2.0
333+
```
294334

295335
Get the `trace_id` of the current transaction’s trace. Example:
296336

@@ -303,7 +343,9 @@ trace_id = elasticapm.get_trace_id()
303343

304344
### `elasticapm.get_span_id()` [api-get-span-id]
305345

306-
Added in v5.2.0.
346+
```{applies_to}
347+
apm_agent_python: ga 5.2.0
348+
```
307349

308350
Get the id of the current span. Example:
309351

@@ -316,7 +358,9 @@ span_id = elasticapm.get_span_id()
316358

317359
### `elasticapm.set_custom_context()` [api-set-custom-context]
318360

319-
Added in v2.0.0.
361+
```{applies_to}
362+
apm_agent_python: ga 2.0.0
363+
```
320364

321365
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.
322366

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

346390
### `elasticapm.set_user_context()` [api-set-user-context]
347391

348-
Added in v2.0.0.
392+
```{applies_to}
393+
apm_agent_python: ga 2.0.0
394+
```
349395

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

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

365411
### `elasticapm.capture_span` [api-capture-span]
366412

367-
Added in v4.1.0.
413+
```{applies_to}
414+
apm_agent_python: ga 4.1.0
415+
```
368416

369417
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.
370418

@@ -397,7 +445,9 @@ def coffee_maker(strength):
397445

398446
### `elasticapm.async_capture_span` [api-async-capture-span]
399447

400-
Added in v5.4.0.
448+
```{applies_to}
449+
apm_agent_python: ga 5.4.0
450+
```
401451

402452
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.
403453

@@ -435,7 +485,9 @@ async def coffee_maker(strength):
435485

436486
### `elasticapm.label()` [api-label]
437487

438-
Added in v5.0.0.
488+
```{applies_to}
489+
apm_agent_python: ga 5.0.0
490+
```
439491

440492
Attach labels to the the current transaction and errors.
441493

docs/reference/asgi-middleware.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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: preview
410
---
511

612
# ASGI Middleware [asgi-middleware]

docs/reference/azure-functions-support.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

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

docs/reference/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

612
# Configuration [configuration]

docs/reference/django-support.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

612
# Django support [django-support]

docs/reference/flask-support.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

612
# Flask support [flask-support]

docs/reference/how-agent-works.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
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
410
---
511

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

docs/reference/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/apm/agent/python/current/getting-started.html
44
- https://www.elastic.co/guide/en/apm/agent/python/current/index.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_python: ga
511
---
612

713
# APM Python agent [getting-started]

0 commit comments

Comments
 (0)