Skip to content

Commit

Permalink
Update APM URLs (#3674)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Mar 27, 2024
1 parent 3ecc3cd commit c60b759
Show file tree
Hide file tree
Showing 118 changed files with 1,051 additions and 1,071 deletions.
388 changes: 184 additions & 204 deletions docs/en/apm-server/redirects.asciidoc

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/en/observability/apm.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ like JVM metrics in the Java Agent, and Go runtime metrics in the Go Agent.
=== Give Elastic APM a try

Use <<traces-get-started,Get started with application traces and APM>> to quickly spin up an APM deployment.
Want to host everything yourself instead? See <<getting-started-apm-server>>.
Want to host everything yourself instead? See <<apm-getting-started-apm-server>>.

include::{observability-docs-root}/docs/en/observability/apm/getting-started-apm-server.asciidoc[]

Expand Down
16 changes: 8 additions & 8 deletions docs/en/observability/apm/access-api-keys.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[role="xpack"]
[[beats-api-keys]]
[[apm-beats-api-keys]]
=== Grant access using API keys

Instead of using usernames and passwords, you can use API keys to grant
Expand All @@ -15,7 +15,7 @@ NOTE: For security reasons, we recommend using a unique API key per APM Server i
You can create as many API keys per user as necessary.

[float]
[[beats-api-key-publish]]
[[apm-beats-api-key-publish]]
==== Create an API key for writing events

In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**.
Expand Down Expand Up @@ -57,7 +57,7 @@ In the role descriptors box, assign the appropriate privileges to the new API ke
----

NOTE: This example only provides privileges for **writing data**.
See <<feature-roles>> for additional privileges and information.
See <<apm-feature-roles>> for additional privileges and information.

To set an expiration date for the API key, select **Expire after time**
and input the lifetime of the API key in days.
Expand All @@ -74,7 +74,7 @@ output.elasticsearch:
<1> Format is `id:api_key` (as shown in the {beats} dropdown)

[float]
[[beats-api-key-monitor]]
[[apm-beats-api-key-monitor]]
==== Create an API key for monitoring

In {kib}, navigate to **{stack-manage-app}** > **API keys** and click **Create API key**.
Expand All @@ -101,7 +101,7 @@ For example:
----

NOTE: This example only provides privileges for **publishing monitoring data**.
See <<feature-roles>> for additional privileges and information.
See <<apm-feature-roles>> for additional privileges and information.

To set an expiration date for the API key, select **Expire after time**
and input the lifetime of the API key in days.
Expand All @@ -118,7 +118,7 @@ monitoring.elasticsearch:
<1> Format is `id:api_key` (as shown in the {beats} dropdown)

[float]
[[beats-api-key-es]]
[[apm-beats-api-key-es]]
==== Create an API key with {es} APIs

You can also use {es}'s {ref}/security-api-create-api-key.html[Create API key API] to create a new API key.
Expand Down Expand Up @@ -158,11 +158,11 @@ POST /_security/api_key
}
------------------------------------------------------------
<1> Name of the API key
<2> Granted privileges, see <<feature-roles>>
<2> Granted privileges, see <<apm-feature-roles>>

See the {ref}/security-api-create-api-key.html[Create API key] reference for more information.

[[learn-more-api-keys]]
[[apm-learn-more-api-keys]]
[float]
==== Learn more about API keys

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[agent-server-compatibility]]
[[apm-agent-server-compatibility]]
=== {apm-agent} compatibility

The chart below outlines the compatibility between different versions of Elastic APM agents and extensions with the APM integration.
Expand Down
14 changes: 7 additions & 7 deletions docs/en/observability/apm/anonymous-auth.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[anonymous-auth]]
[[apm-anonymous-auth]]
=== Anonymous authentication

Elastic APM agents can send unauthenticated (anonymous) events to the APM Server.
Expand All @@ -8,7 +8,7 @@ The APM Server's default response to these these requests depends on its configu
[options="header"]
|====
|Configuration |Default
|An <<api-key,API key>> or <<secret-token,secret token>> is configured | Anonymous requests are rejected and an authentication error is returned.
|An <<apm-api-key,API key>> or <<apm-secret-token,secret token>> is configured | Anonymous requests are rejected and an authentication error is returned.
|No API key or secret token is configured | Anonymous requests are accepted by the APM Server.
|====

