Skip to content

Commit f1ff36d

Browse files
committed
Edit logs onboarding
1 parent 9345aeb commit f1ff36d

File tree

6 files changed

+79
-25
lines changed

6 files changed

+79
-25
lines changed

manage-data/ingest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ products:
1616
- id: elasticsearch
1717
---
1818

19-
# Ingestion
19+
# Bring your data to Elastic
2020

21-
Bring your data! Whether you call it *adding*, *indexing*, or *ingesting* data, you have to get the data into {{es}} before you can search it, visualize it, and use it for insights.
21+
Whether you call it *adding*, *indexing*, or *ingesting* data, you have to get the data into {{es}} before you can search it, visualize it, and use it for insights.
2222

2323
Our ingest tools are flexible, and support a wide range of scenarios. We can help you with everything from popular and straightforward use cases, all the way to advanced use cases that require additional processing in order to modify or reshape your data before it goes to {{es}}.
2424

manage-data/ingest/tools.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ $$$supported-outputs-beats-and-agent$$$
4040

4141
$$$additional-capabilities-beats-and-agent$$$
4242

43-
Depending on the type of data you want to ingest, you have a number of methods and tools available for use in your ingestion process. The table below provides more information about the available tools. Refer to our [Ingestion](/manage-data/ingest.md) overview for some guidelines to help you select the optimal tool for your use case.
43+
Depending on the type of data you want to ingest, you have a number of methods and tools available for use in your ingestion process. The table below provides more information about the available tools.
44+
45+
Refer to our [Ingestion](/manage-data/ingest.md) overview for some guidelines to help you select the optimal tool for your use case.
4446

4547
<br>
4648

