Skip to content

Commit 5f3362b

Browse files
[7.12] [DOCS] Reformats the DevelopAPM settings tables into definition lists (elastic#130303) (elastic#131976)
* [DOCS] Reformats the DevelopAPM settings tables into definition lists (elastic#130303) Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit 9b1828a) * Fixes broken link Co-authored-by: Kibana Machine <[email protected]>
1 parent 7ed1072 commit 5f3362b

File tree

1 file changed

+33
-38
lines changed

1 file changed

+33
-38
lines changed

docs/settings/apm-settings.asciidoc

Lines changed: 33 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -43,58 +43,53 @@ If you'd like to change any of the default values,
4343
copy and paste the relevant settings into your `kibana.yml` configuration file.
4444
Changing these settings may disable features of the APM App.
4545

46-
[cols="2*<"]
47-
|===
48-
| `xpack.apm.enabled`
49-
| Set to `false` to disable the APM app. Defaults to `true`.
46+
`xpack.apm.enabled`::
47+
Set to `false` to disable the APM app. Defaults to `true`.
5048

51-
| `xpack.apm.maxServiceEnvironments`
52-
| Maximum number of unique service environments recognized by the UI. Defaults to `100`.
49+
`xpack.apm.maxServiceEnvironments` {ess-icon}::
50+
Maximum number of unique service environments recognized by the UI. Defaults to `100`.
5351

54-
| `xpack.apm.serviceMapFingerprintBucketSize`
55-
| Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
52+
`xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}::
53+
Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
5654

57-
| `xpack.apm.serviceMapFingerprintGlobalBucketSize`
58-
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
55+
`xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}::
56+
Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
5957

60-
| `xpack.apm.ui.enabled` {ess-icon}
61-
| Set to `false` to hide the APM app from the main menu. Defaults to `true`.
58+
`xpack.apm.ui.enabled` {ess-icon}::
59+
Set to `false` to hide the APM app from the main menu. Defaults to `true`.
6260

63-
| `xpack.apm.ui.transactionGroupBucketSize`
64-
| Number of top transaction groups displayed in the APM app. Defaults to `1000`.
61+
`xpack.apm.ui.transactionGroupBucketSize` {ess-icon}::
62+
Number of top transaction groups displayed in the APM app. Defaults to `1000`.
6563

66-
| `xpack.apm.ui.maxTraceItems` {ess-icon}
67-
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
64+
`xpack.apm.ui.maxTraceItems` {ess-icon}::
65+
Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
6866

69-
| `xpack.observability.annotations.index`
70-
| Index name where Observability annotations are stored. Defaults to `observability-annotations`.
67+
`xpack.observability.annotations.index` {ess-icon}::
68+
Index name where Observability annotations are stored. Defaults to `observability-annotations`.
7169

72-
| `xpack.apm.searchAggregatedTransactions`
73-
| experimental[] Enables Transaction histogram metrics. Defaults to `false`. When `true`, additional configuration in APM Server is required.
74-
See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
70+
`xpack.apm.searchAggregatedTransactions` {ess-icon}::
71+
experimental[] Enables Transaction histogram metrics. Defaults to false. When true, additional configuration in APM Server is required. See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
7572

76-
| `apm_oss.indexPattern` {ess-icon}
77-
| The index pattern used for integrations with Machine Learning and Query Bar.
78-
It must match all apm indices. Defaults to `apm-*`.
73+
`apm_oss.indexPattern` {ess-icon}::
74+
The index pattern used for integrations with Machine Learning and Query Bar.
75+
It must match all apm indices. Defaults to `apm-*`.
7976

80-
| `apm_oss.errorIndices` {ess-icon}
81-
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
77+
`apm_oss.errorIndices` {ess-icon}::
78+
Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
8279

83-
| `apm_oss.onboardingIndices`
84-
| Matcher for all onboarding indices. Defaults to `apm-*`.
80+
`apm_oss.onboardingIndices`::
81+
Matcher for all onboarding indices. Defaults to `apm-*`.
8582

86-
| `apm_oss.spanIndices` {ess-icon}
87-
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
83+
`apm_oss.spanIndices` {ess-icon}::
84+
Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
8885

89-
| `apm_oss.transactionIndices` {ess-icon}
90-
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
86+
`apm_oss.transactionIndices` {ess-icon}::
87+
Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
9188

92-
| `apm_oss.metricsIndices`
93-
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
89+
`apm_oss.metricsIndices`::
90+
Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
9491

95-
| `apm_oss.sourcemapIndices`
96-
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
97-
98-
|===
92+
`apm_oss.sourcemapIndices`::
93+
Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
9994

10095
// end::general-apm-settings[]

0 commit comments

Comments
 (0)