diff --git a/docs/apm-breaking.asciidoc b/docs/apm-breaking.asciidoc index 933edc5d043..2440b12eac9 100644 --- a/docs/apm-breaking.asciidoc +++ b/docs/apm-breaking.asciidoc @@ -41,7 +41,7 @@ There are no breaking changes in APM Server. There are three breaking changes to be aware of; these changes only impact users ingesting data with -// {apm-server-ref-v}/jaeger.html[Jaeger clients]. +{apm-guide-ref}/jaeger.html[Jaeger clients]. * Leading 0s are no longer removed from Jaeger client trace/span ids. + @@ -93,7 +93,7 @@ There are no breaking changes in APM Server. === 7.7 There are no breaking changes in APM Server. However, a previously hardcoded feature is now configurable. -// Failing to follow these <> will result in increased span metadata ingestion when upgrading to version 7.7. +Failing to follow these <> will result in increased span metadata ingestion when upgrading to version 7.7. [float] [[breaking-changes-7.6]] @@ -108,11 +108,11 @@ The following breaking changes have been introduced in 7.5: * Introduced dedicated `apm-server.ilm.setup.*` flags. This means you can now customize ILM behavior from within the APM Server configuration. As a side effect, `setup.template.*` settings will be ignored for ILM related templates per event type. -// See {apm-server-ref}/ilm.html#ilm-setup[set up ILM] for more information. +See {apm-guide-ref}/ilm.html#ilm-setup[set up ILM] for more information. * By default, ILM policies will not longer be versioned. All event types will switch to the new default policy: rollover after 30 days or when reaching a size 50gb. -// See {apm-server-ref}/ilm.html[default policy] for more information. +See {apm-guide-ref}/ilm.html[default policy] for more information. * To make use of all the new features introduced in 7.5, you must ensure you are using version 7.5+ of APM Server and version 7.5+ of Kibana. @@ -124,16 +124,16 @@ The following breaking changes have been introduced in 7.0: * Removed deprecated Intake v1 API endpoints. Upgrade agents to a version that supports APM Server ≥ 6.5. -// {apm-overview-ref-v}/breaking-7.0.0.html#breaking-remove-v1[More information]. +{apm-guide-ref}/breaking-7.0.0.html#breaking-remove-v1[More information]. * Moved fields in Elasticsearch to be compliant with the Elastic Common Schema (ECS). -// {apm-overview-ref-v}/breaking-7.0.0.html#breaking-ecs[More information and changed fields]. -// * {beats-ref}/breaking-changes-7.0.html[Breaking changes in libbeat] +{apm-guide-ref}/breaking-7.0.0.html#breaking-ecs[More information and changed fields]. +* {beats-ref}/breaking-changes-7.0.html[Breaking changes in libbeat] [float] [[breaking-changes-6.5]] === 6.5 There are no breaking changes in APM Server. -// Advanced users may find the <> useful. +Advanced users may find the <> useful. [float] [[breaking-changes-6.4]] diff --git a/docs/data-model.asciidoc b/docs/data-model.asciidoc index f05ad3b8679..2e4a365c296 100644 --- a/docs/data-model.asciidoc +++ b/docs/data-model.asciidoc @@ -165,7 +165,7 @@ Metrics have the `processor.event` property set to `metric`. TIP: Most agents limit keyword fields (e.g. `processor.event`) to 1024 characters, non-keyword fields (e.g. `system.memory.total`) to 10,000 characters. -Metrics are stored in {apm-server-ref-v}/metricset-indices.html[metric indices]. +Metrics are stored in metric indices. For a full list of tracked metrics, see the relevant agent documentation: diff --git a/docs/guide/apm-breaking-changes.asciidoc b/docs/guide/apm-breaking-changes.asciidoc deleted file mode 100644 index 027050fed07..00000000000 --- a/docs/guide/apm-breaking-changes.asciidoc +++ /dev/null @@ -1,6 +0,0 @@ -// Delete this file after stack-docs links are fixed - -// tag::notable-v8-breaking-changes[] -// end::notable-v8-breaking-changes[] -// tag::716-bc[] -// end::716-bc[] \ No newline at end of file diff --git a/docs/guide/install-and-run.asciidoc b/docs/guide/install-and-run.asciidoc deleted file mode 100644 index c030db70cc6..00000000000 --- a/docs/guide/install-and-run.asciidoc +++ /dev/null @@ -1,6 +0,0 @@ -// temp content -// delete file after obs-docs has swapped - - -// tag::apm-agent[] -// end::apm-agent[] \ No newline at end of file diff --git a/docs/ingest-pipelines.asciidoc b/docs/ingest-pipelines.asciidoc index 2376ed4be76..24b85c0570e 100644 --- a/docs/ingest-pipelines.asciidoc +++ b/docs/ingest-pipelines.asciidoc @@ -13,7 +13,7 @@ See <> for an example. === View or edit a default pipeline To view or edit a default pipelines in {kib}, -select *Stack Management* / *Index Node Pipelines*. +select *Stack Management* / *Ingest Pipelines*. Search for `apm`. See {ref}/ingest.html[ingest node pipelines] for more information. diff --git a/docs/jaeger-integration.asciidoc b/docs/jaeger-integration.asciidoc index ec236799592..3c0b3236c16 100644 --- a/docs/jaeger-integration.asciidoc +++ b/docs/jaeger-integration.asciidoc @@ -105,8 +105,8 @@ it is not possible to mix and match the use of Elastic's APM agents and Jaeger's APM agents support a larger number of features, like multiple types of metrics, and application breakdown charts. When using Jaeger, features like this will not be available in the APM app. -* Elastic APM's {apm-overview-ref-v}/apm-data-model.html[data model] is different than Jaegers. +* Elastic APM's <> is different than Jaegers. For Jaeger trace data to work with Elastic's data model, we rely on spans being tagged with the appropriate https://github.com/opentracing/specification/blob/master/semantic_conventions.md[`span.kind`]. -** Server Jaeger spans are mapped to Elastic APM {apm-overview-ref-v}/transactions.html[transactions]. -** Client Jaeger spans are mapped to Elastic APM {apm-overview-ref-v}/transaction-spans.html[spans] -- unless the span is the root, in which case it is mapped to an Elastic APM {apm-overview-ref-v}/transactions.html[transaction]. +** Server Jaeger spans are mapped to Elastic APM <>. +** Client Jaeger spans are mapped to Elastic APM <> -- unless the span is the root, in which case it is mapped to an Elastic APM <>. diff --git a/docs/apm-package/apm-integration.asciidoc b/docs/legacy/apm-package/apm-integration.asciidoc similarity index 100% rename from docs/apm-package/apm-integration.asciidoc rename to docs/legacy/apm-package/apm-integration.asciidoc diff --git a/docs/apm-package/configure.asciidoc b/docs/legacy/apm-package/configure.asciidoc similarity index 100% rename from docs/apm-package/configure.asciidoc rename to docs/legacy/apm-package/configure.asciidoc diff --git a/docs/apm-package/data-streams.asciidoc b/docs/legacy/apm-package/data-streams.asciidoc similarity index 100% rename from docs/apm-package/data-streams.asciidoc rename to docs/legacy/apm-package/data-streams.asciidoc diff --git a/docs/legacy/guide/index.asciidoc b/docs/legacy/guide/index.asciidoc index af80787bb4e..a604534773b 100644 --- a/docs/legacy/guide/index.asciidoc +++ b/docs/legacy/guide/index.asciidoc @@ -14,6 +14,13 @@ ifndef::apm-integration-docs[] endif::[] ifdef::apm-integration-docs[] +// Overwrite links to the APM Overview and APM Server Ref. Point to APM Guide instead. +:apm-overview-ref-v: {apm-guide-ref} +:apm-guide-ref: {apm-guide-ref} +:apm-server-ref-v: {apm-guide-ref} +:apm-server-ref: {apm-guide-ref} + +// change the name [[gettting-started]] = Legacy APM Overview endif::[] diff --git a/docs/legacy/index.asciidoc b/docs/legacy/index.asciidoc index 24b261b0be9..d0255e3c65f 100644 --- a/docs/legacy/index.asciidoc +++ b/docs/legacy/index.asciidoc @@ -36,7 +36,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[] :docker_platform: :win_os: :linux_os: -:apm-package-dir: {docdir}/apm-package +:apm-package-dir: {docdir}/legacy/apm-package :github_repo_link: https://github.com/elastic/apm-server/blob/v{version} ifeval::["{version}" == "8.0.0"] @@ -56,9 +56,17 @@ ifndef::apm-integration-docs[] endif::[] ifdef::apm-integration-docs[] +// Overwrite links to the APM Overview and APM Server Ref. Point to APM Guide instead. +:apm-overview-ref-v: {apm-guide-ref} +:apm-guide-ref: {apm-guide-ref} +:apm-server-ref-v: {apm-guide-ref} +:apm-server-ref: {apm-guide-ref} + +//change the name [[apm-server]] = Legacy APM Server Reference +// add deprecation notice deprecated::[7.16.0] **** diff --git a/docs/open-telemetry.asciidoc b/docs/open-telemetry.asciidoc index 4f5b3ee86e0..ec453be4261 100644 --- a/docs/open-telemetry.asciidoc +++ b/docs/open-telemetry.asciidoc @@ -64,7 +64,7 @@ java -javaagent:/path/to/opentelemetry-javaagent-all.jar \ | `OTEL_EXPORTER_OTLP_HEADERS` | Authorization header that includes the Elastic APM Secret token or API key: `"Authorization=Bearer an_apm_secret_token"` or `"Authorization=ApiKey an_api_key"`. -For information on how to format an API key, see our {apm-server-ref-v}/api-key.html[API key] docs. +For information on how to format an API key, see our <> docs. Please note the required space between `Bearer` and `an_apm_secret_token`, and `APIKey` and `an_api_key`. @@ -119,7 +119,7 @@ the https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver <3> The https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/loggingexporter[logging exporter] is helpful for troubleshooting and supports various logging levels: `debug`, `info`, `warn`, and `error`. <4> Elastic Observability endpoint configuration. To learn more, see https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlpexporter[OpenTelemetry Collector > OTLP gRPC exporter]. <5> Hostname and port of the APM Server endpoint. For example, `elastic-apm-server:8200`. -<6> Credential for Elastic APM {apm-server-ref-v}/secret-token.html[secret token authorization] (`Authorization: "Bearer a_secret_token"`) or {apm-server-ref-v}/api-key.html[API key authorization] (`Authorization: "ApiKey an_api_key"`). +<6> Credential for Elastic APM <> (`Authorization: "Bearer a_secret_token"`) or <> (`Authorization: "ApiKey an_api_key"`). <7> Environment-specific configuration parameters can be conveniently passed in as environment variables documented https://opentelemetry.io/docs/collector/configuration/#configuration-environment-variables[here] (e.g. `ELASTIC_APM_SERVER_ENDPOINT` and `ELASTIC_APM_SERVER_TOKEN`). TIP: When collecting infrastructure metrics, we recommend evaluating {metricbeat-ref}/metricbeat-overview.html[{metricbeat}] to get a mature collector with more integrations