Expand All @@ -21,19 +21,19 @@ To solve this problem, you can enable anonymous authentication in the APM Server
ingestion of unauthenticated client-side APM data while still requiring authentication for server-side services.

[float]
[[anonymous-auth-config]]
[[apm-anonymous-auth-config]]
=== Configuring anonymous auth for client-side services

[NOTE]
====
You can only enable and configure anonymous authentication if an <<api-key,API key>> or
<<secret-token,secret token>> is configured. If neither are configured, these settings will be ignored.
You can only enable and configure anonymous authentication if an <<apm-api-key,API key>> or
<<apm-secret-token,secret token>> is configured. If neither are configured, these settings will be ignored.
====

include::{observability-docs-root}/docs/en/observability/apm/tab-widgets/anonymous-auth-widget.asciidoc[]

[float]
[[derive-client-ip]]
[[apm-derive-client-ip]]
=== Deriving an incoming request's `client.ip` address

The remote IP address of an incoming request might be different
Expand All @@ -48,7 +48,7 @@ The supported headers are parsed in the following order:
If none of these headers are present, the remote address for the incoming request is used.

[float]
[[derive-client-ip-concerns]]
[[apm-derive-client-ip-concerns]]
==== Using a reverse proxy or load balancer

HTTP headers are easily modified;
Expand Down
16 changes: 8 additions & 8 deletions docs/en/observability/apm/api-config.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[[api-config]]
[[apm-api-config]]
=== Elastic APM agent configuration API

APM Server exposes API endpoints that allow Elastic APM agents to query the APM Server for configuration changes.
More information on this feature is available in {kibana-ref}/agent-configuration.html[{apm-agent} configuration in {kib}].

[float]
[[api-config-endpoint]]
[[apm-api-config-endpoint]]
=== Agent configuration endpoints

[options="header"]
Expand All @@ -16,10 +16,10 @@ More information on this feature is available in {kibana-ref}/agent-configuratio
|====

The Agent configuration endpoints accepts both `HTTP GET` and `HTTP POST` requests.
If an <<api-key>> or <<secret-token>> is configured, requests to this endpoint must be authenticated.
If an <<apm-api-key>> or <<apm-secret-token>> is configured, requests to this endpoint must be authenticated.

[float]
[[api-config-api-get]]
[[apm-api-config-api-get]]
==== HTTP GET

`service.name` is a required query string parameter.
Expand All @@ -30,7 +30,7 @@ http(s)://{hostname}:{port}/config/v1/agents?service.name=SERVICE_NAME
------------------------------------------------------------

[float]
[[api-config-api-post]]
[[apm-api-config-api-post]]
==== HTTP POST

Encode parameters as a JSON object in the body.
Expand All @@ -49,15 +49,15 @@ http(s)://{hostname}:{port}/config/v1/agents
------------------------------------------------------------

[float]
[[api-config-api-response]]
[[apm-api-config-api-response]]
==== Responses

* Successful - `200`
* APM Server is configured to fetch agent configuration from {es} but the configuration is invalid - `403`
* APM Server is starting up or {es} is unreachable - `503`

[float]
[[api-config-api-example]]
[[apm-api-config-api-example]]
==== Example request

Example Agent configuration `GET` request including the service name "test-service":
Expand All @@ -78,7 +78,7 @@ curl -X POST http://127.0.0.1:8200/config/v1/agents \
---------------------------------------------------------------------------

[float]
[[api-config-api-ex-response]]
[[apm-api-config-api-ex-response]]
==== Example response

["source","sh",subs="attributes"]
Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/apm/api-error.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[api-error]]
[[apm-api-error]]
==== Errors

An error or a logged error message captured by an agent occurring in a monitored service.

[float]
[[api-error-schema]]
[[apm-api-error-schema]]
==== Error Schema

APM Server uses JSON Schema to validate requests. The specification for errors is defined on
Expand Down
2 changes: 1 addition & 1 deletion docs/en/observability/apm/api-event-example.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[api-event-example]]
[[apm-api-event-example]]
==== Example request body

A request body example containing one event for all currently supported event types.
Expand Down
26 changes: 13 additions & 13 deletions docs/en/observability/apm/api-events.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[api-events]]
[[apm-api-events]]
=== Elastic APM events intake API

