mirror of https://github.com/grafana/grafana
Docs: Loki data sources updates (#72041)
* added new configure loki doc * finished first draft of config doc * changed file name * started updates to query editor * updated config and qury editor * updated index doc config doc and query editor * updated query editor * updates to query editor doc * more updates to query editor and index doc * one small update * updates to query editor doc and index * Update docs/sources/datasources/loki/_index.md Co-authored-by: Matias Chomicki <matyax@gmail.com> * Update docs/sources/datasources/loki/query-editor/index.md Co-authored-by: Matias Chomicki <matyax@gmail.com> * Update docs/sources/datasources/loki/query-editor/index.md Co-authored-by: Matias Chomicki <matyax@gmail.com> * Update docs/sources/datasources/loki/query-editor/index.md Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com> * Update docs/sources/datasources/loki/_index.md Co-authored-by: Jack Baldry <jack.baldry@grafana.com> * made changes suggested in PR --------- Co-authored-by: Matias Chomicki <matyax@gmail.com> Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com> Co-authored-by: Jack Baldry <jack.baldry@grafana.com>pull/72296/head
lwandz13
2 years ago
committed by
GitHub
parent
e4649e7099
commit
443b4b0327
@ -0,0 +1,130 @@ |
||||
--- |
||||
aliases: |
||||
- ../data-sources/loki/ |
||||
- ../features/datasources/loki/ |
||||
description: Configure the Loki data source |
||||
keywords: |
||||
- grafana |
||||
- loki |
||||
- logging |
||||
- guide |
||||
- data source |
||||
menuTitle: Configure Loki |
||||
title: Configure the Loki data source |
||||
weight: 200 |
||||
--- |
||||
|
||||
# Loki data source |
||||
|
||||
Grafana ships with built-in support for [Loki](/docs/loki/latest/), an open-source log aggregation system by Grafana Labs. If you are new to Loki the following documentation will help you get started: |
||||
|
||||
- [Getting started](/docs/loki/latest/getting-started/) |
||||
- [Best practices](/docs/loki/latest/best-practices/#best-practices) |
||||
|
||||
## Configure the Loki data source |
||||
|
||||
To add the Loki data source, complete the following steps: |
||||
|
||||
1. Click **Connections** in the left-side menu. |
||||
1. Under **Connections**, click **Add new connection**. |
||||
1. Enter `Loki` in the search bar. |
||||
1. Select **Loki data source**. |
||||
1. Click **Create a Loki data source** in the upper right. |
||||
|
||||
You will be taken to the **Settings** tab where you will set up your Loki configuration. |
||||
|
||||
## Configuration options |
||||
|
||||
The following is a list of configuration options for Loki. |
||||
|
||||
The first option to configure is the name of your connection: |
||||
|
||||
- **Name** - The data source name. This is how you refer to the data source in panels and queries. Examples: loki-1, loki_logs. |
||||
|
||||
- **Default** - Toggle to select as the default name in dashboard panels. When you go to a dashboard panel this will be the default selected data source. |
||||
|
||||
### HTTP section |
||||
|
||||
- **URL** - The URL of your Loki server. Loki uses port 3100. If your Loki server is local, use `http://localhost:3100`. If it is on a server within a network, this is the URL with port where you are running Loki. Example: `http://loki.example.orgname:3100`. |
||||
|
||||
- **Allowed cookies** - Specify cookies by name that should be forwarded to the data source. The Grafana proxy deletes all forwarded cookies by default. |
||||
|
||||
- **Timeout** - The HTTP request timeout. This must be in seconds. There is no default, so this setting is up to you. |
||||
|
||||
### Auth section |
||||
|
||||
There are several authentication methods you can choose in the Authentication section. |
||||
|
||||
{{% admonition type="note" %}} |
||||
Use TLS (Transport Layer Security) for an additional layer of security when working with Loki. For information on setting up TLS encryption with Loki see [Grafana Loki configuration parameters](/docs/loki/latest/configuration/). |
||||
{{% /admonition %}} |
||||
|
||||
- **Basic authentication** - The most common authentication method. Use your `data source` user name and `data source` password to connect. |
||||
|
||||
- **With credentials** - Toggle on to enable credentials such as cookies or auth headers to be sent with cross-site requests. |
||||
|
||||
- **TLS client authentication** - Toggle on to use client authentication. When enabled, add the `Server name`, `Client cert` and `Client key`. The client provides a certificate that is validated by the server to establish the client's trusted identity. The client key encrypts the data between client and server. |
||||
|
||||
- **With CA cert** - Authenticate with a CA certificate. Follow the instructions of the CA (Certificate Authority) to download the certificate file. |
||||
|
||||
- **Skip TLS verify** - Toggle on to bypass TLS certificate validation. |
||||
|
||||
- **Forward OAuth identity** - Forward the OAuth access token (and also the OIDC ID token if available) of the user querying the data source. |
||||
|
||||
### Custom HTTP headers |
||||
|
||||
- **Header** - Add a custom header. This allows custom headers to be passed based on the needs of your Loki instance. |
||||
|
||||
- **Value** - The value of the header. |
||||
|
||||
### Alerting |
||||
|
||||
- **Manage alert rules in Alerting UI** - Toggle on to manage alert rules for the Loki data source. To manage other alerting resources add an `Alertmanager` data source. |
||||
|
||||
### Queries |
||||
|
||||
- **Maximum lines** - Sets the maximum number of log lines returned by Loki. Increase the limit to have a bigger results set for ad-hoc analysis. Decrease the limit if your browser is sluggish when displaying log results. The default is `1000`. |
||||
|
||||
<!-- {{% admonition type="note" %}} |
||||
To troubleshoot configuration and other issues, check the log file located at `/var/log/grafana/grafana.log` on Unix systems, or in `<grafana_install_dir>/data/log` on other platforms and manual installations. |
||||
{{% /admonition %}} --> |
||||
|
||||
### Derived fields |
||||
|
||||
Derived Fields are used to extract new fields from a log message and create a link from the value of the field. |
||||
|
||||
For example, you can link to your tracing backend directly from your logs, or link to a user profile page if the log line contains a corresponding userId. |
||||
These links appear in the [log details]({{< relref "../../explore/logs-integration/#labels-and-detected-fields" >}}). |
||||
|
||||
You can add multiple derived fields. |
||||
|
||||
{{% admonition type="note" %}} |
||||
If you use Grafana Cloud, you can request modifications to this feature by clicking **Open a Support Ticket** from the Grafana Cloud Portal. |
||||
{{% /admonition %}} |
||||
|
||||
Each derived field consists of the following: |
||||
|
||||
- **Name** - Sets the field name. Displayed as a label in the log details. |
||||
|
||||
- **Regex** - Defines a regular expression to parse a part of the log message and capture it as the value of the new field. Can contain only one capture group. |
||||
|
||||
- **URL/query** Sets the full link URL if the link is external, or a query for the target data source if the link is internal. You can interpolate the value from the field with the `${__value.raw}` macro. |
||||
|
||||
- **URL Label** - Sets a custom display label for the link. This setting overrides the link label, which defaults to the full external URL or name of the linked internal data source. |
||||
|
||||
- **Internal link** - Toggle on to define an internal link. For internal links, you can select the target data source from a selector. This supports only tracing data sources. |
||||
|
||||
- **Show example log message** - Click to paste an example log line to test the regular expression of your derived fields. |
||||
|
||||
Click **Save & test** to test your connection. |
||||
|
||||
#### Troubleshoot interpolation |
||||
|
||||
You can use a debug section to see what your fields extract and how the URL is interpolated. |
||||
Select **Show example log message** to display a text area where you can enter a log message. |
||||
|
||||
{{< figure src="/static/img/docs/v75/loki_derived_fields_settings.png" class="docs-image--no-shadow" max-width="800px" caption="Screenshot of the derived fields debugging" >}} |
||||
|
||||
The new field with the link shown in log details: |
||||
|
||||
{{< figure src="/static/img/docs/explore/data-link-9-4.png" max-width="800px" caption="Data link in Explore" >}} |
||||
Loading…
Reference in new issue