Skip to content

Commit 9345aeb

Browse files
committed
Get started edit
1 parent bbdeaeb commit 9345aeb

File tree

1 file changed

+138
-10
lines changed

1 file changed

+138
-10
lines changed

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

Lines changed: 138 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,161 @@ products:
1010

1111
# Get started with system logs [observability-get-started-with-logs]
1212

13-
::::{note}
13+
In this guide you can learn how to onboard system log data from a machine or server, then explore the data in **Discover**.
1414

15-
**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).
15+
## Prerequisites [logs-prereqs]
16+
17+
::::{tab-set}
18+
:group: stack-serverless
19+
20+
:::{tab-item} Elastic Stack
21+
:sync: stack
22+
23+
To follow the steps in this guide, you need an {{stack}} deployment that includes:
24+
25+
* {{es}} for storing and searching data
26+
* {{kib}} for visualizing and managing data
27+
* Kibana user with `All` privileges on {{fleet}} and Integrations. Because many Integrations assets are shared across spaces, users need the Kibana privileges in all spaces.
28+
29+
To get started quickly, create an {{ech}} deployment and host it on AWS, GCP, or Azure. [Try it out for free](https://cloud.elastic.co/registration?page=docs&placement=docs-body).
30+
31+
:::
32+
33+
:::{tab-item} Serverless
34+
:sync: serverless
35+
36+
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).
37+
38+
:::
1639

1740
::::
1841

42+
## Onboard system log data [onboard-system-log-data]
43+
44+
Follow these steps to onboard system log data.
45+
46+
::::::{stepper}
47+
48+
:::::{step} Open your project
49+
50+
Open an [{{obs-serverless}} project](/solutions/observability/get-started.md) or Elastic Stack deployment.
51+
52+
:::::
53+
54+
:::::{step} Select data collection method
1955

20-
In this guide you’ll learn how to onboard system log data from a machine or server, then observe the data in **Discover**.
56+
From the Observability UI, go to **Add data**. Under **What do you want to monitor?**, select **Host**, then select one of these options:
2157

22-
To onboard system log data:
58+
::::{tab-set}
59+
:::{tab-item} OpenTelemetry: Full Observability
2360

24-
1. Open an [{{obs-serverless}} project](/solutions/observability/get-started.md) or Elastic Stack deployment.
25-
2. From the Observability UI, go to **Add data**.
26-
3. Under **What do you want to monitor?**, select **Host****Elastic Agent: Logs & Metrics**.
27-
4. Follow the in-product steps to auto-detect your logs and install and configure the {{agent}}.
61+
Collect native OpenTelemetry metrics and logs using the Elastic Distribution of OpenTelemetry Collector (EDOT).
62+
63+
**Recommended for**: Users who want to collect native OpenTelemetry data or are already using OpenTelemetry in their environment.
64+
65+
:::
66+
67+
:::{tab-item} Elastic Agent: Logs & Metrics
68+
69+
Bring data from Elastic integrations using the Elastic Agent.
70+
71+
**Recommended for**: Users who want to leverage Elastic's pre-built integrations and centralized management through Fleet.
72+
73+
:::
74+
75+
::::
76+
:::::
77+
78+
:::::{step} Follow setup instructions
79+
80+
Follow the in-product steps to auto-detect your logs and install and configure your chosen data collector.
81+
82+
:::::
83+
84+
:::::{step} Verify data collection
2885

2986
After the agent is installed and successfully streaming log data, you can view the data in the UI:
3087

3188
1. From the navigation menu, go to **Discover**.
32-
1. Select **All logs** from the **Data views** menu. The view shows all log datasets. Notice you can add fields, change the view, expand a document to see details, and perform other actions to explore your data.
89+
2. Select **All logs** from the **Data views** menu. The view shows all log datasets. Notice you can add fields, change the view, expand a document to see details, and perform other actions to explore your data.
90+
91+
:::::
92+
93+
:::::{step} Explore and analyze your data
3394

