Skip to content

Commit 9459f8f

Browse files
[observability] Spot check rendering/syntax issues (#1078)
Spot checks rendering/syntax issues in Solutions → Observability.
1 parent 6f9449d commit 9459f8f

File tree

97 files changed

+520
-503
lines changed

Some content is hidden

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

97 files changed

+520
-503
lines changed
-985 Bytes
Binary file not shown.
Loading
Binary file not shown.
Loading

solutions/observability/apm/api-keys.md

-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,6 @@ APM Server provides a command line interface for creating, retrieving, invalidat
199199
| `manage_own_api_key` | Allow APM Server to create, retrieve, and invalidate API keys |
200200

201201
2. Depending on what the **API key role** will be used for, also assign the appropriate `apm` application-level privileges:
202-
203202
* To **receive Agent configuration**, assign `config_agent:read`.
204203
* To **ingest agent data**, assign `event:write`.
205204
* To **upload source maps**, assign `sourcemap:write`.

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

-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ apm-server apikey SUBCOMMAND [FLAGS]
7575
| `manage_own_api_key` | Allow APM Server to create, retrieve, and invalidate API keys |
7676

7777
2. Depending on what the **API key role** will be used for, also assign the appropriate `apm` application-level privileges:
78-
7978
* To **receive Agent configuration**, assign `config_agent:read`.
8079
* To **ingest agent data**, assign `event:write`.
8180
* To **upload source maps**, assign `sourcemap:write`.

solutions/observability/apm/get-started-apm-server-binary.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,7 @@ tar xzvf apm-server-{{apm_server_version}}-darwin-x86_64.tar.gz
6767
$$$apm-installing-on-windows$$$
6868
**Windows:**
6969

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

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

solutions/observability/apm/get-started-serverless.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,9 @@ To send APM data to Elastic, you must install an APM agent and configure it to s
182182

183183
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.
184184

185-
::::{note}
185+
```{note}
186186
The agent is currently only available for Linux operating system.
187-
188-
::::
187+
```
189188

190189
1. Download the [agent source](https://github.com/elastic/apm-agent-php/).
191190
2. Execute the following commands to build the agent and install it:

solutions/observability/apm/installation-layout.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ View the installation layout and default paths for both Fleet-managed APM Server
2626
: Main {{agent}} {{fleet}} encrypted configuration
2727

2828
`/Library/Elastic/Agent/data/elastic-agent-*/logs/elastic-agent.ndjson`
29-
: 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>
29+
: Log files for {{agent}} and {{beats}} shippers[¹](#footnote-1)
3030

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

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

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

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

6969
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.
7070
::::::
@@ -80,7 +80,7 @@ You can install {{agent}} in a custom base path other than `C:\Program Files`.
8080
: Main {{agent}} {{fleet}} encrypted configuration
8181

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

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

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

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

152152
:::::::
153+
154+
$$$footnote-1$$$
155+
¹ 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.

solutions/observability/apm/switch-an-elastic-cloud-cluster-to-apm-integration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ Go to the [{{ecloud}} Console](https://cloud.elastic.co?page=docs&placement=docs
5353
:alt: scale APM
5454
:::
5555

56-
Congratulations -- you now have the latest and greatest in Elastic APM!
56+
Congratulations  you now have the latest and greatest in Elastic APM!

solutions/observability/apm/trace-sample-timeline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ As application architectures are shifting from monolithic to more distributed, s
5555
:screenshot:
5656
:::
5757

58-
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.
58+
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.
5959

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

solutions/observability/apm/transaction-sampling.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ stack:
195195
serverless:
196196
```
197197

198-
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.
198+
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.
199199

200200
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:
201201

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

208208
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.
209209

210-
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.
210+
¹ $$$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.
211211

212212
## Sample rates [_sample_rates]
213213

solutions/observability/applications/tutorial-monitor-java-application.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,9 @@ PS > cd 'C:\Program Files\Filebeat'
408408
PS C:\Program Files\Filebeat> .\install-service-filebeat.ps1
409409
```
410410

411-
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`.
411+
```{note}
412+
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`.
413+
```
412414
::::::
413415

414416
:::::::
@@ -1134,7 +1136,9 @@ tar xzvf metricbeat-{{stack-version}}-linux-x86_64.tar.gz
11341136
PS C:\Program Files\Metricbeat> .\install-service-metricbeat.ps1
11351137
```
11361138
1137-
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`.
1139+
```{note}
1140+
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`.
1141+
```
11381142
::::::
11391143
11401144
:::::::
@@ -1760,7 +1764,9 @@ tar xzvf heartbeat-{{stack-version}}-linux-x86_64.tar.gz
17601764
PS C:\Program Files\Heartbeat> .\install-service-heartbeat.ps1
17611765
```
17621766
1763-
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`.
1767+
```{note}
1768+
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`.
1769+
```
17641770
::::::
17651771
17661772
:::::::

0 commit comments

Comments
 (0)