Skip to content

Commit 27fc737

Browse files
[apm] Update APM docs to reflect changes related to the Elasticsearch apm-data plugin (#4333)
* update getting started docs * update upgrade guide * fix build * audit mentions of the apm integration * audit mentions of data streams * audit mentions of index templates * audit mentions of index mappings * address feedback from @carsonip * update diagram * address more feedback from @carsonip * update ilm guide * address more feedback from @lahsivjar * address more feedback from @lahsivjar * add link * fix table formatting * address more feedback from @lahsivjar
1 parent 08cf555 commit 27fc737

17 files changed

+83
-250
lines changed

docs/en/observability/apm/configure/general.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Defaults to `debug/vars`.
173173
=== Data stream namespace
174174

175175
Change the default namespace.
176-
This setting changes the name of the integration's data stream.
176+
This setting changes the name of the data stream.
177177

178178
For {fleet}-managed users, the namespace is inherited from the selected {agent} policy.
179179

docs/en/observability/apm/configure/outputs/console.asciidoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,6 @@ output.console:
2626
pretty: true
2727
------------------------------------------------------------------------------
2828

29-
ifdef::apm-server[]
30-
[float]
31-
=== {kib} configuration
32-
33-
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
34-
endif::[]
35-
3629
[float]
3730
=== Configuration options
3831

docs/en/observability/apm/configure/outputs/kafka.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,6 @@ output.kafka:
3737

3838
NOTE: Events bigger than <<apm-kafka-max_message_bytes,`max_message_bytes`>> will be dropped. To avoid this problem, make sure APM Server does not generate events bigger than <<apm-kafka-max_message_bytes,`max_message_bytes`>>.
3939

40-
[float]
41-
=== {kib} configuration
42-
43-
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
44-
4540
[float]
4641
[[apm-kafka-compatibility]]
4742
=== Compatibility

docs/en/observability/apm/configure/outputs/logstash.asciidoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ protocol, which runs over TCP.
2121
To send events to {ls}, you must:
2222

2323
. <<apm-ls-output-config,Enable the {ls} output in APM Server>>
24-
. <<apm-ls-kib-config,Enable the {kib} endpoint in APM Server>>
2524
. <<apm-ls-config-pipeline,Create a {ls} configuration pipeline in {ls}>>
2625

2726
[float]
@@ -43,12 +42,6 @@ output.logstash:
4342
<1> The `hosts` option specifies the {ls} server and the port (`5044`) where {ls} is configured to listen for incoming
4443
APM Server connections.
4544

46-
[float]
47-
[[apm-ls-kib-config]]
48-
=== {kib} endpoint configuration
49-
50-
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
51-
5245
[float]
5346
[[apm-ls-config-pipeline]]
5447
=== {ls} configuration pipeline

docs/en/observability/apm/configure/outputs/redis.asciidoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,6 @@ output.redis:
3030
timeout: 5
3131
------------------------------------------------------------------------------
3232

33-
[float]
34-
=== {kib} configuration
35-
36-
include::../../shared-kibana-endpoint.asciidoc[tag=shared-kibana-config]
37-
3833
[float]
3934
=== Compatibility
4035

docs/en/observability/apm/getting-started-apm/get-started-with-apm-server-binary.asciidoc

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -165,69 +165,6 @@ See <<apm-running-on-docker, Running on Docker>> for deploying Docker containers
165165
[[apm-server-configuration]]
166166
== Step 2: Set up and configure
167167

168-
// This content is reused in the upgrading guide
169-
// tag::why-apm-integration[]
170-
Starting in version 8.0.0, {fleet} uses the APM integration to set up and manage APM index templates,
171-
{ilm-init} policies, and ingest pipelines. APM Server will only send data to {es} _after_ the APM integration has been installed.
172-
// end::why-apm-integration[]
173-
174-
[float]
175-
=== Install the APM integration
176-
177-
// This content is reused in the upgrading guide
178-
// tag::install-apm-integration[]
179-
[%collapsible%open]
180-
.**If you have an internet connection**
181-
====
182-
An internet connection is required to install the APM integration via the {fleet} UI in {kib}.
183-
184-
// lint ignore elastic-agent
185-
. Open {kib} and select **Add integrations** > **Elastic APM**.
186-
. Click **APM integration**.
187-
. Click **Add Elastic APM**.
188-
. Click **Save and continue**.
189-
. Click **Add Elastic Agent later**. You do not need to run an {agent} to complete the setup.
190-
====
191-
192-
// tag::install-apm-integration-no-internet[]
193-
[%collapsible]
194-
.**If you don't have an internet connection**
195-
====
196-
If your environment has network traffic restrictions, there are other ways to install the APM integration.
197-
See {fleet-guide}/air-gapped.html[Air-gapped environments] for more information.
198-
199-
Option 1: Update `kibana.yml`::
200-
+
201-
Update `kibana.yml` to include the following, then restart {kib}.
202-
+
203-
[source,yaml]
204-
----
205-
xpack.fleet.packages:
206-
- name: apm
207-
version: latest
208-
----
209-
+
210-
See {kibana-ref}/settings.html[Configure Kibana] to learn more about how to edit the Kibana configuration file.
211-
212-
Option 2: Use the {fleet} API::
213-
+
214-
Use the {fleet} API to install the APM integration. To be successful, this needs to be run against the {kib}
215-
API, not the {es} API.
216-
+
217-
["source","yaml",subs="attributes"]
218-
----
219-
POST kbn:/api/fleet/epm/packages/apm/{apm_server_version}
220-
{ "force": true }
221-
----
222-
+
223-
See {kibana-ref}/api.html[Kibana API] to learn more about how to use the Kibana APIs.
224-
====
225-
// end::install-apm-integration-no-internet[]
226-
// end::install-apm-integration[]
227-
228-
[float]
229-
=== Configure APM
230-
231168
Configure APM by editing the `apm-server.yml` configuration file.
232169
The location of this file varies by platform--see the <<apm-directory-layout>> for help locating it.
233170

docs/en/observability/apm/getting-started-apm/get-started-with-fleet-apm-server.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ include::{observability-docs-root}/docs/en/observability/tab-widgets/add-apm-int
3232
An internet connection is required to install the APM integration via the Fleet UI in Kibana.
3333
3434
--
35-
include::{observability-docs-root}/docs/en/observability/apm/getting-started-apm/get-started-with-apm-server-binary.asciidoc[leveloffset=+2,tag=install-apm-integration-no-internet]
35+
include::{observability-docs-root}/docs/en/observability/apm/shared/install-apm-integration-no-internet.asciidoc[]
3636
--
3737
****
3838

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ The {es} Service is available on AWS, GCP, and Azure.
1212
*To get started in minutes, follow the steps in <<get-started-with-fleet-apm-server>>.*
1313
****
1414

15-
// TODO: MOVE THIS
16-
IMPORTANT: Starting in version 8.0.0, {fleet} uses the APM integration to set up and manage APM index templates,
17-
{ilm-init} policies, and ingest pipelines. APM Server will only send data to {es} _after_ the APM integration has been installed.
15+
IMPORTANT: Starting in version 8.15.0, the {es} apm-data plugin manages APM index templates,
16+
lifecycle policies, and ingest pipelines.
1817

1918
The APM Server receives performance data from your APM agents,
2019
validates and processes it, and then transforms the data into {es} documents.
-63.3 KB
Loading

docs/en/observability/apm/manage-storage/data-streams.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ See the {fleet-guide}/data-streams.html[{fleet} and {agent} Guide] to learn more
2020

2121
// tag::data-streams[]
2222
APM data follows the `<type>-<dataset>-<namespace>` naming scheme.
23-
The `type` and `dataset` are predefined by the APM integration,
23+
The `type` and `dataset` are predefined by the {es} apm-data plugin,
2424
but the `namespace` is your opportunity to customize how different types of data are stored in {es}.
2525
There is no recommendation for what to use as your namespace--it is intentionally flexible.
2626
For example, you might create namespaces for each of your environments,

0 commit comments

Comments
 (0)