Skip to content

Commit 3b0b1eb

Browse files
Add applies_to statements (#4196)
* Add applies_to metadataa * Add section applies * Remove products * Update docs/reference/config-metrics.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/reference/method-sampling-based.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/reference/how-to-find-slow-methods.md Co-authored-by: Colleen McGinnis <[email protected]> * Update docs/reference/how-to-find-slow-methods.md Co-authored-by: Colleen McGinnis <[email protected]> --------- Co-authored-by: Colleen McGinnis <[email protected]>
1 parent 603e8f7 commit 3b0b1eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+623
-86
lines changed

apm-agent-builds/apm-agent/src/test/resources/config-reference-properties-file.md.ftl

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/java/current/config-reference-properties-file.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_java: ga
410
---
511

612
# Property file reference [config-reference-properties-file]

docs/reference/aws-lambda.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ mapped_pages:
44
sub:
55
apm-lambda-ext-v: ver-1-5-7
66
apm-java-v: ver-1-52-2
7+
applies_to:
8+
stack:
9+
serverless:
10+
observability:
11+
product:
12+
apm_agent_java: ga
713
---
814

915
# Monitoring AWS Lambda Java Functions [aws-lambda]

docs/reference/community-plugins.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/java/current/community-plugins.html
4+
applies_to:
5+
stack:
6+
serverless:
7+
observability:
8+
product:
9+
apm_agent_java: ga
410
---
511

612
# Community plugins [community-plugins]

docs/reference/config-circuit-breaker.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,21 @@
22
navigation_title: "Circuit-Breaker"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-circuit-breaker.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
511
---
612

713
# Circuit-Breaker configuration options [config-circuit-breaker]
814

15+
## `circuit_breaker_enabled` [config-circuit-breaker-enabled]
916

10-
11-
## `circuit_breaker_enabled` ([1.14.0] performance) [config-circuit-breaker-enabled]
17+
```{applies_to}
18+
apm_agent_java: ga 1.14.0
19+
```
1220

1321
A boolean specifying whether the circuit breaker should be enabled or not. When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. If ANY of the monitors detects a stress indication, the agent will become inactive, as if the [`recording`](/reference/config-core.md#config-recording) configuration option has been set to `false`, thus reducing resource consumption to a minimum. When inactive, the agent continues polling the same monitors in order to detect whether the stress state has been relieved. If ALL monitors approve that the system/process/JVM is not under stress anymore, the agent will resume and become fully functional.
1422

docs/reference/config-core.md

Lines changed: 131 additions & 27 deletions
Large diffs are not rendered by default.

docs/reference/config-datastore.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22
navigation_title: "Datastore"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-datastore.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
511
---
612

713
# Datastore configuration options [config-datastore]
814

915

1016

11-
## `elasticsearch_capture_body_urls` ([1.37.0]) [config-elasticsearch-capture-body-urls]
17+
## `elasticsearch_capture_body_urls` [config-elasticsearch-capture-body-urls]
18+
19+
```{applies_to}
20+
apm_agent_java: ga 1.37.0
21+
```
1222

1323
The URL path patterns for which the APM agent will capture the request body of outgoing requests to Elasticsearch made with the `elasticsearch-restclient` instrumentation. The default setting captures the body for Elasticsearch REST APIs searches and counts.
1424

docs/reference/config-http.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22
navigation_title: "HTTP"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-http.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
511
---
612

713
# HTTP configuration options [config-http]
814

915

1016

11-
## `capture_body_content_types` ([1.5.0] performance) [config-capture-body-content-types]
17+
## `capture_body_content_types` (performance) [config-capture-body-content-types]
18+
19+
```{applies_to}
20+
apm_agent_java: ga 1.5.0
21+
```
1222

1323
Configures which content types should be recorded.
1424

@@ -46,7 +56,11 @@ This option supports the wildcard `*`, which matches zero or more characters. Ex
4656
| `elastic.apm.transaction_ignore_urls` | `transaction_ignore_urls` | `ELASTIC_APM_TRANSACTION_IGNORE_URLS` |
4757

4858

49-
## `transaction_ignore_user_agents` ([1.22.0]) [config-transaction-ignore-user-agents]
59+
## `transaction_ignore_user_agents` [config-transaction-ignore-user-agents]
60+
61+
```{applies_to}
62+
apm_agent_java: ga 1.22.0
63+
```
5064

5165
Used to restrict requests from certain User-Agents from being instrumented.
5266

@@ -65,7 +79,11 @@ This option supports the wildcard `*`, which matches zero or more characters. Ex
6579
| `elastic.apm.transaction_ignore_user_agents` | `transaction_ignore_user_agents` | `ELASTIC_APM_TRANSACTION_IGNORE_USER_AGENTS` |
6680

6781

68-
## `use_path_as_transaction_name` ([1.0.0]) [config-use-path-as-transaction-name]
82+
## `use_path_as_transaction_name` [config-use-path-as-transaction-name]
83+
84+
```{applies_to}
85+
apm_agent_java: ga 1.0.0
86+
```
6987

7088
If set to `true`, transaction names of unsupported or partially-supported frameworks will be in the form of `$method $path` instead of just `$method unknown route`.
7189

@@ -106,7 +124,11 @@ This option supports the wildcard `*`, which matches zero or more characters. Ex
106124
| `elastic.apm.url_groups` | `url_groups` | `ELASTIC_APM_URL_GROUPS` |
107125

108126

109-
## `capture_http_client_request_body_size` ([1.52.0] experimental) [config-capture-http-client-request-body-size]
127+
## `capture_http_client_request_body_size` (experimental) [config-capture-http-client-request-body-size]
128+
129+
```{applies_to}
130+
apm_agent_java: ga 1.52.0
131+
```
110132

111133
::::{note}
112134
This feature is currently experimental, which means it is disabled by default and it is not guaranteed to be backwards compatible in future releases.
@@ -129,7 +151,11 @@ Currently only support for Apache Http Client v4 and v5, HttpUrlConnection, Spri
129151
| `elastic.apm.capture_http_client_request_body_size` | `capture_http_client_request_body_size` | `ELASTIC_APM_CAPTURE_HTTP_CLIENT_REQUEST_BODY_SIZE` |
130152

131153

132-
## `capture_http_client_request_body_as_label` ([1.54.0]) [config-capture-http-client-request-body-as-label]
154+
## `capture_http_client_request_body_as_label` [config-capture-http-client-request-body-as-label]
155+
156+
```{applies_to}
157+
apm_agent_java: ga 1.54.0
158+
```
133159

134160
::::{note}
135161
This feature is currently experimental, which means it is disabled by default and it is not guaranteed to be backwards compatible in future releases.

docs/reference/config-huge-traces.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,27 @@
22
navigation_title: "Huge Traces"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-huge-traces.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
11+
products:
12+
- id: cloud-serverless
13+
- id: observability
14+
- id: apm
515
---
616

717
# Huge Traces configuration options [config-huge-traces]
818

919

1020

11-
## `span_compression_enabled` ([1.30.0]) [config-span-compression-enabled]
21+
## `span_compression_enabled` [config-span-compression-enabled]
22+
23+
```{applies_to}
24+
apm_agent_java: ga 1.30.0
25+
```
1226

1327
Setting this option to true will enable span compression feature. Span compression reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that some information such as DB statements of all the compressed spans will not be collected.
1428

@@ -23,7 +37,11 @@ Setting this option to true will enable span compression feature. Span compressi
2337
| `elastic.apm.span_compression_enabled` | `span_compression_enabled` | `ELASTIC_APM_SPAN_COMPRESSION_ENABLED` |
2438

2539

26-
## `span_compression_exact_match_max_duration` ([1.30.0]) [config-span-compression-exact-match-max-duration]
40+
## `span_compression_exact_match_max_duration` [config-span-compression-exact-match-max-duration]
41+
42+
```{applies_to}
43+
apm_agent_java: ga 1.30.0
44+
```
2745

2846
Consecutive spans that are exact match and that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected.
2947

@@ -40,7 +58,11 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `50ms`.
4058
| `elastic.apm.span_compression_exact_match_max_duration` | `span_compression_exact_match_max_duration` | `ELASTIC_APM_SPAN_COMPRESSION_EXACT_MATCH_MAX_DURATION` |
4159

4260

43-
## `span_compression_same_kind_max_duration` ([1.30.0]) [config-span-compression-same-kind-max-duration]
61+
## `span_compression_same_kind_max_duration` [config-span-compression-same-kind-max-duration]
62+
63+
```{applies_to}
64+
apm_agent_java: ga 1.30.0
65+
```
4466

4567
Consecutive spans to the same destination that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected.
4668

@@ -57,7 +79,11 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`.
5779
| `elastic.apm.span_compression_same_kind_max_duration` | `span_compression_same_kind_max_duration` | `ELASTIC_APM_SPAN_COMPRESSION_SAME_KIND_MAX_DURATION` |
5880

5981

60-
## `exit_span_min_duration` ([1.30.0]) [config-exit-span-min-duration]
82+
## `exit_span_min_duration` [config-exit-span-min-duration]
83+
84+
```{applies_to}
85+
apm_agent_java: ga 1.30.0
86+
```
6187

6288
Exit spans are spans that represent a call to an external service, like a database. If such calls are very short, they are usually not relevant and can be ignored.
6389

docs/reference/config-jax-rs.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
navigation_title: "JAX-RS"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-jax-rs.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
511
---
612

713
# JAX-RS configuration options [config-jax-rs]
@@ -21,7 +27,11 @@ By default, the agent will scan for @Path annotations on the whole class hierarc
2127
| `elastic.apm.enable_jaxrs_annotation_inheritance` | `enable_jaxrs_annotation_inheritance` | `ELASTIC_APM_ENABLE_JAXRS_ANNOTATION_INHERITANCE` |
2228

2329

24-
## `use_jaxrs_path_as_transaction_name` ([1.8.0]) [config-use-jaxrs-path-as-transaction-name]
30+
## `use_jaxrs_path_as_transaction_name` [config-use-jaxrs-path-as-transaction-name]
31+
32+
```{applies_to}
33+
apm_agent_java: ga 1.8.0
34+
```
2535

2636
By default, the agent will use `ClassName#methodName` for the transaction name of JAX-RS requests. If you want to use the URI template from the `@Path` annotation, set the value to `true`.
2737

docs/reference/config-jmx.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,23 @@
22
navigation_title: "JMX"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/java/current/config-jmx.html
5+
applies_to:
6+
stack:
7+
serverless:
8+
observability:
9+
product:
10+
apm_agent_java: ga
511
---
612

713
# JMX configuration options [config-jmx]
814

915

1016

11-
## `capture_jmx_metrics` ([1.11.0]) [config-capture-jmx-metrics]
17+
## `capture_jmx_metrics` [config-capture-jmx-metrics]
18+
19+
```{applies_to}
20+
apm_agent_java: ga 1.11.0
21+
```
1222

1323
Report metrics from JMX to the APM Server
1424

0 commit comments

Comments
 (0)