Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grafana Drilldown Logs #1054

Merged
merged 3 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
workflow_dispatch:
jobs:
sync:
if: github.repository == 'grafana/explore-logs'
if: github.repository == 'grafana/logs-drilldown'
permissions:
contents: read
id-token: write
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Explore Logs
# Grafana Logs Drilldown

Explore Logs offers a query-less experience for browsing Loki logs without the need for writing complex queries. Discover or narrow down your search using by volume and text patterns. Uncover related logs and understand patterns—all with just a few clicks. No LogQL required. With Explore Logs, you can:
Grafana Logs Drilldown offers a query-less experience for browsing Loki logs without the need for writing complex queries. Discover or narrow down your search using by volume and text patterns. Uncover related logs and understand patterns—all with just a few clicks. No LogQL required. With Grafana Logs Drilldown, you can:

- Easily find logs and log volumes for all of your services
- Effortlessly filter service logs based on their log volumes, labels, fields, or patterns.
- Automatically choose the best visualization for your log data based on its characteristics, without any manual setup.

...all without crafting a single query!

- Check out the [Explore Logs documentation](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/logs/)
- Check out the [Grafana Logs Drilldown documentation](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/logs/)

<img width="840" alt="Screenshot of Explore Logs" src="https://github.com/user-attachments/assets/96b7ddb5-5eb1-42a1-bc35-1f524fc0431b">
<img width="840" alt="Screenshot of Grafana Logs Drilldown" src="https://github.com/user-attachments/assets/96b7ddb5-5eb1-42a1-bc35-1f524fc0431b">

## Installation in Your Own Grafana Instance

You can install Explore Logs in your own Grafana instance using `grafana-cli`:
You can install Grafana Logs Drilldown in your own Grafana instance using `grafana-cli`:

> [!IMPORTANT]
> The following Loki and Grafana version and configuration are required:
Expand Down Expand Up @@ -52,7 +52,7 @@ 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. 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 started, navigate to http://localhost:3000/a/grafana-lokiexplore-app/explore in order to use Explore Logs.
Once the docker container started, navigate to http://localhost:3000/a/grafana-lokiexplore-app/explore in order to use Grafana Logs Drilldown.

## Getting Started

Expand Down
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Explore Logs Documentation
# Grafana Logs Drilldown Documentation

This directory contains the source code for the Explore Logs documentation.
This directory contains the source code for the Grafana Logs Drilldown documentation.

Some key things to know about the Explore Logs documentation source:
Some key things to know about the Grafana Logs Drilldown documentation source:

