Skip to content

Commit

Permalink
[Logs] Add logs explorer docs (#3425)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdbirnstiehl authored Dec 19, 2023
1 parent 69b93aa commit 5ea472b
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 4 deletions.
51 changes: 51 additions & 0 deletions docs/en/observability/explore-logs.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
[[explore-logs]]
= Logs Explorer

beta[]

With **Logs Explorer**, you can quickly search and filter your log data, get information about the structure of log fields, and display your findings in a visualization.
You can also customize and save your searches and place them on a dashboard.
Instead of having to log into different servers, change directories, and view individual files, all your logs are available in a single view.

From the {observability} navigation menu, click **Explorer** under the **Logs** heading to open Logs Explorer.

[role="screenshot"]
image::images/log-explorer.png[Screen capture of the Logs Explorer]

[discrete]
[[find-your-logs]]
== Find your logs

By default, Logs Explorer shows all of your logs.
If you need to focus on logs from a specific integrations, select the integration from the logs menu:

[role="screenshot"]
image::images/log-menu.png[Screen capture of log menu]

Once you have the logs you want to focus on displayed, you can drill down further to find the information you need.
For more on filtering your data in Logs Explorer, refer to <<logs-filter-logs-explorer>>.

[discrete]
[[update-the-documents-table]]
== Update the documents table

The documents table in Logs Explorer functions similarly to the table in Discover.
You can add fields, order table columns, sort fields, and update the row height in the same way you would in Discover.

Refer to the {kibana-ref}/discover.html[Discover] documentation for more information.

[discrete]
[[view-log-details]]
== View log details

Click the expand icon (image:images/expand-icon.png[icon to open log details]) to get an in-depth look at an individual log file.

These details provide immediate feedback and context for what's happening and where it's happening for each log.
From here, you can quickly debug errors and investigate the services where errors have occurred.

The following actions help you filter and focus on specific fields in the log details:

* **Filter for value (image:images/plusInCircle.png[filter for value icon]):** Show logs that contain the specific field value.
* **Filter out value (image:images/minusInCircle.png[filter out value icon]):** Show logs that do *not* contain the specific field value.
* **Filter for field present (image:images/filter.png[filter for present icon]):** Show logs that contain the specific field.
* **Toggle column in table (image:images/listAdd.png[toggle column in table icon]):** Add or remove a column for the field to the main Logs Explorer table.
Binary file added docs/en/observability/images/filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/observability/images/listAdd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/observability/images/log-explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/observability/images/log-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/observability/images/minusInCircle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/observability/images/plusInCircle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/en/observability/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ include::logs-filter.asciidoc[leveloffset=+2]

include::monitor-logs.asciidoc[leveloffset=+2]

include::explore-logs.asciidoc[leveloffset=+3]

include::tail-logs.asciidoc[leveloffset=+3]

include::categorize-logs.asciidoc[leveloffset=+3]
Expand Down
12 changes: 8 additions & 4 deletions docs/en/observability/monitor-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,16 @@ Using {agent} integrations, you can ingest logs from Kubernetes, MySQL, and many
more data sources. Log events are indexed into {es} and are sorted from older to newer,
with infinite scrolling in both directions.

There is live streaming of logs, filtering using auto-complete, and a logs histogram
Logs Explorer allows you to quickly search and filter your log data, get information about the structure of log fields, and display your findings in a visualization.

[role="screenshot"]
image::images/log-explorer.png[Screen capture of the Logs Explorer]

Refer to the <<explore-logs>> documentation for more on using Logs Explorer.

There is also live streaming of logs, filtering using auto-complete, and a logs histogram
for quick navigation. You can also use {ml} to detect specific log
anomalies automatically and categorize log messages to quickly identify patterns in your
log events.

[role="screenshot"]
image::images/logs-app.png[{logs-app} in {kib}]

To view the {logs-app}, go to *{observability} > Logs*.

0 comments on commit 5ea472b

Please sign in to comment.