@@ -49,14 +51,13 @@ Depending on the type of data you want to ingest, you have a number of methods a
4951
| Integrations | Ingest data using a variety of Elastic integrations. | [Elastic Integrations](integration-docs://reference/index.md) |
5052
| File upload | Upload data from a file and inspect it before importing it into {{es}}. | [Upload data files](/manage-data/ingest/upload-data-files.md) |
5153
| APIs | Ingest data through code by using the APIs of one of the language clients or the {{es}} HTTP APIs. | [Document APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-document) |
52-
| OpenTelemetry | Collect and send your telemetry data to Elastic Observability | [Elastic Distributions of OpenTelemetry](opentelemetry://reference/index.md) |
54+
| OpenTelemetry | Collect and send your telemetry data to Elastic Observability | [Elastic Distributions of OpenTelemetry](opentelemetry://reference/index.md). |
5355
| Fleet and Elastic Agent | Add monitoring for logs, metrics, and other types of data to a host using Elastic Agent, and centrally manage it using Fleet. | [Fleet and {{agent}} overview](/reference/fleet/index.md) <br> [{{fleet}} and {{agent}} restrictions (Serverless)](/reference/fleet/fleet-agent-serverless-restrictions.md) <br> [{{beats}} and {{agent}} capabilities](/manage-data/ingest/tools.md)||
5456
| {{elastic-defend}} | {{elastic-defend}} provides organizations with prevention, detection, and response capabilities with deep visibility for EPP, EDR, SIEM, and Security Analytics use cases across Windows, macOS, and Linux operating systems running on both traditional endpoints and public cloud environments. | [Configure endpoint protection with {{elastic-defend}}](/solutions/security/configure-elastic-defend.md) |
5557
| {{ls}} | Dynamically unify data from a wide variety of data sources and normalize it into destinations of your choice with {{ls}}. | [Logstash](logstash://reference/index.md) |
5658
| {{beats}} | Use {{beats}} data shippers to send operational data to Elasticsearch directly or through Logstash. | [{{beats}}](beats://reference/index.md) |
5759
| APM | Collect detailed performance information on response time for incoming requests, database queries, calls to caches, external HTTP requests, and more. | [Application performance monitoring (APM)](/solutions/observability/apm/index.md) |
5860
| Application logs | Ingest application logs using Filebeat, {{agent}}, or the APM agent, or reformat application logs into Elastic Common Schema (ECS) logs and then ingest them using Filebeat or {{agent}}. | [Stream application logs](/solutions/observability/logs/stream-application-logs.md) <br> [ECS formatted application logs](/solutions/observability/logs/ecs-formatted-application-logs.md) |
5961
| Elastic Serverless forwarder for AWS | Ship logs from your AWS environment to cloud-hosted, self-managed Elastic environments, or {{ls}}. | [Elastic Serverless Forwarder](elastic-serverless-forwarder://reference/index.md) |
60-
| Connectors | Use connectors to extract data from an original data source and sync it to an {{es}} index. | [Ingest content with Elastic connectors
61-
](elasticsearch://reference/search-connectors/index.md) <br> [Connector clients](elasticsearch://reference/search-connectors/index.md) |
62+
| Connectors | Use connectors to extract data from an original data source and sync it to an {{es}} index. | [Ingest content with Elastic connectors](elasticsearch://reference/search-connectors/index.md) <br> [Connector clients](elasticsearch://reference/search-connectors/index.md) |
6263
| Web crawler | Discover, extract, and index searchable content from websites and knowledge bases using the web crawler. | [Elastic Open Web Crawler](https://github.com/elastic/crawler#readme) |

solutions/observability/logs.md

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,29 @@ Elastic Observability allows you to deploy and manage logs at a petabyte scale,
2020
* [Run pattern analysis on log data](/solutions/observability/logs/run-pattern-analysis-on-log-data.md): Find patterns in unstructured log messages and make it easier to examine your data.
2121
* [Troubleshoot logs](/troubleshoot/observability/troubleshoot-logs.md): Find solutions for errors you might encounter while onboarding your logs.
2222

23-
2423
## Send logs data to your project [observability-log-monitoring-send-logs-data-to-your-project]
2524

26-
You can send logs data to your project in different ways depending on your needs:
25+
You can send logs data to your project in different ways depending on your needs. When choosing between these options, consider the different features and functionalities between them.
26+
27+
Refer to [Ingest tools overview](/manage-data/ingest/tools.md) for more information on which option best fits your situation.
28+
29+
30+
::::{tab-set}
31+
32+
:::{tab-item} {{edot}}
33+
34+
The Elastic Distribution of OpenTelemetry (EDOT) Collector and SDKs provide native OpenTelemetry support for collecting logs, metrics, and traces. This approach is ideal for:
2735

28-
* {{agent}}
29-
* {{filebeat}}
36+
* Native OpenTelemetry: When you want to use OpenTelemetry standards and are already using OpenTelemetry in your environment.
37+
* Full observability: When you need to collect logs, metrics, and traces from a single collector.
38+
* Modern applications: When building new applications with OpenTelemetry instrumentation.
39+
* Standards compliance: When you need to follow OpenTelemetry specifications.
3040

31-
When choosing between {{agent}} and {{filebeat}}, consider the different features and functionalities between the two options. See [{{beats}} and {{agent}} capabilities](/manage-data/ingest/tools.md) for more information on which option best fits your situation.
41+
For more information, refer to [Elastic Distribution of OpenTelemetry](opentelemetry://reference/index.md).
3242

43+
:::
3344

34-
### {{agent}} [observability-log-monitoring-agent]
45+
:::{tab-item} {{agent}}
3546

3647
{{agent}} uses [integrations](https://www.elastic.co/integrations/data-integrations) to ingest logs from Kubernetes, MySQL, and many more data sources. You have the following options when installing and managing an {{agent}}:
3748

@@ -45,7 +56,7 @@ See [install {{fleet}}-managed {{agent}}](/reference/fleet/install-fleet-managed
4556

4657
#### Standalone {{agent}} [observability-log-monitoring-standalone-agent]
4758

48-
Install an {{agent}} and manually configure it locally on the system where its installed. You are responsible for managing and upgrading the agents.
59+
Install an {{agent}} and manually configure it locally on the system where it's installed. You are responsible for managing and upgrading the agents.
4960

5061
See [install standalone {{agent}}](/reference/fleet/install-standalone-elastic-agent.md).
5162

@@ -56,15 +67,32 @@ Run an {{agent}} inside of a container — either with {{fleet-server}} or stand
5667

5768
See [install {{agent}} in containers](/reference/fleet/install-elastic-agents-in-containers.md).
5869

70+
:::
5971

60-
### {{filebeat}} [observability-log-monitoring-filebeat]
72+
:::{tab-item} {{filebeat}}
6173

6274
{{filebeat}} is a lightweight shipper for forwarding and centralizing log data. Installed as a service on your servers, {{filebeat}} monitors the log files or locations that you specify, collects log events, and forwards them to your Observability project for indexing.
6375

6476
* [{{filebeat}} overview](beats://reference/filebeat/index.md): General information on {{filebeat}} and how it works.
6577
* [{{filebeat}} quick start](beats://reference/filebeat/filebeat-installation-configuration.md): Basic installation instructions to get you started.
6678
* [Set up and run {{filebeat}}](beats://reference/filebeat/setting-up-running.md): Information on how to install, set up, and run {{filebeat}}.
6779

80+
:::
81+
82+
:::{tab-item} {{ls}}
83+
84+
{{ls}} is a powerful data processing pipeline that can collect, transform, and enrich log data before sending it to Elasticsearch. It's ideal for:
85+
86+
* Complex data processing: When you need to parse, filter, and transform logs before indexing.
87+
* Multiple data sources: When you need to collect logs from various sources and normalize them.
88+
* Advanced use cases: When you need data enrichment, aggregation, or routing to multiple destinations.
89+
* Extending Elastic integrations: When you want to add custom processing to data collected by Elastic Agent or Beats.
90+
91+
For more information, refer to [Logstash](logstash://reference/index.md) and [Using Logstash with Elastic integrations](logstash://reference/using-logstash-with-elastic-integrations.md).
92+
93+
:::
94+
95+
::::
6896

6997
## Configure logs [observability-log-monitoring-configure-logs]
7098

solutions/observability/logs/discover-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For a contextual logs experience, set the **Solution view** for your space to **
2222

2323
:::{image} ../../images/observability-log-explorer.png
2424
:alt: Screen capture of Discover
25-
:class: screenshot
25+
:screenshot:
2626
:::
2727

2828
## Required {{kib}} privileges [logs-explorer-privileges]

solutions/observability/logs/stream-any-log-file.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ products:
1010
- id: cloud-serverless
1111
---
1212

13-
# Stream any log file [logs-stream]
13+
# Stream any log file using {{agent}} [logs-stream]
1414

1515
This guide shows you how to manually configure a standalone {{agent}} to send your log data to {{es}} using the `elastic-agent.yml` file.
1616

@@ -97,7 +97,7 @@ Expand-Archive .\elastic-agent-{{version.stack}}-windows-x86_64.zip
9797
::::::{tab-item} DEB
9898

9999
:::{tip}
100-
To simplify upgrading to future versions of Elastic Agent, we recommended that you use the tarball distribution instead of the RPM distribution.
100+
To simplify upgrading to future versions of Elastic Agent, use the tarball distribution instead of the RPM distribution.
101101
You can install Elastic Agent in an unprivileged mode that does not require root privileges.
102102
:::
103103

@@ -110,7 +110,7 @@ sudo dpkg -i elastic-agent-{{version.stack}}-amd64.deb
110110
::::::{tab-item} RPM
111111

112112
:::{tip}
113-
To simplify upgrading to future versions of Elastic Agent, we recommended that you use the tarball distribution instead of the RPM distribution.
113+
To simplify upgrading to future versions of Elastic Agent, use the tarball distribution instead of the RPM distribution.
114114
You can install Elastic Agent in an unprivileged mode that does not require root privileges.
115115
:::
116116

@@ -124,7 +124,7 @@ sudo rpm -vi elastic-agent-{{version.stack}}-x86_64.rpm
124124

125125
### Step 2: Install and start the {{agent}} [logs-stream-install-agent]
126126

127-
After downloading and extracting the installation package, youre ready to install the {{agent}}. From the agent directory, run the install command that corresponds with your system:
127+
After downloading and extracting the installation package, you're ready to install the {{agent}}. From the agent directory, run the install command that corresponds with your system:
128128

129129
::::{note}
130130
On macOS, Linux (tar package), and Windows, run the `install` command to install and start {{agent}} as a managed service and start the service. The DEB and RPM packages include a service unit for Linux systems with systemd. For these systems, you must enable and start the service.

solutions/observability/logs/stream-application-logs.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Application logs provide valuable insight into events that have occurred within
1717
The format of your logs (structured or plaintext) influences your log ingestion strategy.
1818

1919

20-
## Plaintext logs vs. structured Elastic Common Schema (ECS) logs [observability-correlate-application-logs-plaintext-logs-vs-structured-elastic-common-schema-ecs-logs]
20+
## Plaintext logs versus structured Elastic Common Schema (ECS) logs [observability-correlate-application-logs-plaintext-logs-vs-structured-elastic-common-schema-ecs-logs]
2121

2222
Logs are typically produced as either plaintext or structured. Plaintext logs contain only text and have no special formatting, for example:
2323

@@ -27,7 +27,7 @@ Logs are typically produced as either plaintext or structured. Plaintext logs co
2727
2019-08-06T14:08:40.199Z DEBUG:spring-petclinic: init find form, org.springframework.samples.petclinic.owner.OwnerController
2828
```
2929

30-
Structured logs follow a predefined, repeatable pattern or structure. This structure is applied at write timepreventing the need for parsing at ingest time. The Elastic Common Schema (ECS) defines a common set of fields to use when structuring logs. This structure allows logs to be easily ingested, and provides the ability to correlate, search, and aggregate on individual fields within your logs.
30+
Structured logs follow a predefined, repeatable pattern or structure. This structure is applied at write time, preventing the need for parsing at ingest time. The Elastic Common Schema (ECS) defines a common set of fields to use when structuring logs. This structure allows logs to be ingested, and provides the ability to correlate, search, and aggregate on individual fields within your logs.
3131

3232
For example, the previous example logs might look like this when structured with ECS-compatible JSON:
3333

@@ -92,15 +92,40 @@ Log sending is supported in the Java {{apm-agent}}.
9292

9393
Correlate your application logs with trace events to:
9494

95-
* view the context of a log and the parameters provided by a user
96-
* view all logs belonging to a particular trace
97-
* easily move between logs and traces when debugging application issues
95+
* See the context of a log and the parameters provided by a user
96+
* See all logs belonging to a particular trace
97+
* Move between logs and traces when debugging application issues
9898

9999
Learn more about log correlation in the agent-specific ingestion guides:
100100

101+
::::{tab-set}
102+
103+
:::{tab-item} OpenTelemetry (EDOT)
104+
105+
The {{edot}} (EDOT) provides SDKs for multiple programming languages with built-in support for log correlation:
106+
107+
* [Java](opentelemetry://reference/edot-sdks/java/index.md)
108+
* [.NET](opentelemetry://reference/edot-sdks/dotnet/index.md)
109+
* [Node.js](opentelemetry://reference/edot-sdks/nodejs/index.md)
110+
* [PHP](opentelemetry://reference/edot-sdks/php/index.md)
111+
* [Python](opentelemetry://reference/edot-sdks/python/index.md)
112+
113+
For more information about EDOT, refer to [Elastic Distribution of OpenTelemetry (EDOT)](opentelemetry://reference/index.md).
114+
115+
:::
116+
117+
:::{tab-item} APM Agents
118+
:name: apm-agents
119+
120+
Elastic APM agents provide log correlation capabilities for the following languages:
121+
101122
* [Go](apm-agent-go://reference/logs.md)
102123
* [Java](apm-agent-java://reference/logs.md#log-correlation-ids)
103124
* [.NET](apm-agent-dotnet://reference/logs.md)
104125
* [Node.js](apm-agent-nodejs://reference/logs.md)
105126
* [Python](apm-agent-python://reference/logs.md#log-correlation-ids)
106-
* [Ruby](apm-agent-ruby://reference/logs.md)
127+
* [Ruby](apm-agent-ruby://reference/logs.md)
128+
129+
:::
130+
131+
::::

0 commit comments

Comments
 (0)