NOTE: Most users do not need to interact directly with the events intake API.
Expand All @@ -20,9 +20,9 @@ as soon as they are recorded in the agent.
This makes it simple for agents to serialize each event to a stream of newline delimited JSON.
The APM Server also treats the HTTP body as a compressed stream and thus reads and handles each event independently.

See the <<data-model,APM data model>> to learn more about the different types of events.
See the <<apm-data-model,APM data model>> to learn more about the different types of events.

[[api-events-endpoint]]
[[apm-api-events-endpoint]]
[float]
=== Endpoints

Expand All @@ -36,7 +36,7 @@ APM Server exposes the following endpoints for Elastic APM agent data intake:
|RUM event intake (v3) |`/intake/v3/rum/events`
|====

[[api-events-example]]
[[apm-api-events-example]]
[float]
=== Request

Expand Down Expand Up @@ -70,15 +70,15 @@ For <<apm-rum,RUM>> send an `HTTP POST` request to the APM Server `intake/v3/rum
http(s)://{hostname}:{port}/intake/v3/rum/events
------------------------------------------------------------

[[api-events-response]]
[[apm-api-events-response]]
[float]
=== Response

On success, the server will respond with a 202 Accepted status code and no body.

Keep in mind that events can succeed and fail independently of each other. Only if all events succeed does the server respond with a 202.

[[api-events-errors]]
[[apm-api-events-errors]]
[float]
=== Errors

Expand Down Expand Up @@ -132,18 +132,18 @@ An example error response might look something like this:

If you're developing an agent, these errors can be useful for debugging.

[[api-events-schema-definition]]
[[apm-api-events-schema-definition]]
[float]
=== Event API Schemas

The APM Server uses a collection of JSON Schemas for validating requests to the intake API:

* <<api-metadata>>
* <<api-transaction>>
* <<api-span>>
* <<api-error>>
* <<api-metricset>>
* <<api-event-example>>
* <<apm-api-metadata>>
* <<apm-api-transaction>>
* <<apm-api-span>>
* <<apm-api-error>>
* <<apm-api-metricset>>
* <<apm-api-event-example>>

include::./api-metadata.asciidoc[]
include::./api-transaction.asciidoc[]
Expand Down
14 changes: 7 additions & 7 deletions docs/en/observability/apm/api-info.asciidoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[[api-info]]
[[apm-api-info]]
=== APM Server information API

The APM Server exposes an API endpoint to query general server information.
This lightweight endpoint is useful as a server up/down health check.

[float]
[[api-info-endpoint]]
[[apm-api-info-endpoint]]
=== Server Information endpoint

This is the server information endpoint:
Expand All @@ -19,15 +19,15 @@ Sending an `HTTP GET` or `HTTP POST` request to the server information endpoint
will return an HTTP 200, indicating that the server is up.

To configure authenticated access to the APM server,
the instructions at <<api-key,APM API key>> or <<secret-token,APM Secret Token>>,
the instructions at <<apm-api-key,APM API key>> or <<apm-secret-token,APM Secret Token>>,
must be followed to configure the correct permissions for APM access.

If an <<api-key>> or a <<secret-token>> is passed along with
If an <<apm-api-key>> or a <<apm-secret-token>> is passed along with
the `HTTP GET` or `HTTP POST` request, in addition to an HTTP 200,
the response payload will include some information about the APM server.

[float]
[[api-info-example-get-without-credentials]]
[[apm-api-info-example-get-without-credentials]]
==== Example: GET, without credentials

Example APM Server status request with GET, without credentials:
Expand All @@ -54,10 +54,10 @@ curl --verbose -X GET http://127.0.0.1:8200
---------------------------------------------------------------------------

[float]
[[api-info-example-post-with-secret-token]]
[[apm-api-info-example-post-with-secret-token]]
==== Example: POST, with secret token

Example APM Server information request with POST, with a <<secret-token>>:
Example APM Server information request with POST, with a <<apm-secret-token>>:

["source","sh",subs="attributes"]
---------------------------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/en/observability/apm/api-jaeger.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[api-jaeger]]
[[apm-api-jaeger]]
=== Jaeger event intake

Elastic APM natively supports Jaeger, an open-source, distributed tracing system.
<<jaeger-integration,Learn more>>.
<<apm-jaeger-integration,Learn more>>.

**Jaeger/gRPC paths**

Expand Down
Loading

0 comments on commit c60b759

Please sign in to comment.