Skip to content

Commit

Permalink
docs: fix links and remove temp files
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 committed Oct 29, 2021
1 parent d9a7812 commit a0add1d
Show file tree
Hide file tree
Showing 12 changed files with 31 additions and 28 deletions.
16 changes: 8 additions & 8 deletions docs/apm-breaking.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
+
Expand Down Expand Up @@ -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 <<upgrading-to-77,upgrade steps>> will result in increased span metadata ingestion when upgrading to version 7.7.
Failing to follow these <<upgrading-to-77,upgrade steps>> will result in increased span metadata ingestion when upgrading to version 7.7.

[float]
[[breaking-changes-7.6]]
Expand All @@ -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.
Expand All @@ -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 <<upgrading-to-65,upgrading to 6.5 guide>> useful.
Advanced users may find the <<upgrading-to-65,upgrading to 6.5 guide>> useful.

[float]
[[breaking-changes-6.4]]
Expand Down
2 changes: 1 addition & 1 deletion docs/data-model.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 0 additions & 6 deletions docs/guide/apm-breaking-changes.asciidoc

This file was deleted.

6 changes: 0 additions & 6 deletions docs/guide/install-and-run.asciidoc

This file was deleted.

2 changes: 1 addition & 1 deletion docs/ingest-pipelines.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ See <<apm-data-security,data security>> 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.
Expand Down
6 changes: 3 additions & 3 deletions docs/jaeger-integration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<data-model>> 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 <<data-model-transactions>>.
** Client Jaeger spans are mapped to Elastic APM <<data-model-spans>> -- unless the span is the root, in which case it is mapped to an Elastic APM <<data-model-transactions>>.
File renamed without changes.
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions docs/legacy/guide/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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::[]
Expand Down
10 changes: 9 additions & 1 deletion docs/legacy/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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]

****
Expand Down
4 changes: 2 additions & 2 deletions docs/open-telemetry.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<api-key,API key>> docs.

Please note the required space between `Bearer` and `an_apm_secret_token`, and `APIKey` and `an_api_key`.

Expand Down Expand Up @@ -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 <<secret-token,secret token authorization>> (`Authorization: "Bearer a_secret_token"`) or <<api-key,API key authorization>> (`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
Expand Down

0 comments on commit a0add1d

Please sign in to comment.