Skip to content

Commit

Permalink
docs: Copyedit for style and docs standards (#582)
Browse files Browse the repository at this point in the history
* docs: Copyedit for style and docs standards

* Update private preview to public preview

* Rebase and update new topic
  • Loading branch information
JStickler authored Jul 15, 2024
1 parent 0395e59 commit f67a77b
Show file tree
Hide file tree
Showing 12 changed files with 99 additions and 156 deletions.
38 changes: 14 additions & 24 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,50 +37,40 @@ cards:
height: 24
---

{{< admonition type="caution" >}}
Explore Logs is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
{{< /admonition >}}

# Explore Logs

![A new way to look at your logs](images/explore-logs-hero-image.jpeg)
{{< docs/public-preview product="Explore Logs" >}}

Welcome to our new experience for Loki. Explore Logs automatically visualizes insights.
Welcome to our new experience for Loki. Explore Logs lets you automatically visualize and explore your logs without having to write queries.
Using Explore Logs you can:

You can:

- **Drill into your** data using volume and text patterns.
- **Easily find logs and log volumes** for all of your services.
- Effortlessly **filter logs based on their labels, fields, or patterns**.
- Uncover **related logs** and monitor changes over time.
- Browse **automatic visualizations of your log data** based on its characteristics.
- Do all of this **without writing LogQL queries**.

![Screenshot of Explore Logs landing page](images/explore-logs-features.jpeg)
- Easily find logs and log volumes for all of your services.
- Effortlessly filter logs based on their labels, fields, or patterns.
- Drill into your data using volume and text patterns.
- Uncover related logs and monitor changes over time.
- Browse automatic visualizations of your log data based on its characteristics.
- Do all of this without writing LogQL queries.

## Who is Explore Logs for?

Explore Logs is for engineers of all levels of operational expertise. You no longer need to be an SRE wizard to get value from your logs.

Traditionally, you'd need a deep understanding of your systems in order to get the most out of Loki.
Traditionally, you'd need a deep understanding of your systems and Loki's query language, LogQL, in order to get the most out of Loki.

With Explore Logs, you get the same powerful insights, by just clicking around and glancing at visualizations which are automatically generated from your data.
With Explore Logs, you get the same powerful insights, by just viewing and clicking in visualizations which are automatically generated from your log data.

## Learn more

Check out the following articles to learn more about Explore Logs:

{{< card-grid key="cards" type="simple" >}}
<br>
If you're having trouble using Explore Logs, check out our [troubleshooting guides]({{< relref "troubleshooting" >}}).

## Please share your feedback

Our new experiences are in their early stages, and we'd love to hear your feedback.

- You'll find a **Give feedback** link on the Explore Logs page in Grafana.
- You can also [fill out this form](https://forms.gle/1sYWCTPvD72T1dPH9) to send your thoughts directly to the team building the apps.
- You'll find a **Give feedback** link on each Explore Logs page.
- You can also fill out [this Google form](https://forms.gle/1sYWCTPvD72T1dPH9) to send your thoughts directly to the team building the apps.

## What's next?

Dive into the [Get started with Explore Logs]({{< relref "get-started" >}}) article to learn how to set up Explore Logs and take a tour of the feature on your own data.
Dive into [Get started with Explore Logs]({{< relref "./get-started" >}}) to learn how to set up Explore Logs and take a tour of the feature using your own data.
43 changes: 20 additions & 23 deletions docs/sources/access/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,55 +10,52 @@ title: Access or install Explore Logs
weight: 200
---

{{< admonition type="caution" >}}
Explore Logs is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
{{< /admonition >}}
# Access or install Explore Logs

# Access Explore Logs
{{< docs/public-preview product="Explore Logs" >}}

To use Explore Logs on your own data, you can either access it in Grafana Cloud or install it in your own Grafana instance.

{{< docs/play title="the Grafana Play site" url="https://play.grafana.org/a/grafana-lokiexplore-app/explore?var-ds=ddhr3fttaw8aod&var-patterns=&var-lineFilter=&var-logsFormat=" >}}

## Access in Grafana Cloud

Explore Logs is already available in Grafana Cloud.
Explore Logs is enabled for Private Preview in Grafana Cloud.

To access Explore Logs:

1. Open your Grafana stack in a web browser
1. Open your Grafana stack in a web browser.
1. In the main menu, select **Explore** > **Logs**.

## Installation

### Install via Plugins catalog
## Install via Plugins catalog

For Enterprise and OSS Grafana users, you can install Explore Logs via the [Grafana Plugins catalog](https://grafana-dev.com/grafana/plugins/grafana-lokiexplore-app/).

1. Open [https://grafana-dev.com/grafana/plugins/grafana-lokiexplore-app/](https://grafana-dev.com/grafana/plugins/grafana-lokiexplore-app/) in a web browser
1. Open the **Installation** tab
1. Follow the instructions to install the app

### Install in Loki
## Install in Loki

The following Loki and Grafana version and configuration are required:

- Loki v3.0+
- `--pattern-ingester.enabled=true` for pattern ingestion
- Volume endpoint enabled in Loki config:
- Grafana v11.0.0+
- Loki v3.0.0+
- Enable pattern ingestion by setting `--pattern-ingester.enabled=true` in your Loki configuration.
- Enable the volume endpoint in your Loki configuration:

```yaml
limits_config:
volume_enabled: true
```
- Grafana v11.0+
```yaml
limits_config:
volume_enabled: true
```
### Install via environment variable
## Install via environment variable
If you want to [install the app in a docker container](https://grafana.com/docs/grafana/latest/setup-grafana/configure-docker/#install-plugins-in-the-docker-container), you need to configure the following environment variable:
```
```sh
GF_INSTALL_PLUGINS=https://storage.googleapis.com/integration-artifacts/grafana-lokiexplore-app/grafana-lokiexplore-app-latest.zip;grafana-lokiexplore-app
```

Expand All @@ -72,24 +69,24 @@ Using `grafana-cli` run the following command:
grafana-cli --pluginUrl=https://storage.googleapis.com/integration-artifacts/grafana-lokiexplore-app/grafana-lokiexplore-app-latest.zip plugins install grafana-lokiexplore-app
```

### Test with Docker Compose
## Test with Docker Compose

You can test the app using the following command to spin up Grafana, Loki, and the Explore Logs App:

```sh
curl -L https://github.com/grafana/explore-logs/raw/main/scripts/run.sh | sh
```

This will download the https://github.com/grafana/explore-logs/blob/main/scripts/run.sh file and execute it.
This will download the [run.sh](https://github.com/grafana/explore-logs/blob/main/scripts/run.sh) file and execute it.

That shell file will download some configuration files into your `/tmp/explore-logs` directory and start the docker containers via `docker compose` from there.

Once the docker container has started, navigate to `http://localhost:3000/a/grafana-lokiexplore-app/explore` to access Explore Logs.

# Having trouble?
## Having trouble?

Check out our [troubleshooting guides]({{< relref "../troubleshooting" >}}) for tips on how to solve common issues.

# What next?
## What next?

Once you're set up, you'll need to configure a data source in order to access your logs in Explore Logs. Our Get Started guide includes a section on how to [set up a new Loki datasource]({{< relref "../get-started#set-up-a-new-loki-datasource" >}}).
75 changes: 21 additions & 54 deletions docs/sources/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,77 +7,44 @@ keywords:
- Analysis
menuTitle: Get started
title: Get started with Explore Logs
weight: 200
weight: 300
---

{{< admonition type="caution" >}}
Explore Logs is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
{{< /admonition >}}

# Get started with Explore Logs

![Screenshot of Explore Logs landing page](../images/screenshots/service_index.png)
{{< docs/public-preview product="Explore Logs" >}}

The best way to see what Explore Logs can do for you is to use it to explore your own data.
If you have a Grafana Cloud account can access Explore logs in Grafana Cloud by selecting **Explore** > **Logs**, or you can [install Explore Logs]({{< relref "../access" >}}) in your own Grafana instance.

{{< admonition type="note" >}}
See also instructions for how to [access or install Explore Logs]({{< relref "../access" >}}).
{{< /admonition >}}

## Set up a new Loki datasource

In order to access your logs through Explore Logs, you will need to configure a datasource in Grafana.

If you already use **Explore** to query your logs, you can skip this section.

1. Log into your Grafana instance. If this is your first time running Grafana, the username and password are both defaulted to `admin`.
1. In Grafana, go to **Connections** > **Data Sources** via the cog icon on the left sidebar.
1. Click the big **+ Add a new data source** button.
1. Search for, or choose **Loki** from the list.
1. The **http URL** field should be the address of your Loki server. For example, when running locally or with Docker using port mapping, the address is likely `http://localhost:3100`.

When running with docker-compose or Kubernetes, the address is likely `http://loki:3100`.
<!-- Drop video link here. -->

When running Grafana (with Docker) and trying to connect to a locally built Loki instance, the address (for the URL field) is:
## Guided tour

On Mac: `docker.for.mac.localhost`
On Windows: `docker.for.win.localhost`
We will walk through a simple step-by-step guided tour of Explore Logs.

1. Open Grafana in a web browser and navigate to **Explore** > **Logs**.
1. Select your **Loki** datasource from the drop-down on the top left.
While you are browsing around the app, look out for any unexpected spikes in your logs. Or perhaps one of your services is down and has stopped logging. Maybe you're seeing an increase in errors after a recent release.

## Guide

We will walk through a simple step-by-step guide providing a tour of Explore Logs.

While you are browsing around the app, look out for any unexpected spikes. Or perhaps one of your services is down and has stopped logging. Maybe you're seeing an increase in errors after a recent release.
{{< figure alt="Explore Logs Service overview page" width="900px" align="center" src="../images/service_index.png" caption="Service Overview page" >}}

To take a tour of Explore Logs, follow these steps:

1. In the main navigation bar click on **Explore** > **Logs**.
2. You’ll land on the **Service overview page** showing time series and log visualizations for all the services in your selected Loki instance. ([No services?]({{< relref "../troubleshooting/#there-are-no-services" >}}))
3. Change your data source with the drop-down on the top left, and select a recent time range.
{{< admonition type="tip" >}}
You can modify your time range in two ways:
1. From the Grafana main menu, select **Explore** > **Logs**.
1. This opens the **Service overview page** showing time series and log visualizations for all the services in your selected Loki instance. ([No services?]({{< relref "../troubleshooting#there-are-no-services" >}}))
1. Change your data source from the menu on the top left, then select a recent time range. You can modify your time range in two ways:
- With the standard time range picker on the top right.
- By clicking and dragging the time range on any time series visualization.
{{< /admonition >}}
4. Services are shown based on the volume of logs, or you can search for the service by name.
5. Click **Select** on the service you would like to explore.
6. Click on the **Labels** tab to see visualizations of the log volume for each label. ([No labels?]({{< relref "../troubleshooting/#there-are-no-labels" >}}))
7. Select a label to see the log volume for each value of that label. <br><br> Explore Logs shows you the volume of logs with specific Labels and fields. Learn more about [Labels and Fields]({{< relref "../labels-and-fields" >}}).<br><br>

8. Select the **Fields** tab to see visualizations of the log volume for each Field. You can drill down in the same way.
9. Click on the **Patterns** tab to see the log volume for each automatically detected pattern. <br><br> Log patterns allow you to work with groups of similar log lines. You can hide them if they're noise, or focus in on them if they're useful. Learn more about [Log Patterns]({{< relref "../patterns" >}}).
1. Services are shown based on the volume of logs, or you can use the **Search Services** field to search for the service by name.
1. To explore logs for a service, slick the **Select** button on the service graph.
1. On the service details page, click the **Labels** tab to see visualizations of the log volume for each label. ([No labels?]({{< relref "../troubleshooting/#there-are-no-labels" >}}))
1. On the **Labels** tab, select a label to see the log volume for each value of that label.
Explore Logs shows you the volume of logs with specific labels and fields. Learn more about [Labels and Fields]({{< relref "../labels-and-fields" >}}).
1. Select the **Fields** tab to see visualizations of the log volume for each field. You can select fields to drill down into the details in the same way as labels.
1. Click the **Patterns** tab to see the log volume for each automatically detected pattern.
Log patterns let you work with groups of similar log lines. You can hide log patterns that are noisy, or focus only on the patterns that are most useful. Learn more about [Log Patterns]({{< relref "../patterns" >}}).

![Screenshot of Explore Logs landing page](../images/screenshots/fields.png)
If you're having trouble using Explore Logs, check out our [troubleshooting guide]({{< relref "../troubleshooting" >}}).

### What do you think?
## What do you think?

Please [share your feedback](https://forms.gle/1sYWCTPvD72T1dPH9) and help make Explore Logs better.

![Screenshot of Explore Logs landing page](../images/explore-logs-features.jpeg)

# What next?

Learn more about how Explore Logs makes it easy to work with [Labels and Fields]({{< relref "../labels-and-fields" >}}).
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
27 changes: 12 additions & 15 deletions docs/sources/labels-and-fields/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,34 @@ keywords:
- Analysis
menuTitle: Labels and Fields
title: Labels and Fields
weight: 300
weight: 400
---

{{< admonition type="caution" >}}
Explore Logs is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
{{< /admonition >}}

![Screenshot of Explore Logs landing page](../images/screenshots/labels.png)

# Labels and Fields

{{< docs/public-preview product="Explore Logs" >}}

Explore Logs visualises log volumes for the labels attached to your log lines, and fields automatically extracted from the text of the line itself.

A special `detected_level` label is added to all log lines where Loki assigns a level of the log line, including `debug`, `info`, `warn`, `error`, `fatal`, `critical`, `trace`, or `unknown` if no level could be determined.
{{< figure alt="Explore Logs Labels tab" width="900px" align="center" src="../images/labels.png" caption="Labels tab" >}}

You can click **Select** on a Label or Field to access a breakdown of its values, seeing the log volumes visualized along the way.
Explore Logs adds a special `detected_level` label to all log lines where Loki assigns a level of the log line, including `debug`, `info`, `warn`, `error`, `fatal`, `critical`, `trace`, or `unknown` if no level could be determined.

This experience is useful for understanding the traits of your system, and for spotting spikes or other changes.
You can click **Select** on a Label or Field to access a breakdown of its values, seeing the log volumes visualized along the way.
This can be useful for understanding the traits of your system, and for spotting spikes or other changes.

{{< admonition type="note" >}}
The type of data being expressed in a label or field may require different treatments. For example, fields expressing `bytes` are visualized differently than other types of data. Please [share your feedback](https://forms.gle/1sYWCTPvD72T1dPH9) if you have suggestions for how to improve this experience.
{{< /admonition >}}

## Guide
## Guided tour of labels and fields

To explore labels with your own data, follow these steps:

1. In the main menu, select **Explore** > **Logs**.
1. Click the **Select** button for the **Service** you want to explore. ([No services?]({{< relref "../troubleshooting/#there-are-no-services" >}}))
1. From the Grafana main menu, select **Explore** > **Logs**.
1. Click the **Select** button for the **Service** you want to explore. ([No services?]({{< relref "../troubleshooting#there-are-no-services" >}}))
1. Click the **Labels** tab.
1. Browse the labels detected for this service. ([No labels?]({{< relref "../troubleshooting/#there-are-no-labels" >}}))
1. Browse the labels detected for this service. ([No labels?]({{< relref "../troubleshooting#there-are-no-labels" >}}))
1. Look for an interesting label and click the **Select** button.

You will see a selection of visualizations showing the volume of each one.
Expand All @@ -53,7 +50,7 @@ You also have a range of [sorting and ordering options]({{< relref "../ordering"

You can repeat the same steps in the **Fields** tab to see fields that were extracted from your log lines.

![Screenshot of Explore Logs landing page](../images/screenshots/fields.png)
{{< figure alt="Explore Logs Fields tab" width="900px" align="center" src="../images/fields.png" caption="Fields tab" >}}

## What next?

Expand Down
14 changes: 6 additions & 8 deletions docs/sources/ordering/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,17 @@ title: Sorting and ordering
weight: 400
---

{{< admonition type="caution" >}}
Explore Logs is currently in [public preview](/docs/release-life-cycle/). Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.
{{< /admonition >}}

# Sorting and ordering

If you find yourself on a page with lots of graphs, you might want to sort them in a way that makes sense to you. You can do this in Explore Logs using the **Sort by** dropdown in the top right toolbar.
{{< docs/public-preview product="Explore Logs" >}}

If you find yourself on a page with lots of graphs, you might want to sort them in a way that makes sense to you. You can do this in Explore Logs using the **Sort by** menu in the top right toolbar.

You can use the **Asc/Desc** dropdown to change the direction of the sort.
You can use the **Asc/Desc** menu to change the direction of the sort.

## Sorting algorithms

![Screenshot of the Sort By dropdown](../images/screenshots/sort-by-dropdown.png)
{{< figure alt="Sort by many" width="900px" align="center" src="../images/sort-by-dropdown.png" caption="Sort by menu" >}}

By default the graphs are sorted by **Most relevant** where we prioritise graphs with more volatile data. For example, the graphs with the most spikes or dips will be shown first.

Expand All @@ -39,5 +37,5 @@ By default the graphs are sorted by **Most relevant** where we prioritise graphs
| Percentiles | Sorts graphs by the nth percentile. |

{{< admonition type="note" >}}
We are keen to improve this feature, so please [get in touch](https://forms.gle/1sYWCTPvD72T1dPH9) if there is something that would help you find the signal in the noise.
We are keen to improve this feature, so please [contact us](https://forms.gle/1sYWCTPvD72T1dPH9) if there is something that would help you find the signal in the noise.
{{< /admonition >}}
Loading

0 comments on commit f67a77b

Please sign in to comment.