95+
Now that you have logs flowing into Elasticsearch, you can start exploring and analyzing your data:
96+
97+
* **[Explore logs in Discover](/solutions/observability/logs/explore-logs.md)**: Search, filter, and tail all your logs from a central location
98+
* **[Parse and route logs](/solutions/observability/logs/parse-route-logs.md)**: Extract structured fields from unstructured logs and route them to specific data streams
99+
* **[Filter and aggregate logs](/solutions/observability/logs/filter-aggregate-logs.md)**: Filter logs by specific criteria and aggregate data to find patterns and gain insights
100+
101+
:::::
102+
103+
::::::
104+
105+
## Other ways to collect log data [other-data-collection-methods]
106+
107+
While the Elastic Agent and OpenTelemetry Collector are the recommended approaches for most users, Elastic provides additional tools for specific use cases:
108+
109+
::::{tab-set}
110+
111+
:::{tab-item} Filebeat
112+
113+
Filebeat is a lightweight data shipper that sends log data to Elasticsearch. It's ideal for:
114+
115+
* Simple log collection: When you need to collect logs from specific files or directories.
116+
* Custom parsing: When you need to parse logs using ingest pipelines before indexing.
117+
* Legacy systems: When you can't install the Elastic Agent or OpenTelemetry Collector.
118+
119+
For more information, refer to [Collecting log data with Filebeat](/deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md) and [Ingest logs from applications using Filebeat](/solutions/observability/logs/plaintext-application-logs.md).
120+
121+
:::
122+
123+
:::{tab-item} Winlogbeat
124+
125+
Winlogbeat is specifically designed for collecting Windows event logs. It's ideal for:
126+
127+
* Windows environments: When you need to collect Windows security, application, and system event logs.
128+
* Security monitoring: When you need detailed Windows security event data.
129+
* Compliance requirements: When you need to capture specific Windows event IDs.
130+
131+
For more information, refer to the [Winlogbeat documentation](beats://reference/winlogbeat/index.md).
132+
133+
:::
134+
135+
:::{tab-item} Logstash
136+
137+
Logstash is a powerful data processing pipeline that can collect, transform, and enrich log data before sending it to Elasticsearch. It's ideal for:
138+
139+
* Complex data processing: When you need to parse, filter, and transform logs before indexing.
140+
* Multiple data sources: When you need to collect logs from various sources and normalize them.
141+
* Advanced use cases: When you need data enrichment, aggregation, or routing to multiple destinations.
142+
* Extending Elastic integrations: When you want to add custom processing to data collected by Elastic Agent or Beats.
143+
144+
For more information, refer to [Logstash](logstash://reference/index.md) and [Using Logstash with Elastic integrations](logstash://reference/using-logstash-with-elastic-integrations.md).
145+
146+
:::
147+
148+
:::{tab-item} REST APIs
149+
150+
You can use Elasticsearch REST APIs to send log data directly to Elasticsearch. This approach is ideal for:
151+
152+
* Custom applications: When you want to send logs directly from your application code.
153+
* Programmatic collection: When you need to collect logs using custom scripts or tools.
154+
* Real-time streaming: When you need to send logs as they're generated.
155+
156+
For more information, refer to [Elasticsearch REST APIs](elasticsearch://reference/elasticsearch/rest-apis/index.md).
157+
158+
:::
159+
160+
::::
34161

35162
## Next steps [observability-get-started-with-logs-next-steps]
36163

37-
Now that youve added logs and explored your data, learn how to onboard other types of data:
164+
Now that you've added logs and explored your data, learn how to onboard other types of data:
38165

39166
* [Stream any log file](stream-any-log-file.md)
167+
* [Stream application logs](stream-application-logs.md)
40168
* [Get started with traces and APM](/solutions/observability/apm/get-started.md)
41169

42170
To onboard other types of data, select **Add Data** from the main menu.

0 commit comments

Comments
 (0)