Skip to content

apm: Update config documentation and examples to be consistent #2038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions solutions/observability/apm/apm-agent-authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,11 @@ Agent authorization APM Server configuration options.

```yaml
apm-server:
host: "localhost:8200"
rum:
enabled: true

output:
elasticsearch:
hosts: ElasticsearchAddress:9200

max_procs: 4
auth:
api_key:
enabled: true
limit: 100
token: "your_secret_token"
```
::::::

Expand Down Expand Up @@ -63,7 +59,7 @@ Enable API key authorization by setting `enabled` to `true`. By default, `enable

| | |
| --- | --- |
| APM Server binary | `auth.api_key.enabled` |
| APM Server binary | `apm-server.auth.api_key.enabled` |
| Fleet-managed | `API key for agent authentication` |

::::{tip}
Expand All @@ -76,7 +72,7 @@ Each unique API key triggers one request to {{es}}. This setting restricts the n

| | |
| --- | --- |
| APM Server binary | `auth.api_key.limit` |
| APM Server binary | `apm-server.auth.api_key.limit` |
| Fleet-managed | `Number of keys` |

### Secret token [_secret_token]
Expand All @@ -85,17 +81,17 @@ Authorization token for sending APM data. The same token must also be set in eac

| | |
| --- | --- |
| APM Server binary | `auth.api_key.token` |
| APM Server binary | `apm-server.auth.api_key.token` |
| Fleet-managed | `Secret token` |

## `auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options]
## `apm-server.auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options]

::::{note}
![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")

The below options are only supported by the APM Server binary.

All of the `auth.api_key.elasticsearch.*` configurations are optional. If none are set, configuration settings from the `apm-server.output` section will be reused.
All of the `apm-server.auth.api_key.elasticsearch.*` configurations are optional. If none are set, configuration settings from the `apm-server.output` section will be reused.

::::

Expand All @@ -119,7 +115,7 @@ The URL of the proxy to use when connecting to the {{es}} servers. The value may

The HTTP request timeout in seconds for the {{es}} request. If nothing is configured, configuration settings from the `output` section will be reused.

## `auth.api_key.elasticsearch.ssl.*` configuration options [_auth_api_key_elasticsearch_ssl_configuration_options]
## `apm-server.auth.api_key.elasticsearch.ssl.*` configuration options [_auth_api_key_elasticsearch_ssl_configuration_options]

SSL is off by default. Set `elasticsearch.protocol` to `https` if you want to enable `https`.

Expand All @@ -133,7 +129,7 @@ Configure SSL verification mode. If `none` is configured, all server hosts and c

### `elasticsearch.ssl.supported_protocols` [_elasticsearch_ssl_supported_protocols]

List of supported/valid TLS versions. By default, all TLS versions from 1.0 to 1.2 are enabled.
List of supported/valid TLS versions. The default value is `[TLSv1.1, TLSv1.2, TLSv1.3]`.

### `elasticsearch.ssl.certificate_authorities` [_elasticsearch_ssl_certificate_authorities]

Expand Down
26 changes: 13 additions & 13 deletions solutions/observability/apm/tail-based-sampling.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ Tail-based sampling configuration options.

```yaml
apm-server:
host: "localhost:8200"
rum:
enabled: true

output:
elasticsearch:
hosts: ElasticsearchAddress:9200

max_procs: 4
sampling:
tail:
enabled: true
interval: 1m
storage_limit: 0GB
policies:
- sample_rate: 1.0
trace.outcome: failure
- sample_rate: 0.1
```
::::::

Expand All @@ -62,7 +62,7 @@ Set to `true` to enable tail based sampling. Disabled by default. (bool)

| | |
| --- | --- |
| APM Server binary | `sampling.tail.enabled` |
| APM Server binary | `apm-server.sampling.tail.enabled` |
| Fleet-managed | `Enable tail-based sampling` |

### Interval [sampling-tail-interval-ref]
Expand All @@ -71,7 +71,7 @@ Synchronization interval for multiple APM Servers. Should be in the order of ten

| | |
| --- | --- |
| APM Server binary | `sampling.tail.interval` |
| APM Server binary | `apm-server.sampling.tail.interval` |
| Fleet-managed | `Interval` |

### Policies [sampling-tail-policies-ref]
Expand All @@ -82,7 +82,7 @@ Policies map trace events to a sample rate. Each policy must specify a sample ra

| | |
| --- | --- |
| APM Server binary | `sampling.tail.policies` |
| APM Server binary | `apm-server.sampling.tail.policies` |
| Fleet-managed | `Policies` |

### Storage limit [sampling-tail-storage_limit-ref]
Expand All @@ -99,7 +99,7 @@ Default: `0GB`. (text)

| | |
| --- | --- |
| APM Server binary | `sampling.tail.storage_limit` |
| APM Server binary | `apm-server.sampling.tail.storage_limit` |
| Fleet-managed | `Storage limit` |

## Policy-level tail-based sampling settings [apm-configuration-tbs-policy]
Expand Down
Loading