diff --git a/docs/integrations-index.asciidoc b/docs/integrations-index.asciidoc index dc4e2a42dab..097c3ea2fe8 100644 --- a/docs/integrations-index.asciidoc +++ b/docs/integrations-index.asciidoc @@ -134,8 +134,6 @@ include::{libbeat-dir}/shared-securing-beat.asciidoc[leveloffset=+1] include::{libbeat-dir}/monitoring/monitoring-beats.asciidoc[leveloffset=+1] -include::./legacy/exploring-es-data.asciidoc[leveloffset=+1] - include::./legacy/troubleshooting.asciidoc[leveloffset=+1] // include::./legacy/breaking-changes.asciidoc[leveloffset=+1] diff --git a/docs/legacy/error-indices.asciidoc b/docs/legacy/error-indices.asciidoc deleted file mode 100644 index 4b7a74ea5db..00000000000 --- a/docs/legacy/error-indices.asciidoc +++ /dev/null @@ -1,13 +0,0 @@ -[[error-indices]] -== Example error documents - -++++ -Error documents -++++ - -This example shows what error documents can look like when indexed in {es}: - -[source,json] ----- -include::../data/elasticsearch/generated/errors.json[] ----- diff --git a/docs/legacy/exploring-es-data.asciidoc b/docs/legacy/exploring-es-data.asciidoc index a7e7d92f481..e06be82a6f9 100644 --- a/docs/legacy/exploring-es-data.asciidoc +++ b/docs/legacy/exploring-es-data.asciidoc @@ -1,58 +1,16 @@ [[exploring-es-data]] = Explore data in {es} -Elastic APM data is stored in data streams. -include::../data-streams.asciidoc[tag=data-streams] - -The namespace default is `default`. -To configure a custom namespace, set `data_streams.namespace`: - -[source,yaml] ----- -apm-server: - data_streams.namespace: custom_namespace ----- - -[discrete] -[[apm-data-streams-list-standalone]] -== APM data streams - -By type, the APM data streams are: - -Traces:: -Traces are comprised of {apm-guide-ref}/data-model.html[spans and transactions]. -Traces are stored in the following data streams: -+ -include::../data-streams.asciidoc[tag=traces-data-streams] - -Metrics:: -Metrics include application-based metrics, aggregation metrics, and basic system metrics. -Metrics are stored in the following data streams: -+ -include::../data-streams.asciidoc[tag=metrics-data-streams] - -Logs:: -Logs include application error events and application logs. -Logs are stored in the following data streams: -+ -include::../data-streams.asciidoc[tag=logs-data-streams] - -[float] -[[sample-apm-document]] -== Sample APM documents - -Sample documents for each of the APM event types are available on these pages: - -* <> -* <> -* <> +* <> +* <> * <> -* <> [float] [[elasticsearch-query-examples]] == {es} query examples +Elastic APM data is stored in <>. + The following examples enable you to interact with {es}'s REST API. One possible way to do this is using {kib}'s {kibana-ref}/console-kibana.html[{dev-tools-app} console]. @@ -90,9 +48,60 @@ GET /_template/your-template-name ---- // CONSOLE +[float] +[[sample-apm-document]] +== Sample APM documents + +Sample documents for each of the APM event types are available below: + +[%collapsible] +.Transaction documents +==== +Example transaction documents indexed in {es}: + +[source,json] +---- +include::../data/elasticsearch/generated/transactions.json[] +---- +==== + +[%collapsible] +.Span documents +==== +Example span documents indexed in {es}: + +[source,json] +---- +include::../data/elasticsearch/generated/spans.json[] +---- +==== + +[%collapsible] +.Error documents +==== +Example error documents indexed in {es}: + +[source,json] +---- +include::../data/elasticsearch/generated/errors.json[] +---- +==== + +[%collapsible] +.Metric document +==== +include::./metricset-indices.asciidoc[tag=example] +==== + +[%collapsible] +.Source map documents +==== +Example source map document indexed in {es}: + +[source,json] +---- +include::../data/intake-api/generated/sourcemap/bundle.js.map[] +---- +==== -include::./transaction-indices.asciidoc[] -include::./span-indices.asciidoc[] -include::./error-indices.asciidoc[] -include::./metricset-indices.asciidoc[] -include::./sourcemap-indices.asciidoc[] +include::./metricset-indices.asciidoc[] \ No newline at end of file diff --git a/docs/legacy/metricset-indices.asciidoc b/docs/legacy/metricset-indices.asciidoc index c6e15023917..b5fdeadd9c7 100644 --- a/docs/legacy/metricset-indices.asciidoc +++ b/docs/legacy/metricset-indices.asciidoc @@ -1,9 +1,5 @@ [[metricset-indices]] -== Metrics documents - -++++ -Metrics documents -++++ +== Application metrics APM Server stores application metrics sent by agents as documents in {es}. Metric documents contain a timestamp, one or more metric fields, @@ -129,6 +125,7 @@ The `@timestamp` field of these documents holds the start of the aggregation int [[example-metric-document]] === Example metric document +// tag::example[] Below is an example of a metric document as stored in {es}, containing JVM metrics produced by the {apm-java-agent}. The document contains two related metrics: `jvm.gc.time` and `jvm.gc.count`. These are accompanied by various fields describing the environment in which the metrics were captured: service name, host name, Kubernetes pod UID, container ID, process ID, and more. @@ -138,3 +135,4 @@ These fields make it possible to search and aggregate across various dimensions, ---- include::../data/elasticsearch/metricset.json[] ---- +// end::example[] \ No newline at end of file diff --git a/docs/legacy/sourcemap-indices.asciidoc b/docs/legacy/sourcemap-indices.asciidoc deleted file mode 100644 index ed1dfc0a683..00000000000 --- a/docs/legacy/sourcemap-indices.asciidoc +++ /dev/null @@ -1,13 +0,0 @@ -[[sourcemap-indices]] -== Example source map document - -++++ -Source map document -++++ - -This example shows what a source map document can look like when indexed in {es}: - -[source,json] ----- -include::../data/intake-api/generated/sourcemap/bundle.js.map[] ----- diff --git a/docs/legacy/span-indices.asciidoc b/docs/legacy/span-indices.asciidoc deleted file mode 100644 index 4a82cebf1fe..00000000000 --- a/docs/legacy/span-indices.asciidoc +++ /dev/null @@ -1,13 +0,0 @@ -[[span-indices]] -== Example span documents - -++++ -Span documents -++++ - -This example shows what span documents can look like when indexed in {es}: - -[source,json] ----- -include::../data/elasticsearch/generated/spans.json[] ----- diff --git a/docs/legacy/transaction-indices.asciidoc b/docs/legacy/transaction-indices.asciidoc deleted file mode 100644 index e5db23db4e7..00000000000 --- a/docs/legacy/transaction-indices.asciidoc +++ /dev/null @@ -1,13 +0,0 @@ -[[transaction-indices]] -== Example transaction documents - -++++ -Transaction documents -++++ - -This example shows what transaction documents can look like when indexed in {es}: - -[source,json] ----- -include::../data/elasticsearch/generated/transactions.json[] ----- diff --git a/docs/manage-storage.asciidoc b/docs/manage-storage.asciidoc index 42fe7fc2aaa..706076c9f3c 100644 --- a/docs/manage-storage.asciidoc +++ b/docs/manage-storage.asciidoc @@ -206,3 +206,5 @@ POST /.ds-*-apm*/_update_by_query?expand_wildcards=all // CONSOLE TIP: Remember to also change the service name in the {apm-agents-ref}/index.html[{apm-agent} configuration]. + +include::./legacy/exploring-es-data.asciidoc[leveloffset=+2]