Skip to content

Commit 877c243

Browse files
colleenmcginniscolleenmcginnis
authored
simplify complex tables (#4783)
1 parent 056d34a commit 877c243

File tree

28 files changed

+1002
-1001
lines changed

28 files changed

+1002
-1001
lines changed

‎docs/en/observability/apm/act-on-data/alerts.asciidoc

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,19 @@ The following APM rules are supported:
1616
[cols="1,1"]
1717
|===
1818
| *APM Anomaly*
19-
a| Alert when either the latency, throughput, or failed transaction rate of a service is anomalous.
20-
Anomaly rules can be set at the environment level, service level, and/or transaction type level.
21-
22-
Read more in <<apm-anomaly-rule,APM Anomaly rule →>>
19+
| Alert when either the latency, throughput, or failed transaction rate of a service is anomalous.
20+
Anomaly rules can be set at the environment level, service level, and/or transaction type level. Read more in <<apm-anomaly-rule,APM Anomaly rule →>>
2321

2422
| *Error count threshold*
25-
a| Alert when the number of errors in a service exceeds a defined threshold. Error count rules can be set at the
26-
environment level, service level, and error group level.
27-
28-
Read more in <<apm-error-count-threshold-rule,Error count threshold rule →>>
23+
| Alert when the number of errors in a service exceeds a defined threshold. Error count rules can be set at the
24+
environment level, service level, and error group level. Read more in <<apm-error-count-threshold-rule,Error count threshold rule →>>
2925

3026
| *Failed transaction rate threshold*
31-
a| Alert when the rate of transaction errors in a service exceeds a defined threshold.
32-
33-
Read more in <<apm-failed-transaction-rate-threshold-rule,Failed transaction rate threshold rule →>>
27+
| Alert when the rate of transaction errors in a service exceeds a defined threshold. Read more in <<apm-failed-transaction-rate-threshold-rule,Failed transaction rate threshold rule →>>
3428

3529
| *Latency threshold*
36-
a| Alert when the latency or failed transaction rate is abnormal.
37-
Threshold rules can be as broad or as granular as you'd like, enabling you to define exactly when you want to be alerted--whether that's at the environment level, service name level, transaction type level, and/or transaction name level.
38-
39-
Read more in <<apm-latency-threshold-rule,Latency threshold rule →>>
30+
| Alert when the latency or failed transaction rate is abnormal.
31+
Threshold rules can be as broad or as granular as you'd like, enabling you to define exactly when you want to be alerted--whether that's at the environment level, service name level, transaction type level, and/or transaction name level. Read more in <<apm-latency-threshold-rule,Latency threshold rule →>>
4032

4133
|===
4234

‎docs/en/observability/apm/agent-server-compatibility.asciidoc

Lines changed: 79 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,54 +3,109 @@
33

44
The chart below outlines the compatibility between different versions of Elastic APM agents and extensions with the APM integration.
55

6+
[discrete]
7+
==== APM AWS Lambda extension
8+
69
[options="header"]
710
|====
8-
|Language |{apm-agent} version |APM integration version
9-
// APM AWS Lambda extension
10-
.1+|**APM AWS Lambda extension**
11+
|{apm-agent} version |APM integration version
1112
|`1.x` |≥ `8.2`
13+
|====
14+
15+
[discrete]
16+
==== Android agent
1217

13-
// Android
14-
.1+|**Android agent**
18+
[options="header"]
19+
|====
20+
|{apm-agent} version |APM integration version
1521
|`0.x` |≥ `8.12`
22+
|====
1623

17-
// Go
18-
.2+|**Go agent**
24+
[discrete]
25+
==== Go agent
26+
27+
[options="header"]
28+
|====
29+
|{apm-agent} version |APM integration version
1930
|`1.x` |≥ `6.5`
2031
|`2.x` |≥ `6.5`
32+
|====
33+
34+
[discrete]
35+
==== iOS agent
2136

22-
// iOS
23-
.1+|**iOS agent**
37+
[options="header"]
38+
|====
39+
|{apm-agent} version |APM integration version
2440
|`1.x` |≥ `8.12`
41+
|====
2542

26-
// Java
27-
.1+|*Java agent*{empty}footnote:[Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in <<apm-empty-metricset-values,Known issues>>.]
43+
[discrete]
44+
==== Java agent
45+
46+
[options="header"]
47+
|====
48+
|{apm-agent} version |APM integration version
2849
|`1.x`|≥ `6.5`
50+
|====
51+
52+
[NOTE]
53+
====
54+
Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in <<apm-empty-metricset-values,Known issues>>.
55+
====
56+
57+
[discrete]
58+
==== .NET agent
2959

30-
// .NET
31-
.1+|**.NET agent**
60+
[options="header"]
61+
|====
62+
|{apm-agent} version |APM integration version
3263
|`1.x` |≥ `6.5`
64+
|====
65+
66+
[discrete]
67+
==== Node.js agent
3368

34-
// Node
35-
.1+|**Node.js agent**
69+
[options="header"]
70+
|====
71+
|{apm-agent} version |APM integration version
3672
|`3.x` |≥ `6.6`
73+
|====
74+
75+
[discrete]
76+
==== PHP agent
3777

38-
// PHP
39-
.1+|**PHP agent**
78+
[options="header"]
79+
|====
80+
|{apm-agent} version |APM integration version
4081
|`1.x` |≥ `7.0`
82+
|====
4183

42-
// Python
43-
.1+|**Python agent**
84+
[discrete]
85+
==== Python agent
86+
87+
[options="header"]
88+
|====
89+
|{apm-agent} version |APM integration version
4490
|`6.x` |≥ `6.6`
91+
|====
92+
93+
[discrete]
94+
==== Ruby agent
4595

46-
// Ruby
47-
.2+|**Ruby agent**
96+
[options="header"]
97+
|====
98+
|{apm-agent} version |APM integration version
4899
|`3.x` |≥ `6.5`
49100
|`4.x` |≥ `6.5`
101+
|====
102+
103+
[discrete]
104+
==== JavaScript RUM agent
50105

51-
// RUM
52-
.2+|**JavaScript RUM agent**
106+
[options="header"]
107+
|====
108+
|{apm-agent} version |APM integration version
53109
|`4.x` |≥ `6.5`
54110
|`5.x` |≥ `7.0`
55-
56111
|====

‎docs/en/observability/apm/collect-application-data/open-telemetry/otel-direct.asciidoc

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -117,27 +117,25 @@ java -javaagent:/path/to/opentelemetry-javaagent-all.jar \
117117
----
118118
<1> preview:[] The OpenTelemetry logs intake via APM Server is currently in technical preview.
119119

120-
|===
121-
122-
| `OTEL_RESOURCE_ATTRIBUTES` | Fields that describe the service and the environment that the service runs in. See
120+
`OTEL_RESOURCE_ATTRIBUTES`::
121+
Fields that describe the service and the environment that the service runs in. See
123122
<<apm-open-telemetry-resource-attributes,resource attributes>> for more information.
124-
125-
| `OTEL_EXPORTER_OTLP_ENDPOINT` | APM Server URL. The host and port that APM Server listens for events on.
126-
127-
| `OTEL_EXPORTER_OTLP_HEADERS` a| Authorization header that includes the Elastic APM Secret token or API key: `"Authorization=Bearer an_apm_secret_token"` or `"Authorization=ApiKey an_api_key"`.
128-
123+
`OTEL_EXPORTER_OTLP_ENDPOINT`::
124+
APM Server URL. The host and port that APM Server listens for events on.
125+
`OTEL_EXPORTER_OTLP_HEADERS`::
126+
Authorization header that includes the Elastic APM Secret token or API key: `"Authorization=Bearer an_apm_secret_token"` or `"Authorization=ApiKey an_api_key"`.
127+
+
129128
For information on how to format an API key, see
130129
{observability-guide}/apm-api-key.html[API keys].
131-
130+
+
132131
Please note the required space between `Bearer` and `an_apm_secret_token`, and `ApiKey` and `an_api_key`.
133-
132+
+
134133
NOTE: If you are using a version of the Python OpenTelemetry agent _before_ 1.27.0, the content of the header _must_ be URL-encoded. You can use the Python standard library's `urllib.parse.quote` function to encode the content of the header.
135134

136-
| `OTEL_METRICS_EXPORTER` | Metrics exporter to use. See https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection[exporter selection] for more information.
137-
138-
| `OTEL_LOGS_EXPORTER` | Logs exporter to use. See https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection[exporter selection] for more information.
139-
140-
|===
135+
`OTEL_METRICS_EXPORTER`::
136+
Metrics exporter to use. See https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection[exporter selection] for more information.
137+
`OTEL_LOGS_EXPORTER`::
138+
Logs exporter to use. See https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#exporter-selection[exporter selection] for more information.
141139

142140
You are now ready to collect traces and <<apm-open-telemetry-collect-metrics,metrics>> before <<apm-open-telemetry-verify-metrics,verifying metrics>>
143141
and <<apm-open-telemetry-visualize,visualizing metrics>> in {kib}.

‎docs/en/observability/apm/configure/advanced-setup/command-reference.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,7 @@ more information, see https://www.elastic.co/subscriptions and
5757
[options="header"]
5858
|=======================
5959
|Commands |
60-
|<<apm-apikey-command,`apikey`>> a| {apikey-command-short-desc}.
61-
62-
deprecated::[8.6.0, Users should create API Keys through {kib} or the {es} REST API. See <<apm-api-key>>.]
60+
|<<apm-apikey-command,`apikey`>> | {apikey-command-short-desc}. deprecated:[8.6.0, Users should create API Keys through {kib} or the {es} REST API. See <<apm-api-key>>.]
6361
|<<apm-export-command,`export`>> |{export-command-short-desc}.
6462
|<<apm-help-command,`help`>> |{help-command-short-desc}.
6563
ifndef::serverless[]

‎docs/en/observability/apm/getting-started-apm/index.asciidoc

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,26 +26,25 @@ In this deployment model, use {agent} to spin up APM Server instances that can b
2626

2727
image::./images/fm-ov.png[APM Server fleet overview]
2828

29-
[cols="1,3"]
30-
|===
31-
| *Pros*
32-
a| * Conveniently manage one, some, or many different
29+
*Pros*:
30+
31+
* Conveniently manage one, some, or many different
3332
integrations from one central {fleet} UI.
3433
* Centrally manage multiple APM Servers running on edge machines.
3534

36-
| *Supported outputs*
37-
a| * {es}
35+
*Supported outputs*:
36+
37+
* {es}
3838
* {ess}
3939

4040
NOTE: Fleet-managed APM Server does _not_ support all the outputs that are supported by the APM Server binary method of running Elastic APM.
4141

42-
| *Required{nbsp}components*
43-
a| * APM agents
42+
*Required components*:
43+
44+
* APM agents
4445
* {agent} (which runs multiple subprocesses including APM Server, Fleet Server, and {stack})
4546

46-
| *Configuration method*
47-
| {kib} UI
48-
|===
47+
*Configuration method*: {kib} UI
4948

5049
[float]
5150
[[apm-setup-apm-server-binary]]
@@ -55,30 +54,29 @@ Install, configure, and run the APM Server binary wherever you need it.
5554

5655
image::./images/bin-ov.png[APM Server binary overview]
5756

58-
[cols="1,3"]
59-
|===
60-
| *Pros*
61-
a| * Simplest self-managed option
57+
*Pros*:
58+
59+
* Simplest self-managed option
6260
* No addition component knowledge required
6361
* YAML configuration simplifies automation
6462

65-
| *Supported outputs*
66-
a| * {es}
63+
*Supported outputs*:
64+
65+
* {es}
6766
* {ess}
6867
* {ls}
6968
* Kafka
7069
* Redis
7170
* File
7271
* Console
7372

74-
| *Required components*
75-
a| * APM agents
73+
*Required components*:
74+
75+
* APM agents
7676
* APM Server
7777
* {stack}
7878

79-
| *Configuration method*
80-
a| YAML
81-
|===
79+
*Configuration method*: YAML
8280

8381
[float]
8482
== Help me decide

‎docs/en/observability/apm/security/elastic-stack/feature-roles.asciidoc

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,12 @@ that has the following privileges:
8080

8181
|Cluster
8282
|`monitor`
83-
a|* Allows cluster UUID checks, which are performed as part of APM server startup preconditions
84-
if {ref}/security-settings.html[Elasticsearch security] is enabled (it is enabled by default).
85-
* Allows a license check, which is required if <<apm-tail-based-sampling,tail-based sampling>> is enabled.
83+
| Allows cluster UUID checks, which are performed as part of APM server startup preconditions
84+
if {ref}/security-settings.html[Elasticsearch security] is enabled (it is enabled by default), and allows a license check, which is required if <<apm-tail-based-sampling,tail-based sampling>> is enabled.
85+
|====
8686

8787
NOTE: If you have explicitly disabled Elastic security _and_ you are _not_ using tail-based sampling,
88-
this privilege may not be necessary.
89-
|====
88+
the `monitor` privilege may not be necessary.
9089

9190
. Assign the *general writer role* to APM Server users who need to publish APM data.
9291

‎docs/en/observability/create-alerts.asciidoc

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -60,35 +60,26 @@ tie into other third-party systems. Connectors allow actions to talk to these se
6060

6161
Learn how to create specific types of rules:
6262

63-
[cols="1,1"]
64-
|===
65-
| *All of Observability*
66-
a| * <<custom-threshold-alert,Custom threshold rule>>
67-
* <<slo-burn-rate-alert,SLO burn rate rule>>
68-
69-
| *APM*
70-
a| * <<apm-anomaly-rule,APM Anomaly rule>>
71-
* <<apm-error-count-threshold-rule,Error count threshold rule>>
72-
* <<apm-error-count-threshold-rule,Failed transaction rate threshold rule>>
73-
* <<apm-latency-threshold-rule,Latency threshold rule>>
74-
75-
| *Infrastructure*
76-
a| * <<infrastructure-threshold-alert,Inventory rule>>
77-
* <<metrics-threshold-alert,Metric threshold rule>>
78-
79-
| *Logs*
80-
a| * <<logs-threshold-alert,Log threshold rule>>
81-
82-
| *Synthetics*
83-
a| * <<monitor-status-alert-synthetics,Synthetics monitor status rule>>
84-
* <<tls-rule-synthetics,Synthetics TLS certificate rule>>
85-
86-
| *Uptime* (deprecated:[8.15.0])
87-
a| * <<monitor-status-alert-uptime,Uptime monitor status rule>>
88-
* <<tls-rule-uptime,Uptime TLS rule>>
89-
* <<duration-anomaly-alert,Uptime duration anomaly rule>>
90-
91-
|===
63+
* *All of Observability*:
64+
** <<custom-threshold-alert,Custom threshold rule>>
65+
** <<slo-burn-rate-alert,SLO burn rate rule>>
66+
* *APM*:
67+
** <<apm-anomaly-rule,APM Anomaly rule>>
68+
** <<apm-error-count-threshold-rule,Error count threshold rule>>
69+
** <<apm-error-count-threshold-rule,Failed transaction rate threshold rule>>
70+
** <<apm-latency-threshold-rule,Latency threshold rule>>
71+
* *Infrastructure*:
72+
** <<infrastructure-threshold-alert,Inventory rule>>
73+
** <<metrics-threshold-alert,Metric threshold rule>>
74+
* *Logs*:
75+
** <<logs-threshold-alert,Log threshold rule>>
76+
* *Synthetics*:
77+
** <<monitor-status-alert-synthetics,Synthetics monitor status rule>>
78+
** <<tls-rule-synthetics,Synthetics TLS certificate rule>>
79+
* *Uptime* (deprecated:[8.15.0]):
80+
** <<monitor-status-alert-uptime,Uptime monitor status rule>>
81+
** <<tls-rule-uptime,Uptime TLS rule>>
82+
** <<duration-anomaly-alert,Uptime duration anomaly rule>>
9283

9384
[discrete]
9485
[[create-alerts-rules-details]]

0 commit comments

Comments
 (0)