Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
919a653
fix decision tree
mdbirnstiehl Feb 24, 2025
8a7a912
fix dropdown heading
mdbirnstiehl Feb 24, 2025
09930c5
fix dropdown menu
mdbirnstiehl Feb 24, 2025
97b148b
fix tip
mdbirnstiehl Feb 24, 2025
2d63c94
fix install commands
mdbirnstiehl Feb 24, 2025
dd7bd48
update code block
mdbirnstiehl Feb 24, 2025
7517941
fix download commands
mdbirnstiehl Feb 24, 2025
a230c7e
fix command formatting
mdbirnstiehl Feb 25, 2025
d7b2180
fix formatting
mdbirnstiehl Feb 25, 2025
07547f1
clean up formatting
mdbirnstiehl Feb 25, 2025
4caca24
fix transactions formatting
mdbirnstiehl Feb 25, 2025
4e665c3
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 25, 2025
a848b4d
update formatting
mdbirnstiehl Feb 25, 2025
8cf770d
fix formatting
mdbirnstiehl Feb 25, 2025
fe3d425
fix tabs
mdbirnstiehl Feb 25, 2025
52ce8fa
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 25, 2025
9e7a2e7
fix formatting
mdbirnstiehl Feb 25, 2025
8332f14
fix tabs
mdbirnstiehl Feb 25, 2025
38fcbab
fix tabs
mdbirnstiehl Feb 25, 2025
86fb6fb
add version badges to APM server docs
mdbirnstiehl Feb 25, 2025
e38189d
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 25, 2025
1e45f95
add badges to uptime docs
mdbirnstiehl Feb 25, 2025
7aeea8d
fix asterisks
mdbirnstiehl Feb 25, 2025
8ec45da
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 26, 2025
6f869f3
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 26, 2025
a98e97a
Merge branch 'main' into fix-apps-formatting
mdbirnstiehl Feb 26, 2025
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
47 changes: 47 additions & 0 deletions images/observability-apm-help-me-decide.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions solutions/observability/apps/analyze-monitors.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/analyze-monitors.html
applies_to:
stack: all
---

# Analyze monitors [analyze-monitors]
Expand Down
2 changes: 2 additions & 0 deletions solutions/observability/apps/analyze.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "Analyze"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/uptime-analyze.html
applies_to:
stack: all
---


Expand Down
6 changes: 4 additions & 2 deletions solutions/observability/apps/apm-agent-authorization.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-agent-auth.html
applies_to:
stack: all
---

# APM agent authorization [apm-agent-auth]

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

Most options in this section are supported by all APM Server deployment methods.
Expand Down Expand Up @@ -92,7 +94,7 @@ Authorization token for sending APM data. The same token must also be set in eac

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

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

The below options are only supported by the APM Server binary.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,14 @@
navigation_title: "Centrally configure APM agents in Kibana"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-agent-configuration.html
applies_to:
stack: all
---



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


