Skip to content

Commit 86fb6fb

Browse files
committed
add version badges to APM server docs
1 parent 38fcbab commit 86fb6fb

39 files changed

+127
-62
lines changed

solutions/observability/apps/apm-agent-authorization.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/apm-agent-auth.html
4+
applies_to:
5+
stack: all
46
---
57

68
# APM agent authorization [apm-agent-auth]
@@ -92,7 +94,7 @@ Authorization token for sending APM data. The same token must also be set in eac
9294

9395
## `auth.api_key.elasticsearch.*` configuration options [_auth_api_key_elasticsearch_configuration_options]
9496

95-
::::{admonition}
97+
::::{note}
9698
![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "")
9799

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

solutions/observability/apps/apm-server-advanced-setup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
navigation_title: "Advanced setup"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-setting-up-and-running.html
5+
applies_to:
6+
stack: all
57
---
68

79

solutions/observability/apps/apm-server-binary.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/get-started-with-apm-server-binary.html
4+
applies_to:
5+
stack: all
46
---
57

68
# APM Server binary [get-started-with-apm-server-binary]

solutions/observability/apps/apm-server-command-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
navigation_title: "Command reference"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-command-line-options.html
5+
applies_to:
6+
stack: all
57
---
68

79

solutions/observability/apps/apm-server-systemd.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/apm-running-with-systemd.html
4+
applies_to:
5+
stack: all
46
---
57

68
# APM Server and systemd [apm-running-with-systemd]
79

8-
::::{important}
10+
::::{important}
911
These commands only apply to the APM Server binary installation method. Fleet-managed users should see [Start and stop {{agent}}s on edge hosts](asciidocalypse://docs/docs-content/docs/reference/ingestion-tools/fleet/start-stop-elastic-agent.md).
1012
::::
1113

@@ -15,7 +17,7 @@ The DEB and RPM packages include a service unit for Linux systems with systemd.
1517
We recommend that the apm-server process is run as a non-root user. Therefore, that is the default setup for APM Server’s DEB package and RPM installation.
1618

1719

18-
## Start and stop APM Server [_start_and_stop_apm_server]
20+
## Start and stop APM Server [_start_and_stop_apm_server]
1921

2022
Use `systemctl` to start or stop APM Server:
2123

@@ -38,7 +40,7 @@ sudo systemctl disable apm-server
3840
```
3941

4042

41-
## APM Server status and logs [_apm_server_status_and_logs]
43+
## APM Server status and logs [_apm_server_status_and_logs]
4244

4345
To get the service status, use `systemctl`:
4446

@@ -53,7 +55,7 @@ journalctl -u apm-server.service
5355
```
5456

5557

56-
## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server]
58+
## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server]
5759

5860
The systemd service unit file includes environment variables that you can override to change the default options.
5961

@@ -63,7 +65,7 @@ The systemd service unit file includes environment variables that you can overri
6365
| `BEAT_CONFIG_OPTS` | Flags for configuration file path | ``-c /etc/apm-server/apm-server.yml`` |
6466
| `BEAT_PATH_OPTS` | Other paths | ``-path.home /usr/share/apm-server -path.config /etc/apm-server -path.data /var/lib/apm-server -path.logs /var/log/apm-server`` |
6567

66-
::::{note}
68+
::::{note}
6769
You can use `BEAT_LOG_OPTS` to set debug selectors for logging. However, to configure logging behavior, set the logging options described in [Configure logging](configure-logging.md).
6870
::::
6971

@@ -84,13 +86,13 @@ systemctl daemon-reload
8486
systemctl restart apm-server
8587
```
8688

87-
::::{note}
89+
::::{note}
8890
It is recommended that you use a configuration management tool to include drop-in unit files. If you need to add a drop-in manually, use `systemctl edit apm-server.service`.
8991
::::
9092

9193

9294

93-
#### Configuration file ownership [apm-config-file-ownership]
95+
#### Configuration file ownership [apm-config-file-ownership]
9496

9597
On systems with POSIX file permissions, the APM Server configuration file is subject to ownership and file permission checks. These checks prevent unauthorized users from providing or modifying configurations that are run by APM Server.
9698

@@ -118,7 +120,7 @@ can only be writable by the owner but the permissions are "-rw-rw-r--"
118120
To correct this problem, use `chmod go-w /etc/apm-server/apm-server.yml` to remove write privileges from anyone other than the owner.
119121

120122

121-
##### Disabling strict permission checks [_disabling_strict_permission_checks]
123+
##### Disabling strict permission checks [_disabling_strict_permission_checks]
122124

123125
You can disable strict permission checks from the command line by using `--strict.perms=false`, but we strongly encourage you to leave the checks enabled.
124126

solutions/observability/apps/configure-anonymous-authentication.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
navigation_title: "Anonymous authentication"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-configuration-anonymous.html
5+
applies_to:
6+
stack: all
57
---
68

79

810

911
# Configure anonymous authentication [apm-configuration-anonymous]
1012

1113

12-
::::{admonition}
14+
::::{note}
1315
![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "")
1416

1517
Most options on this page are supported by all APM Server deployment methods.

solutions/observability/apps/configure-apm-agent-central-configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
navigation_title: "APM agent central configuration"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-configure-agent-config.html
5+
applies_to:
6+
stack: all
57
---
68

79

810

911
# Configure APM agent central configuration [apm-configure-agent-config]
1012

1113

12-
::::{admonition}
14+
::::{note}
1315
![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "")
1416

1517
APM agent central configuration is supported by all APM Server deployment methods, but some options are only supported for APM Server binary users.

solutions/observability/apps/configure-apm-instrumentation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
navigation_title: "Instrumentation"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-configuration-instrumentation.html
5+
applies_to:
6+
stack: all
57
---
68

79

810

911
# Configure APM instrumentation [apm-configuration-instrumentation]
1012

1113

12-
::::{admonition}
14+
::::{note}
1315
![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "")
1416

1517
Instrumentation of APM Server is not yet supported for Fleet-managed APM.

solutions/observability/apps/configure-apm-server.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/cloud/current/ec-manage-apm-settings.html
44
- https://www.elastic.co/guide/en/observability/current/apm-configuring-howto-apm-server.html
5+
applies_to:
6+
stack: all
57
---
68

79
# Configure APM Server [apm-configuring-howto-apm-server]

solutions/observability/apps/configure-console-output.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
navigation_title: "Console"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-console-output.html
5+
applies_to:
6+
stack: all
57
---
68

79

810

911
# Configure the Console output [apm-console-output]
1012

1113

12-
::::{admonition}
14+
::::{note}
1315
![supported deployment methods](../../../images/observability-binary-yes-fm-no.svg "")
1416

1517
The Console output is not yet supported by {{fleet}}-managed APM Server.

0 commit comments

Comments
 (0)