Skip to content
Merged
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
Binary file removed solutions/images/observability-help-icon.png
Binary file not shown.
1 change: 1 addition & 0 deletions solutions/images/observability-help-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
6 changes: 6 additions & 0 deletions solutions/images/observability-transaction-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion solutions/observability/apm/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,6 @@ APM Server provides a command line interface for creating, retrieving, invalidat
| `manage_own_api_key` | Allow APM Server to create, retrieve, and invalidate API keys |

2. Depending on what the **API key role** will be used for, also assign the appropriate `apm` application-level privileges:

* To **receive Agent configuration**, assign `config_agent:read`.
* To **ingest agent data**, assign `event:write`.
* To **upload source maps**, assign `sourcemap:write`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ apm-server apikey SUBCOMMAND [FLAGS]
| `manage_own_api_key` | Allow APM Server to create, retrieve, and invalidate API keys |

2. Depending on what the **API key role** will be used for, also assign the appropriate `apm` application-level privileges:

* To **receive Agent configuration**, assign `config_agent:read`.
* To **ingest agent data**, assign `event:write`.
* To **upload source maps**, assign `sourcemap:write`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,7 @@ tar xzvf apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz
$$$apm-installing-on-windows$$$
**Windows:**

1. Download the APM Server Windows zip file from the
https://www.elastic.co/downloads/apm/apm-server[downloads page].
1. Download the APM Server Windows zip file from the [downloads page](https://www.elastic.co/downloads/apm/apm-server).

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

Expand Down
5 changes: 2 additions & 3 deletions solutions/observability/apm/get-started-serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,10 +182,9 @@ To send APM data to Elastic, you must install an APM agent and configure it to s

If you can’t find your distribution, you can install the agent by building it from the source. The following instructions will build the APM agent using the same docker environment that Elastic uses to build our official packages.

::::{note}
```{note}
The agent is currently only available for Linux operating system.

::::
```

1. Download the [agent source](https://github.com/elastic/apm-agent-php/).
2. Execute the following commands to build the agent and install it:
Expand Down
13 changes: 8 additions & 5 deletions solutions/observability/apm/installation-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ View the installation layout and default paths for both Fleet-managed APM Server
: Main {{agent}} {{fleet}} encrypted configuration

`/Library/Elastic/Agent/data/elastic-agent-*/logs/elastic-agent.ndjson`
: Log files for {{agent}} and {{beats}} shippers <sup class="footnote" id="_footnote_lognumbering">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)

`/usr/bin/elastic-agent`
: Shell wrapper installed into PATH
Expand All @@ -45,7 +45,7 @@ You can install {{agent}} in a custom base path other than `/Library`. When ins
: Main {{agent}} {{fleet}} encrypted configuration

`/opt/Elastic/Agent/data/elastic-agent-*/logs/elastic-agent.ndjson`
: Log files for {{agent}} and {{beats}} shippers <sup class="footnoteref">[<a class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)

`/usr/bin/elastic-agent`
: Shell wrapper installed into PATH
Expand All @@ -64,7 +64,7 @@ You can install {{agent}} in a custom base path other than `/opt`. When install
: Main {{agent}} {{fleet}} encrypted configuration

`C:\Program Files\Elastic\Agent\data\elastic-agent-*\logs\elastic-agent.ndjson`
: Log files for {{agent}} and {{beats}} shippers <sup class="footnoteref">[<a class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)

You can install {{agent}} in a custom base path other than `C:\Program Files`. When installing {{agent}} with the `.\elastic-agent.exe install` command, use the `--base-path` CLI option to specify the custom base path.
::::::
Expand All @@ -80,7 +80,7 @@ You can install {{agent}} in a custom base path other than `C:\Program Files`.
: Main {{agent}} {{fleet}} encrypted configuration

`/var/lib/elastic-agent/data/elastic-agent-*/logs/elastic-agent.ndjson`
: Log files for {{agent}} and {{beats}} shippers <sup class="footnoteref">[<a class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)

`/usr/bin/elastic-agent`
: Shell wrapper installed into PATH
Expand All @@ -97,7 +97,7 @@ You can install {{agent}} in a custom base path other than `C:\Program Files`.
: Main {{agent}} {{fleet}} encrypted configuration

`/var/lib/elastic-agent/data/elastic-agent-*/logs/elastic-agent.ndjson`
: Log files for {{agent}} and {{beats}} shippers <sup class="footnoteref">[<a class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup>
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)

`/usr/bin/elastic-agent`
: Shell wrapper installed into PATH
Expand Down Expand Up @@ -150,3 +150,6 @@ For the deb and rpm distributions, these paths are set in the init script or in
::::::

:::::::

$$$footnote-1$$$
¹ Logs file names end with a date (`YYYYMMDD`) and optional number: `elastic-agent-YYYYMMDD.ndjson`, `elastic-agent-YYYYMMDD-1.ndjson`, and so on as new files are created during rotation.
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ Go to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs
:alt: scale APM
:::

Congratulations -- you now have the latest and greatest in Elastic APM!
Congratulations  you now have the latest and greatest in Elastic APM!
2 changes: 1 addition & 1 deletion solutions/observability/apm/trace-sample-timeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ As application architectures are shifting from monolithic to more distributed, s
:screenshot:
:::

Don’t forget; by definition, a distributed trace includes more than one transaction. When viewing distributed traces in the timeline waterfall, you’ll see this icon: ![APM icon](/solutions/images/observability-transaction-icon.png ""), which indicates the next transaction in the trace. For easier problem isolation, transactions can be collapsed in the waterfall by clicking the icon to the left of the transactions. Transactions can also be expanded and viewed in detail by clicking on them.
Don’t forget; by definition, a distributed trace includes more than one transaction. When viewing distributed traces in the timeline waterfall, you’ll see this icon: ![APM icon](/solutions/images/observability-transaction-icon.svg), which indicates the next transaction in the trace. For easier problem isolation, transactions can be collapsed in the waterfall by clicking the icon to the left of the transactions. Transactions can also be expanded and viewed in detail by clicking on them.

After exploring these traces, you can return to the full trace by clicking **View full trace**.

Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apm/transaction-sampling.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ stack:
serverless:
```

A sampled trace retains all data associated with it. A non-sampled trace drops all [span](/solutions/observability/apm/spans.md) and [transaction](/solutions/observability/apm/transactions.md) data1. Regardless of the sampling decision, all traces retain [error](/solutions/observability/apm/errors.md) data.
A sampled trace retains all data associated with it. A non-sampled trace drops all [span](/solutions/observability/apm/spans.md) and [transaction](/solutions/observability/apm/transactions.md) data.[¹](#footnote-1) Regardless of the sampling decision, all traces retain [error](/solutions/observability/apm/errors.md) data.

Some visualizations in the {{apm-app}}, like latency, are powered by aggregated transaction and span [metrics](/solutions/observability/apm/metrics.md). The way these metrics are calculated depends on the sampling method used:

Expand All @@ -207,7 +207,7 @@ For all sampling methods, metrics are weighted by the inverse sampling rate of t

These calculation methods ensure that the APM app provides the most accurate metrics possible given the sampling strategy in use, while also accounting for the head-based sampling rate to estimate the full population of traces.

1 Real User Monitoring (RUM) traces are an exception to this rule. The {{kib}} apps that utilize RUM data depend on transaction events, so non-sampled RUM traces retain transaction data — only span data is dropped.
¹ $$$footnote-1$$$ Real User Monitoring (RUM) traces are an exception to this rule. The {{kib}} apps that utilize RUM data depend on transaction events, so non-sampled RUM traces retain transaction data — only span data is dropped.

## Sample rates [_sample_rates]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,9 @@ PS > cd 'C:\Program Files\Filebeat'
PS C:\Program Files\Filebeat> .\install-service-filebeat.ps1
```

NOTE: If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-filebeat.ps1`.
```{note}
If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-filebeat.ps1`.
```
::::::

:::::::
Expand Down Expand Up @@ -1134,7 +1136,9 @@ tar xzvf metricbeat-{{stack-version}}-linux-x86_64.tar.gz
PS C:\Program Files\Metricbeat> .\install-service-metricbeat.ps1
```

NOTE: If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-metricbeat.ps1`.
```{note}
If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-metricbeat.ps1`.
```
::::::

:::::::
Expand Down Expand Up @@ -1760,7 +1764,9 @@ tar xzvf heartbeat-{{stack-version}}-linux-x86_64.tar.gz
PS C:\Program Files\Heartbeat> .\install-service-heartbeat.ps1
```

NOTE: If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-heartbeat.ps1`.
```{note}
If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: `PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-heartbeat.ps1`.
```
::::::

:::::::
Expand Down
Loading
Loading