::::{note}
APM agent central configuration is *not* compatible with [{{serverless-full}}](https://docs.elastic.co/serverless).

::::


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.

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.
Expand Down
7 changes: 3 additions & 4 deletions solutions/observability/apps/apm-agent-explorer.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
navigation_title: "Identify deployment details for APM agents"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-agent-explorer.html
applies_to:
stack: all
---



# APM Agent explorer [apm-agent-explorer]


::::{warning}
::::{important}
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.
::::

Expand Down
2 changes: 2 additions & 0 deletions solutions/observability/apps/apm-k8s-attacher.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "Kubernetes"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-k8s-attacher.html
applies_to:
stack: all
---


Expand Down
89 changes: 31 additions & 58 deletions solutions/observability/apps/apm-reader-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,32 +12,18 @@ mapped_pages:
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.


## APM reader [apm-app-reader-full]
## APM reader [apm-app-reader-full]

To create an APM reader user:

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

<div class="tabs" data-tab-group="apm-app-reader">
<div role="tablist" aria-label="Applications UI reader">
<button role="tab"
aria-selected="true"
aria-controls="data-streams-tab"
id="data-streams">
Data streams
</button>
<button role="tab"
aria-selected="false"
aria-controls="classic-indices-tab"
id="classic-indices"
tabindex="-1">
Classic APM indices
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams">
::::{tab-set}
:group: datastreams-classic

:::{tab-item} Data streams
:sync: datastreams

| Type | Privilege | Purpose |
| --- | --- | --- |
| Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data |
Expand All @@ -47,19 +33,19 @@ To create an APM reader user:
| Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data |
| Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata |

</div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices"
hidden="">
:::

:::{tab-item} Classic APM indices
:sync: classic

| Type | Privilege | Purpose |
| --- | --- | --- |
| Index | `read` on `apm-*` | Read-only access to `apm-*` data |
| Index | `view_index_metadata` on `apm-*` | Read-only access to `apm-*` index metadata |

</div>
</div>
:::

::::

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

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



## Partial APM reader [apm-app-reader-partial]
## Partial APM reader [apm-app-reader-partial]

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

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

<div class="tabs" data-tab-group="apm-app-reader">
<div role="tablist" aria-label="Applications UI reader">
<button role="tab"
aria-selected="true"
aria-controls="data-streams-tab"
id="data-streams">
Data streams
</button>
<button role="tab"
aria-selected="false"
aria-controls="classic-indices-tab"
id="classic-indices"
tabindex="-1">
Classic APM indices
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams">
::::{tab-set}
:group: datastreams-classic

:::{tab-item} Data streams
:sync: datastreams

| Type | Privilege | Purpose |
| --- | --- | --- |
| Index | `read` on `logs-apm*` | Read-only access to `logs-apm*` data |
Expand All @@ -105,19 +77,20 @@ In some instances, you may wish to restrict certain Kibana apps that a user has
| Index | `read` on `traces-apm*` | Read-only access to `traces-apm*` data |
| Index | `view_index_metadata` on `traces-apm*` | Read-only access to `traces-apm*` index metadata |

</div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices"
hidden="">
:::

:::{tab-item} Classic APM indices
:sync: classic

| Type | Privilege | Purpose |
| --- | --- | --- |
| Index | `read` on `apm-*` | Read-only access to `apm-*` data |
| Index | `view_index_metadata` on `apm-*` | Read-only access to `apm-*` index metadata |

</div>
</div>
:::

::::


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

Expand Down
2 changes: 2 additions & 0 deletions solutions/observability/apps/apm-server-advanced-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "Advanced setup"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-setting-up-and-running.html
applies_to:
stack: all
---


Expand Down
34 changes: 29 additions & 5 deletions solutions/observability/apps/apm-server-binary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/get-started-with-apm-server-binary.html
applies_to:
stack: all
---

# APM Server binary [get-started-with-apm-server-binary]
Expand Down Expand Up @@ -36,27 +38,49 @@ To download and install APM Server, use the commands below that work with your s
$$$apm-deb$$$
**deb:**

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

$$$apm-rpm$$$
**RPM:**

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

$$$apm-linux$$$
**Other Linux:**

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

$$$apm-mac$$$
**Mac:**

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

$$$apm-installing-on-windows$$$
**Windows:**

Version 9.0.0 of APM Server has not yet been released.
1. Download the APM Server Windows zip file from the
https://www.elastic.co/downloads/apm/apm-server[downloads page].

1. Extract the contents of the zip file into `C:\Program Files`.

1. Rename the `apm-server-<version>-windows` directory to `APM-Server`.

1. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select *Run As Administrator*).
If you are running Windows XP, you may need to download and install PowerShell.

1. From the PowerShell prompt, run the following commands to install APM Server as a Windows service:

$$$apm-docker$$$
**Docker:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
navigation_title: "Command reference"
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-command-line-options.html
applies_to:
stack: all
---


Expand Down Expand Up @@ -71,7 +73,7 @@ apm-server apikey SUBCOMMAND [FLAGS]

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.

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

1. Create an **API key role**, called something like `apm_api_key`, that has the following `cluster` level privileges:
Expand Down
18 changes: 10 additions & 8 deletions solutions/observability/apps/apm-server-systemd.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/observability/current/apm-running-with-systemd.html
applies_to:
stack: all
---

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

::::{important}
::::{important}
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).
::::

Expand All @@ -15,7 +17,7 @@ The DEB and RPM packages include a service unit for Linux systems with systemd.
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.


## Start and stop APM Server [_start_and_stop_apm_server]
## Start and stop APM Server [_start_and_stop_apm_server]

Use `systemctl` to start or stop APM Server:

Expand All @@ -38,7 +40,7 @@ sudo systemctl disable apm-server
```


## APM Server status and logs [_apm_server_status_and_logs]
## APM Server status and logs [_apm_server_status_and_logs]

To get the service status, use `systemctl`:

Expand All @@ -53,7 +55,7 @@ journalctl -u apm-server.service
```


## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server]
## Customize systemd unit for APM Server [_customize_systemd_unit_for_apm_server]

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

Expand All @@ -63,7 +65,7 @@ The systemd service unit file includes environment variables that you can overri
| `BEAT_CONFIG_OPTS` | Flags for configuration file path | ``-c /etc/apm-server/apm-server.yml`` |
| `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`` |

::::{note}
::::{note}
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).
::::

Expand All @@ -84,13 +86,13 @@ systemctl daemon-reload
systemctl restart apm-server
```

::::{note}
::::{note}
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`.
::::



#### Configuration file ownership [apm-config-file-ownership]
#### Configuration file ownership [apm-config-file-ownership]

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.

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


##### Disabling strict permission checks [_disabling_strict_permission_checks]
##### Disabling strict permission checks [_disabling_strict_permission_checks]

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.

Loading