Skip to content

Commit e8c3387

Browse files
authored
[obs] Fix Logs docs formatting issues (#640)
1 parent 353cbd8 commit e8c3387

18 files changed

+128
-49
lines changed

solutions/observability/apps/api-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ APM Server provides a command line interface for creating, retrieving, invalidat
146146

147147
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.
148148

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

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

solutions/observability/logs/add-service-name-to-logs.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/observability/current/add-logs-service-name.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-add-logs-service-name.html
5+
applies_to:
6+
stack: all
7+
serverless: all
58
---
69

710
# Add a service name to logs [observability-add-logs-service-name]
@@ -42,7 +45,7 @@ For more on defining processors, refer to [define processors](asciidocalypse://d
4245

4346
For logs that with an existing field being used to represent the service name, map that field to the `service.name` field using the [alias field type](asciidocalypse://docs/elasticsearch/docs/reference/elasticsearch/mapping-reference/field-alias.md). Follow these steps to update your mapping:
4447

45-
1. find **Stack Management** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
48+
1. Find **Stack Management** in the main menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
4649
2. Select **Index Templates**.
4750
3. Search for the index template you want to update.
4851
4. From the **Actions** menu for that template, select **edit**.
@@ -58,13 +61,5 @@ For more ways to add a field to your mapping, refer to [add a field to an existi
5861

5962
The {{stack}} provides additional ways to process your data:
6063

61-
* **https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html[Ingest pipelines]:** convert data to ECS, normalize field data, or enrich incoming data.
62-
* **https://www.elastic.co/guide/en/logstash/current/introduction.html[Logstash]:** enrich your data using input, output, and filter plugins.
63-
64-
65-
% What needs to be done: Align serverless/stateful
66-
67-
% Use migrated content from existing pages that map to this page:
68-
69-
% - [ ] ./raw-migrated-files/observability-docs/observability/add-logs-service-name.md
70-
% - [ ] ./raw-migrated-files/docs-content/serverless/observability-add-logs-service-name.md
64+
* **[Ingest pipelines](../../../manage-data/ingest/transform-enrich/ingest-pipelines.md):** convert data to ECS, normalize field data, or enrich incoming data.
65+
* **[Logstash](https://www.elastic.co/guide/en/logstash/current):** enrich your data using input, output, and filter plugins.

solutions/observability/logs/apm-agent-log-sending.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/observability/current/logs-send-application.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-send-application-logs.html
5+
applies_to:
6+
stack: all
7+
serverless: all
58
---
69

710
# APM agent log sending [observability-send-application-logs]

solutions/observability/logs/categorize-log-entries.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/categorize-logs.html
4+
applies_to:
5+
stack: all
46
---
57

68
# Categorize log entries [categorize-logs]

solutions/observability/logs/configure-data-sources.md

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

68
# Configure data sources [configure-data-sources]
79

8-
::::{admonition} There’s a new, better way to explore your logs!
10+
::::{Note}
11+
12+
**There’s a new, better way to explore your logs!**
13+
914
These settings only apply to the Logs Stream app. The Logs Stream app and dashboard panel are deactivated by default. We recommend viewing and inspecting your logs with [Logs Explorer](logs-explorer.md) as it provides more features, better performance, and more intuitive navigation.
1015

1116
To activate the Logs Stream app, refer to [Activate Logs Stream](logs-stream.md#activate-logs-stream).

solutions/observability/logs/ecs-formatted-application-logs.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/observability/current/logs-ecs-application.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-ecs-application-logs.html
5+
applies_to:
6+
stack: all
7+
serverless: all
58
---
69

710
# ECS formatted application logs [logs-ecs-application]
@@ -73,20 +76,20 @@ Install {{filebeat}} on the server you want to monitor by running the commands t
7376

7477
::::::{tab-item} DEB
7578
```sh
76-
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-darwin-x86_64.tar.gz
77-
tar xzvf filebeat-9.0.0-beta1-darwin-x86_64.tar.gz
79+
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{{version}}-darwin-x86_64.tar.gz
80+
tar xzvf filebeat-{{version}}-darwin-x86_64.tar.gz
7881
```
7982
::::::
8083

8184
::::::{tab-item} RPM
8285
```sh
83-
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-linux-x86_64.tar.gz
84-
tar xzvf filebeat-9.0.0-beta1-linux-x86_64.tar.gz
86+
curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{{version}}-linux-x86_64.tar.gz
87+
tar xzvf filebeat-{{version}}-linux-x86_64.tar.gz
8588
```
8689
::::::
8790

8891
::::::{tab-item} macOS
89-
1. Download the {{filebeat}} Windows zip file: https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-windows-x86_64.zip[https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-windows-x86_64.zip]
92+
1. Download the {{filebeat}} Windows zip file: `https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{{version}}-windows-x86_64.zip`
9093
2. Extract the contents of the zip file into `C:\Program Files`.
9194
3. Rename the `filebeat-{{version}}-windows-x86_64` directory to `{{filebeat}}`.
9295
4. Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select **Run As Administrator**).
@@ -103,15 +106,15 @@ If script execution is disabled on your system, you need to set the execution po
103106
104107
::::::{tab-item} Linux
105108
```sh
106-
curl -L -O https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-amd64.deb
107-
sudo dpkg -i filebeat-9.0.0-beta1-amd64.deb
109+
curl -L -O https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{{version}}-amd64.deb
110+
sudo dpkg -i filebeat-{{version}}-amd64.deb
108111
```
109112
::::::
110113

111114
::::::{tab-item} Windows
112115
```sh
113-
curl -L -O https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-9.0.0-beta1-x86_64.rpm
114-
sudo rpm -vi filebeat-9.0.0-beta1-x86_64.rpm
116+
curl -L -O https\://artifacts.elastic.co/downloads/beats/filebeat/filebeat-{{version}}-x86_64.rpm
117+
sudo rpm -vi filebeat-{{version}}-x86_64.rpm
115118
```
116119
::::::
117120

solutions/observability/logs/explore-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Logs Explorer allows you to quickly search and filter your log data, get informa
1111

1212
Logs Explorer also provides {{ml}} to detect specific [log anomalies](inspect-log-anomalies.md) automatically and [categorize log messages](categorize-log-entries.md) to quickly identify patterns in your log events.
1313

14-
To view Logs Explorer, find `Logs Explorer` in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md))
14+
To view Logs Explorer, find **Logs Explorer** in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md))
1515

1616

1717

solutions/observability/logs/filter-aggregate-logs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
mapped_urls:
33
- https://www.elastic.co/guide/en/observability/current/logs-filter-and-aggregate.html
44
- https://www.elastic.co/guide/en/serverless/current/observability-filter-and-aggregate-logs.html
5+
applies_to:
6+
stack: all
7+
serverless: all
58
---
69

710
# Filter and aggregate logs [observability-filter-and-aggregate-logs]
@@ -16,8 +19,7 @@ This guide shows you how to:
1619

1720
## Before you get started [logs-filter-and-aggregate-prereq]
1821

19-
::::{admonition} Required role
20-
:class: note
22+
::::{note}
2123

2224
**For Observability serverless projects**, the **Admin** role or higher is required to create ingest pipelines and set the index template. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/user-roles.md#general-assign-user-roles).
2325

solutions/observability/logs/get-started-with-system-logs.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
22
mapped_pages:
33
- https://www.elastic.co/guide/en/serverless/current/observability-get-started-with-logs.html
4+
applies_to:
5+
stack: all
6+
serverless: all
47
---
58

69
# Get started with system logs [observability-get-started-with-logs]
710

8-
::::{admonition} Required role
9-
:class: note
11+
::::{note}
1012

11-
The **Admin** role or higher is required to onboard log data. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/manage-users.md#general-assign-user-roles).
13+
**For Observability Serverless projects**, the **Admin** role or higher is required to onboard log data. To learn more, refer to [Assign user roles and privileges](../../../deploy-manage/users-roles/cloud-organization/manage-users.md#general-assign-user-roles).
1214

1315
::::
1416

@@ -17,8 +19,8 @@ In this guide you’ll learn how to onboard system log data from a machine or se
1719

1820
To onboard system log data:
1921

20-
1. [Create a new {{obs-serverless}} project](../get-started/create-an-observability-project.md), or open an existing one.
21-
2. In your {{obs-serverless}} project, go to **Add data**.
22+
1. Open an [{{obs-serverless}} project](../get-started/create-an-observability-project.md) or Elastic Stack deployment.
23+
2. From the Observability UI, go to **Add data**.
2224
3. Under **What do you want to monitor?**, select **Host****Elastic Agent: Logs & Metrics**.
2325
4. Follow the in-product steps to auto-detect your logs and install and configure the {{agent}}.
2426

solutions/observability/logs/inspect-log-anomalies.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/inspect-log-anomalies.html
4+
applies_to:
5+
stack: all
46
---
57

68
# Inspect log anomalies [inspect-log-anomalies]

0 commit comments

Comments
 (0)