Skip to content

Commit 02a6ecd

Browse files
mdbirnstiehlmdbirnstiehl
authored
Fix Observability APM formatting issues (#585)
1 parent b388a78 commit 02a6ecd

File tree

100 files changed

+449
-430
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+449
-430
lines changed

‎images/observability-apm-help-me-decide.svg

Lines changed: 47 additions & 0 deletions
Loading

‎solutions/observability/apps/analyze-monitors.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/analyze-monitors.html
4+
applies_to:
5+
stack: all
46
---
57

68
# Analyze monitors [analyze-monitors]

‎solutions/observability/apps/analyze.md

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

79

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

Lines changed: 4 additions & 2 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-agent-auth.html
4+
applies_to:
5+
stack: all
46
---
57

68
# APM agent authorization [apm-agent-auth]
79

8-
::::{admonition}
10+
::::{note}
911
![supported deployment methods](../../../images/observability-binary-yes-fm-yes.svg "")
1012

1113
Most options in this section are supported by all APM Server deployment methods.
@@ -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-agent-central-configuration.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,14 @@
22
navigation_title: "Centrally configure APM agents in Kibana"
33
mapped_pages:
44
- https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html
5+
applies_to:
6+
stack: all
57
---
68

79

810

911
# APM agent central configuration [apm-agent-configuration]
1012

11-
12-
::::{note}
13-
APM agent central configuration is *not* compatible with [{{serverless-full}}](https://docs.elastic.co/serverless).
14-
15-
::::
16-
17-
1813
APM Agent configuration allows you to fine-tune your APM agent configuration from within the Applications UI. Changes are automatically propagated to your APM agents, so there’s no need to redeploy.
1914

2015
To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents have applied your configurations.

‎solutions/observability/apps/apm-agent-explorer.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
---
2-
navigation_title: "Identify deployment details for APM agents"
32
mapped_pages:
43
- https://www.elastic.co/guide/en/observability/current/apm-agent-explorer.html
4+
applies_to:
5+
stack: all
56
---
67

7-
8-
98
# APM Agent explorer [apm-agent-explorer]
109

1110

12-
::::{warning}
11+
::::{important}
1312
This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
1413
::::
1514

‎solutions/observability/apps/apm-k8s-attacher.md

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

79

‎solutions/observability/apps/apm-reader-user.md

Lines changed: 31 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,18 @@ mapped_pages:
1212
APM reader users typically need to view the Applications UI and dashboards and visualizations that use APM data. These users might also need to create and edit dashboards, visualizations, and machine learning jobs.
1313

1414

15-
## APM reader [apm-app-reader-full]
15+
## APM reader [apm-app-reader-full]
1616

1717
To create an APM reader user:
1818

1919
1. Create a new role, named something like `read-apm`, and assign the following privileges:
2020

21-
<div class="tabs" data-tab-group="apm-app-reader">
22-
<div role="tablist" aria-label="Applications UI reader">
23-
<button role="tab"
24-
aria-selected="true"
25-
aria-controls="data-streams-tab"
26-
id="data-streams">
27-
Data streams
28-
</button>
29-
<button role="tab"
30-
aria-selected="false"
31-
aria-controls="classic-indices-tab"
32-
id="classic-indices"
33-
tabindex="-1">
34-
Classic APM indices
35-
</button>
36-
</div>
37-
<div tabindex="0"
38-
role="tabpanel"
39-
id="data-streams-tab"
40-
aria-labelledby="data-streams">
21+
::::{tab-set}
22+
:group: datastreams-classic
23+
24+
:::{tab-item} Data streams
25+
:sync: datastreams
26+
4127
| Type | Privilege | Purpose |
4228
| --- | --- | --- |
4329
| Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data |
@@ -47,19 +33,19 @@ To create an APM reader user:
4733
| Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data |
4834
| Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata |
4935

50-
</div>
51-
<div tabindex="0"
52-
role="tabpanel"
53-
id="classic-indices-tab"
54-
aria-labelledby="classic-indices"
55-
hidden="">
36+
:::
37+
38+
:::{tab-item} Classic APM indices
39+
:sync: classic
40+
5641
| Type | Privilege | Purpose |
5742
| --- | --- | --- |
5843
| Index | `read` on `apm-*` | Read-only access to `apm-*` data |
5944
| Index | `view_index_metadata` on `apm-*` | Read-only access to `apm-*` index metadata |
6045

61-
</div>
62-
</div>
46+
:::
47+
48+
::::
6349

6450
2. Assign the `read-apm` role created in the previous step, and the following built-in roles to any APM reader users:
6551

@@ -70,32 +56,18 @@ To create an APM reader user:
7056

7157

7258

73-
## Partial APM reader [apm-app-reader-partial]
59+
## Partial APM reader [apm-app-reader-partial]
7460

7561
In some instances, you may wish to restrict certain Kibana apps that a user has access to.
7662

7763
1. Create a new role, named something like `read-apm-partial`, and assign the following privileges:
7864

79-
<div class="tabs" data-tab-group="apm-app-reader">
80-
<div role="tablist" aria-label="Applications UI reader">
81-
<button role="tab"
82-
aria-selected="true"
83-
aria-controls="data-streams-tab"
84-
id="data-streams">
85-
Data streams
86-
</button>
87-
<button role="tab"
88-
aria-selected="false"
89-
aria-controls="classic-indices-tab"
90-
id="classic-indices"
91-
tabindex="-1">
92-
Classic APM indices
93-
</button>
94-
</div>
95-
<div tabindex="0"
96-
role="tabpanel"
97-
id="data-streams-tab"
98-
aria-labelledby="data-streams">
65+
::::{tab-set}
66+
:group: datastreams-classic
67+
68+
:::{tab-item} Data streams
69+
:sync: datastreams
70+
9971
| Type | Privilege | Purpose |
10072
| --- | --- | --- |
10173
| Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data |
@@ -105,19 +77,20 @@ In some instances, you may wish to restrict certain Kibana apps that a user has
10577
| Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data |
10678
| Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata |
10779

108-
</div>
109-
<div tabindex="0"
110-
role="tabpanel"
111-
id="classic-indices-tab"
112-
aria-labelledby="classic-indices"
113-
hidden="">
80+
:::
81+
82+
:::{tab-item} Classic APM indices
83+
:sync: classic
84+
11485
| Type | Privilege | Purpose |
11586
| --- | --- | --- |
11687
| Index | `read` on `apm-*` | Read-only access to `apm-*` data |
11788
| Index | `view_index_metadata` on `apm-*` | Read-only access to `apm-*` index metadata |
11889

119-
</div>
120-
</div>
90+
:::
91+
92+
::::
93+
12194

12295
2. Assign feature privileges to any Kibana feature that the user needs access to. Here are two examples:
12396

‎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: 29 additions & 5 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]
@@ -36,27 +38,49 @@ To download and install APM Server, use the commands below that work with your s
3638
$$$apm-deb$$$
3739
**deb:**
3840

39-
Version 9.0.0 of APM Server has not yet been released.
41+
```shell
42+
curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-amd64.deb
43+
sudo dpkg -i apm-server-{{apm_server_version}}-amd64.deb
44+
```
4045

4146
$$$apm-rpm$$$
4247
**RPM:**
4348

44-
Version 9.0.0 of APM Server has not yet been released.
49+
```shell
50+
curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-x86_64.rpm
51+
sudo rpm -vi apm-server-{{apm_server_version}}-x86_64.rpm
52+
```
4553

4654
$$$apm-linux$$$
4755
**Other Linux:**
4856

49-
Version 9.0.0 of APM Server has not yet been released.
57+
```shell
58+
curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-linux-x86_64.tar.gz
59+
tar xzvf apm-server-{{apm_server_version}}-linux-x86_64.tar.gz
60+
```
5061

5162
$$$apm-mac$$$
5263
**Mac:**
5364

54-
Version 9.0.0 of APM Server has not yet been released.
65+
```shell
66+
curl -L -O https://artifacts.elastic.co/downloads/apm-server/apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz
67+
tar xzvf apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz
68+
```
5569

5670
$$$apm-installing-on-windows$$$
5771
**Windows:**
5872

59-
Version 9.0.0 of APM Server has not yet been released.
73+
1. Download the APM Server Windows zip file from the
74+
https://www.elastic.co/downloads/apm/apm-server[downloads page].
75+
76+
1. Extract the contents of the zip file into `C:\Program Files`.
77+
78+
1. Rename the `apm-server-<version>-windows` directory to `APM-Server`.
79+
80+
1. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select *Run As Administrator*).
81+
If you are running Windows XP, you may need to download and install PowerShell.
82+
83+
1. From the PowerShell prompt, run the following commands to install APM Server as a Windows service:
6084

6185
$$$apm-docker$$$
6286
**Docker:**

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

Lines changed: 3 additions & 1 deletion
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

@@ -71,7 +73,7 @@ apm-server apikey SUBCOMMAND [FLAGS]
7173

7274
The user requesting to create an API Key needs to have APM privileges used by the APM Server. A superuser, by default, has these privileges.
7375

74-
::::{dropdown} **Expand for more information on assigning these privileges to other users**
76+
::::{dropdown} Expand for more information on assigning these privileges to other users
7577
To create an APM Server user with the required privileges for creating and managing API keys:
7678

7779
1. Create an **API key role**, called something like `apm_api_key`, that has the following `cluster` level privileges:

‎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

0 commit comments

Comments
 (0)