- The docs are written in markdown, specifically the CommonMark flavor of markdown.
- The Grafana docs team uses [Hugo](https://gohugo.io/) to generate the documentation.
Expand All @@ -12,14 +12,14 @@ The docs team has created a [Writers' Toolkit](https://grafana.com/docs/writers-

## Contributing

The Explore Logs documentation is written using the CommonMark flavor of markdown, including some extended features. For more information about markdown, you can see the [CommonMark specification](https://spec.commonmark.org/), and a [quick reference guide](https://commonmark.org/help/) for CommonMark.
The Grafana Logs Drilldown documentation is written using the CommonMark flavor of markdown, including some extended features. For more information about markdown, you can see the [CommonMark specification](https://spec.commonmark.org/), and a [quick reference guide](https://commonmark.org/help/) for CommonMark.

If you have a GitHub account and you're just making a small fix, for example fixing a typo or updating an example, you can edit the topic in GitHub.

1. Find the topic in the Explore Logs repo.
1. Find the topic in the Grafana Logs Drilldown repo.
2. Click the pencil icon.
3. Enter your changes.
4. Click **Commit changes**. GitHub creates a pull request for you.
5. If this is your first contribution to the Explore Logs repository, you will need to sign the Contributor License Agreement (CLA) before your PR can be accepted.
5. If this is your first contribution to the Grafana Logs Drilldown repository, you will need to sign the Contributor License Agreement (CLA) before your PR can be accepted.

Note that in Hugo the structure of the documentation is based on the folder structure of the documentation repository. The URL structure is generated based on the folder structure and file names.
36 changes: 18 additions & 18 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
---
title: Explore Logs
title: Grafana Logs Drilldown
canonical: https://grafana.com/docs/grafana/latest/explore/simplified-exploration/logs/
description: Learn about the new experience for browsing your Loki logs without writing queries.
weight: 100
hero:
title: Explore Logs
title: Grafana Logs Drilldown
level: 1
width: 100
height: 100
description: Explore Logs automatically visualises insights from your Loki logs.
description: Grafana Logs Drilldown automatically visualises insights from your Loki logs.
cards:
title_class: pt-0 lh-1
items:
- title: Get access or install
href: ./access/
description: Get access to Explore Logs in Grafana Cloud or in your own stack.
description: Get access to Grafana Logs Drilldown in Grafana Cloud or in your own stack.
height: 24
- title: Get started
href: ./get-started/
description: Install Explore Logs and take a tour of Explore Logs using your own data.
description: Install Grafana Logs Drilldown and take a tour of Grafana Logs Drilldown using your own data.
height: 24
- title: Learn about Labels and Fields
href: ./labels-and-fields/
description: Learn how Explore Logs uses labels and Fields to help you explore your Loki logs.
description: Learn how Grafana Logs Drilldown uses labels and Fields to help you explore your Loki logs.
height: 24
- title: Learn about Log patterns
href: ./patterns/
description: Learn how you can use automatic log grouping to remove noise and find hard to locate logs.
height: 24
- title: Troubleshooting
href: ./troubleshooting/
description: Find solutions to common issues you might encounter when using Explore Logs.
description: Find solutions to common issues you might encounter when using Grafana Logs Drilldown.
height: 24
- title: Give feedback
href: https://forms.gle/1sYWCTPvD72T1dPH9
description: Share your thoughts on Explore Logs and help us improve the experience.
description: Share your thoughts on Grafana Logs Drilldown and help us improve the experience.
height: 24
---

# Explore Logs
# Grafana Logs Drilldown

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:
Welcome to our new experience for Loki. Grafana Logs Drilldown lets you automatically visualize and explore your logs without having to write queries.
Using Grafana Logs Drilldown you can:

- Easily find logs and log volumes for all of your services.
- Effortlessly filter logs based on their labels, fields, or patterns.
Expand All @@ -50,15 +50,15 @@ Using Explore Logs you can:
- Browse automatic visualizations of your log data based on its characteristics.
- Do all of this without writing LogQL queries.

{{< docs/play title="Explore Logs" url="https://play.grafana.org/a/grafana-lokiexplore-app/explore" >}}
{{< docs/play title="Grafana Logs Drilldown" url="https://play.grafana.org/a/grafana-lokiexplore-app/explore" >}}

## Who is Explore Logs for?
## Who is Grafana Logs Drilldown 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.
Grafana Logs Drilldown 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 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 viewing and clicking in visualizations which are automatically generated from your log data.
With Grafana Logs Drilldown, you get the same powerful insights, by just viewing and clicking in visualizations which are automatically generated from your log data.

## Explore

Expand All @@ -68,9 +68,9 @@ With Explore Logs, you get the same powerful insights, by just viewing and click

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

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

## What's next?

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.
Dive into [Get started with Grafana Logs Drilldown]({{< relref "./get-started" >}}) to learn how to set up Grafana Logs Drilldown and take a tour of the feature using your own data.
22 changes: 11 additions & 11 deletions docs/sources/access/_index.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
---
canonical: https://grafana.com/docs/grafana/latest/explore/simplified-exploration/logs/access/
description: Describes how to access Explore Logs in Grafana Cloud and the different installation methods for self-hosted Grafana.
description: Describes how to access Grafana Logs Drilldown in Grafana Cloud and the different installation methods for self-hosted Grafana.
keywords:
- Logs
- Explore
- Labels
- Analysis
menuTitle: Access or Install
title: Access or install Explore Logs
title: Access or install Grafana Logs Drilldown
weight: 200
---

# Access or install Explore Logs
# Access or install Grafana Logs Drilldown

To use Explore Logs on your own data, you can either access it in Grafana Cloud or install it in your own Grafana instance.
To use Grafana Logs Drilldown 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

To access Explore Logs:
To access Grafana Logs Drilldown:

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

## Installation

If you are not using Grafana Cloud, you can install Explore Logs in your Grafana environment.
If you are not using Grafana Cloud, you can install Grafana Logs Drilldown in your Grafana environment.

### Install via Plugins catalog

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

1. Open [https://grafana.com/grafana/plugins/grafana-lokiexplore-app/](https://grafana.com/grafana/plugins/grafana-lokiexplore-app/) in a web browser
1. Open the **Installation** tab.
Expand Down Expand Up @@ -65,7 +65,7 @@ GF_INSTALL_PLUGINS=https://storage.googleapis.com/integration-artifacts/grafana-

### Install using grafana-cli

You can install Explore Logs in your own Grafana instance using `grafana-cli`. For more information about `grafana-cli` refer to the [documentation](https://grafana.com/docs/grafana/latest/cli/.)
You can install Grafana Logs Drilldown in your own Grafana instance using `grafana-cli`. For more information about `grafana-cli` refer to the [documentation](https://grafana.com/docs/grafana/latest/cli/.)

Using `grafana-cli` run the following command:

Expand All @@ -75,7 +75,7 @@ grafana-cli --pluginUrl=https://storage.googleapis.com/integration-artifacts/gra

## Test with Docker Compose

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

```sh
curl -L https://github.com/grafana/explore-logs/raw/main/scripts/run.sh | sh
Expand All @@ -85,13 +85,13 @@ This will download the [run.sh](https://github.com/grafana/explore-logs/blob/mai

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.
Once the docker container has started, navigate to `http://localhost:3000/a/grafana-lokiexplore-app/explore` to access Grafana Logs Drilldown.

## Having trouble?

Refer to the [troubleshooting guide]({{< relref "../troubleshooting" >}}) for tips on how to solve common issues.

## What next?

Before you can use Explore Logs, an administrator must configure a Loki data source in order to access your logs in Explore Logs.
Before you can use Grafana Logs Drilldown, an administrator must configure a Loki data source in order to access your logs in Grafana Logs Drilldown.
Refer to the [Loki data source documentation](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/data-sources/loki/) for instructions.
24 changes: 12 additions & 12 deletions docs/sources/get-started/_index.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
---
canonical: https://grafana.com/docs/grafana/latest/explore/simplified-exploration/logs/get-started/
description: Provides a guided tour of the features in Explore Logs.
description: Provides a guided tour of the features in Grafana Logs Drilldown.
keywords:
- Logs
- Explore
- Labels
- Analysis
menuTitle: Get started
title: Get started with Explore Logs
title: Get started with Grafana Logs Drilldown
weight: 300
---

# Get started with Explore Logs
# Get started with Grafana Logs Drilldown

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, you can access Explore logs by selecting **Explore** > **Logs**, or you can [install Explore Logs](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/access/) in your own Grafana instance.
The best way to see what Grafana Logs Drilldown can do for you is to use it to explore your own data.
If you have a Grafana Cloud account, you can access Grafana Logs Drilldown by selecting **Explore** > **Logs**, or you can [install Grafana Logs Drilldown](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/access/) in your own Grafana instance.

To learn more, check out our overview video:

{{< youtube id="iH0Ufv2bD1U" >}}

## Guided tour

We will walk through a simple step-by-step guided tour of Explore Logs.
We will walk through a simple step-by-step guided tour of Grafana Logs Drilldown.

While you are browsing your log data in Explore Logs, watch 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.
While you are browsing your log data in Grafana Logs Drilldown, watch 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.

{{< figure alt="Explore Logs Service overview page" width="900px" align="center" src="/media/docs/explore-logs/landing_page_index.png" caption="Overview page" >}}
{{< figure alt="Grafana Logs Drilldown Service overview page" width="900px" align="center" src="/media/docs/explore-logs/landing_page_index.png" caption="Overview page" >}}

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

1. From the Grafana main menu, select **Explore** > **Logs**.
1. This opens the **Overview page** showing time series and log visualizations for all the services in your selected Loki instance. ([No services?](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/troubleshooting/#there-are-no-services))
Expand All @@ -39,13 +39,13 @@ To take a tour of Explore Logs, follow these steps:
1. To explore logs for a service, click the **Select** button on the service graph. _New for version 1.0.2_: You can now begin a workflow with any label, not just service, by clicking **Add Label**.
1. On the service details page, click the **Labels** tab to see visualizations of the log volume for each label. ([No labels?](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/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](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/labels-and-fields/).
Grafana Logs Drilldown shows you the volume of logs with specific labels and fields. Learn more about [Labels and Fields](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/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](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/patterns/).

If you're having trouble using Explore Logs, refer to the [troubleshooting page](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/troubleshooting/).
If you're having trouble using Logs Drilldown, refer to the [troubleshooting page](https://grafana.com/docs/grafana-cloud/visualizations/simplified-exploration/logs/troubleshooting/).

## What do you think?

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