mirror of https://github.com/grafana/loki
[docs] Create top level Send data section, part 2 (#10247)
Part of the database information architecture Epic # 8710 Which issue(s) this PR fixes: Second half of work for issue # 8741 that was started in PR #10192 When closed, fixes #8741 Move the following files under Send data: ./sources/clients/promtail/_index.md ./sources/clients/promtail/configuration.md ./sources/clients/promtail/gcplog-cloud.md ./sources/clients/promtail/installation.md ./sources/clients/promtail/logrotation/_index.md ./sources/clients/promtail/pipelines.md ./sources/clients/promtail/scraping.md ./sources/clients/promtail/stages/_index.md ./sources/clients/promtail/stages/cri.md ./sources/clients/promtail/stages/decolorize.md ./sources/clients/promtail/stages/docker.md ./sources/clients/promtail/stages/drop.md ./sources/clients/promtail/stages/json.md ./sources/clients/promtail/stages/labelallow.md ./sources/clients/promtail/stages/labeldrop.md ./sources/clients/promtail/stages/labels.md ./sources/clients/promtail/stages/limit.md ./sources/clients/promtail/stages/logfmt.md ./sources/clients/promtail/stages/match.md ./sources/clients/promtail/stages/metrics.md ./sources/clients/promtail/stages/multiline.md ./sources/clients/promtail/stages/output.md ./sources/clients/promtail/stages/pack.md ./sources/clients/promtail/stages/regex.md ./sources/clients/promtail/stages/replace.md ./sources/clients/promtail/stages/static_labels.md ./sources/clients/promtail/stages/template.md ./sources/clients/promtail/stages/tenant.md ./sources/clients/promtail/stages/timestamp.md ./sources/clients/promtail/troubleshooting/_index.md This PR also - Revises the Clients landing page to clarify supported clients. - Updates the metadata (descriptions, weights) - Adds aliases to redirect from the old URLs. - Updates cross-references broken by the move/renaming. - A few other small fixes (headings, typos, etc.) **Special notes for your reviewer**: Please review the updates to the Clients landing page (now called Send Data) as I've made some extensive edits to try to clarify recommended/supported clients. The file is docs/sources/send-data/_index.md --------- Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>akhilanarayanan/dountilquorum^2
J Stickler
2 years ago
committed by
GitHub
parent
ec35db458b
commit
d0545bff2d
@ -1,83 +0,0 @@ |
||||
--- |
||||
title: Clients |
||||
description: Grafana Loki clients |
||||
weight: 600 |
||||
--- |
||||
# Clients |
||||
|
||||
Grafana Loki works with the following clients for sending logs: |
||||
|
||||
- [Promtail]({{< relref "./promtail" >}}) |
||||
- [Docker driver]({{< relref "../send-data/docker-driver" >}}). |
||||
- [Fluentd]({{< relref "../send-data/fluentd" >}}) |
||||
- [Fluent Bit]({{< relref "../send-data/fluentbit" >}}) |
||||
- [Logstash]({{< relref "../send-data/logstash" >}}) |
||||
- [Lambda Promtail]({{< relref "../send-data/lambda-promtail" >}}) |
||||
|
||||
There are also a number of third-party clients, see [Unofficial clients](#unofficial-clients). |
||||
|
||||
The [xk6-loki extension](https://github.com/grafana/xk6-loki) permits [load testing Loki]({{< relref "../send-data/k6" >}}). |
||||
|
||||
## Picking a client |
||||
|
||||
While all clients can be used simultaneously to cover multiple use cases, which |
||||
client is initially picked to send logs depends on your use case. |
||||
|
||||
### Promtail |
||||
|
||||
Promtail is the client of choice when you're running Kubernetes, as you can |
||||
configure it to automatically scrape logs from pods running on the same node |
||||
that Promtail runs on. Promtail and Prometheus running together in Kubernetes |
||||
enables powerful debugging: if Prometheus and Promtail use the same labels, |
||||
users can use tools like Grafana to switch between metrics and logs based on the |
||||
label set. |
||||
|
||||
Promtail is also the client of choice on bare-metal since it can be configured |
||||
to tail logs from all files given a host path. It is the easiest way to send |
||||
logs to Loki from plain-text files (e.g., things that log to `/var/log/*.log`). |
||||
|
||||
Lastly, Promtail works well if you want to extract metrics from logs such as |
||||
counting the occurrences of a particular message. |
||||
|
||||
### Docker Logging Driver |
||||
|
||||
When using Docker and not Kubernetes, the Docker logging driver for Loki should |
||||
be used as it automatically adds labels appropriate to the running container. |
||||
|
||||
### Fluentd and Fluent Bit |
||||
|
||||
The Fluentd and Fluent Bit plugins are ideal when you already have Fluentd deployed |
||||
and you already have configured `Parser` and `Filter` plugins. |
||||
|
||||
Fluentd also works well for extracting metrics from logs when using its |
||||
Prometheus plugin. |
||||
|
||||
### Logstash |
||||
|
||||
If you are already using logstash and/or beats, this will be the easiest way to start. |
||||
By adding our output plugin you can quickly try Loki without doing big configuration changes. |
||||
|
||||
### Lambda Promtail |
||||
|
||||
This is a workflow combining the Promtail push-api [scrape config]({{< relref "./promtail/configuration#loki_push_api" >}}) and the [lambda-promtail]({{< relref "../send-data/lambda-promtail" >}}) AWS Lambda function which pipes logs from Cloudwatch to Loki. |
||||
|
||||
This is a good choice if you're looking to try out Loki in a low-footprint way or if you wish to monitor AWS lambda logs in Loki. |
||||
|
||||
## Unofficial clients |
||||
|
||||
Note that the Loki API is not stable yet, so breaking changes might occur |
||||
when using or writing a third-party client. |
||||
|
||||
- [promtail-client](https://github.com/afiskon/promtail-client) (Go) |
||||
- [push-to-loki.py](https://github.com/sleleko/devops-kb/blob/master/python/push-to-loki.py) (Python 3) |
||||
- [python-logging-loki](https://pypi.org/project/python-logging-loki/) (Python 3) |
||||
- [Serilog-Sinks-Loki](https://github.com/JosephWoodward/Serilog-Sinks-Loki) (C#) |
||||
- [NLog-Targets-Loki](https://github.com/corentinaltepe/nlog.loki) (C#) |
||||
- [loki-logback-appender](https://github.com/loki4j/loki-logback-appender) (Java) |
||||
- [Log4j2 appender for Loki](https://github.com/tkowalcz/tjahzi) (Java) |
||||
- [mjaron-tinyloki-java](https://github.com/mjfryc/mjaron-tinyloki-java) (Java) |
||||
- [LokiLogger.jl](https://github.com/JuliaLogging/LokiLogger.jl) (Julia) |
||||
- [winston-loki](https://github.com/JaniAnttonen/winston-loki) (JS) |
||||
- [ilogtail](https://github.com/alibaba/ilogtail) (Go) |
||||
- [Vector Loki Sink](https://vector.dev/docs/reference/configuration/sinks/loki/) |
||||
- [Cribl Loki Destination](https://docs.cribl.io/stream/destinations-loki) |
||||
@ -1,88 +1,59 @@ |
||||
--- |
||||
menuTitle: Send data |
||||
title: Send log data to Loki |
||||
description: Grafana Loki clients |
||||
weight: 600 |
||||
menuTitle: Send data |
||||
description: List of clients that can be used to send log data to Loki. |
||||
aliases: |
||||
- ./clients/ |
||||
weight: 500 |
||||
--- |
||||
# Send log data to Loki |
||||
|
||||
You can use the following clients to send logs to Grafana Loki: |
||||
|
||||
- [Grafana Agent](/docs/agent/latest/) |
||||
- [Promtail]({{< relref "../clients/promtail" >}}) |
||||
-- [Promtail on AWS EC2]({{< relref "./aws/ec2" >}}) |
||||
-- [Promtail on AWS ECS]({{< relref "./aws/ecs" >}}) |
||||
-- [Promtail on AWS EKS]({{< relref "./aws/eks" >}}) |
||||
- [Docker Driver]({{< relref "./docker-driver" >}}) |
||||
- [Fluentd]({{< relref "./fluentd" >}}) |
||||
- [Fluent Bit]({{< relref "./fluentbit" >}}) |
||||
- [Logstash]({{< relref "./logstash" >}}) |
||||
- [Lambda Promtail]({{< relref "./lambda-promtail" >}}) |
||||
|
||||
There are also a number of third-party clients, for a list see [Unofficial clients](#unofficial-clients). |
||||
# Send log data to Loki |
||||
|
||||
The [xk6-loki extension](https://github.com/grafana/xk6-loki) permits [load testing Loki]({{< relref "./k6" >}}). |
||||
There are a number of different clients available to send log data to Loki. |
||||
While all clients can be used simultaneously to cover multiple use cases, which client is initially picked to send logs depends on your use case. |
||||
|
||||
## Picking a client |
||||
## Grafana Clients |
||||
|
||||
While all clients can be used simultaneously to cover multiple use cases, which |
||||
client is initially picked to send logs depends on your use case. |
||||
The following clients are developed and supported (for those customers who have purchased a support contract) by Grafana Labs for sending logs to Loki: |
||||
|
||||
### Promtail |
||||
- [Grafana Agent](/docs/agent/latest/) - The Grafana Agent is the recommended client for the Grafana stack. It can collect telemetry data for metrics, logs, traces, and continuous profiles and is fully compatible with the Prometheus, OpenTelemetry, and Grafana open source ecosystems. |
||||
- [Promtail]({{< relref "./promtail" >}}) - Promtail is the client of choice when you're running Kubernetes, as you can configure it to automatically scrape logs from pods running on the same node that Promtail runs on. Promtail and Prometheus running together in Kubernetes enables powerful debugging: if Prometheus and Promtail use the same labels, users can use tools like Grafana to switch between metrics and logs based on the label set. |
||||
Promtail is also the client of choice on bare-metal since it can be configured to tail logs from all files given a host path. It is the easiest way to send logs to Loki from plain-text files (for example, things that log to `/var/log/*.log`). |
||||
Lastly, Promtail works well if you want to extract metrics from logs such as counting the occurrences of a particular message. |
||||
- [xk6-loki extension](https://github.com/grafana/xk6-loki) - The k6-loki extension lets you perform [load testing on Loki]({{< relref "./k6" >}}). |
||||
|
||||
Promtail is the client of choice when you're running Kubernetes, as you can |
||||
configure it to automatically scrape logs from Pods running on the same node |
||||
that Promtail runs on. Promtail and Prometheus running together in Kubernetes |
||||
enables powerful debugging: if Prometheus and Promtail use the same labels, |
||||
users can use tools like Grafana to switch between metrics and logs based on the |
||||
label set. |
||||
## Third-party clients |
||||
|
||||
Promtail is also the client of choice on bare-metal since it can be configured |
||||
to tail logs from all files given a host path. It is the easiest way to send |
||||
logs to Loki from plain-text files (for example, things that log to `/var/log/*.log`). |
||||
The following clients have been developed by the Loki community or other third-parties and can be used to send log data to Loki. |
||||
|
||||
Lastly, Promtail works well if you want to extract metrics from logs such as |
||||
counting the occurrences of a particular message. |
||||
{{% admonition type="note" %}} |
||||
Grafana Labs cannot provide support for third-party clients. Once an issue has been determined to be with the client and not Loki, it is the responsibility of the customer to work with the associated vendor or project for bug fixes to these clients. |
||||
{{% /admonition %}} |
||||
|
||||
### Docker Logging Driver |
||||
The following are popular third-party Loki clients: |
||||
|
||||
When using Docker and not Kubernetes, the Docker logging driver for Loki should |
||||
- [Docker Driver]({{< relref "./docker-driver" >}}) - When using Docker and not Kubernetes, the Docker logging driver for Loki should |
||||
be used as it automatically adds labels appropriate to the running container. |
||||
|
||||
### Fluentd and Fluent Bit |
||||
|
||||
The Fluentd and Fluent Bit plugins are ideal when you already have Fluentd deployed |
||||
- [Fluent Bit]({{< relref "./fluentbit" >}}) - The Fluent Bit plugin is ideal when you already have Fluentd deployed |
||||
and you already have configured `Parser` and `Filter` plugins. |
||||
|
||||
Fluentd also works well for extracting metrics from logs when using its |
||||
Prometheus plugin. |
||||
|
||||
### Logstash |
||||
|
||||
If you are already using logstash and/or beats, this will be the easiest way to start. |
||||
- [Fluentd]({{< relref "./fluentd" >}}) - The Fluentd plugin is ideal when you already have Fluentd deployed |
||||
and you already have configured `Parser` and `Filter` plugins. Fluentd also works well for extracting metrics from logs when using itsPrometheus plugin. |
||||
- [Lambda Promtail]({{< relref "./lambda-promtail" >}}) - This is a workflow combining the Promtail push-api [scrape config]({{< relref "./promtail/configuration#loki_push_api" >}}) and the [lambda-promtail]({{< relref "./lambda-promtail" >}}) AWS Lambda function which pipes logs from Cloudwatch to Loki. This is a good choice if you're looking to try out Loki in a low-footprint way or if you wish to monitor AWS lambda logs in Loki |
||||
- [Logstash]({{< relref "./logstash" >}}) - If you are already using logstash and/or beats, this will be the easiest way to start. |
||||
By adding our output plugin you can quickly try Loki without doing big configuration changes. |
||||
|
||||
### Lambda Promtail |
||||
|
||||
This is a workflow combining the Promtail push-api [scrape config]({{< relref "../clients/promtail/configuration#loki_push_api" >}}) and the [lambda-promtail]({{< relref "./lambda-promtail" >}}) AWS Lambda function which pipes logs from Cloudwatch to Loki. |
||||
|
||||
This is a good choice if you're looking to try out Loki in a low-footprint way or if you wish to monitor AWS lambda logs in Loki. |
||||
|
||||
## Unofficial clients |
||||
|
||||
Note that the Loki API is not stable yet, so breaking changes might occur |
||||
when using or writing a third-party client. |
||||
These third-party clients also enable sending logs to Loki: |
||||
|
||||
- [Cribl Loki Destination](https://docs.cribl.io/stream/destinations-loki) |
||||
- [ilogtail](https://github.com/alibaba/ilogtail) (Go) |
||||
- [Log4j2 appender for Loki](https://github.com/tkowalcz/tjahzi) (Java) |
||||
- [loki-logback-appender](https://github.com/loki4j/loki-logback-appender) (Java) |
||||
- [LokiLogger.jl](https://github.com/JuliaLogging/LokiLogger.jl) (Julia) |
||||
- [mjaron-tinyloki-java](https://github.com/mjfryc/mjaron-tinyloki-java) (Java) |
||||
- [NLog-Targets-Loki](https://github.com/corentinaltepe/nlog.loki) (C#) |
||||
- [promtail-client](https://github.com/afiskon/promtail-client) (Go) |
||||
- [push-to-loki.py](https://github.com/sleleko/devops-kb/blob/master/python/push-to-loki.py) (Python 3) |
||||
- [python-logging-loki](https://pypi.org/project/python-logging-loki/) (Python 3) |
||||
- [Serilog-Sinks-Loki](https://github.com/JosephWoodward/Serilog-Sinks-Loki) (C#) |
||||
- [NLog-Targets-Loki](https://github.com/corentinaltepe/nlog.loki) (C#) |
||||
- [loki-logback-appender](https://github.com/loki4j/loki-logback-appender) (Java) |
||||
- [Log4j2 appender for Loki](https://github.com/tkowalcz/tjahzi) (Java) |
||||
- [mjaron-tinyloki-java](https://github.com/mjfryc/mjaron-tinyloki-java) (Java) |
||||
- [LokiLogger.jl](https://github.com/JuliaLogging/LokiLogger.jl) (Julia) |
||||
- [winston-loki](https://github.com/JaniAnttonen/winston-loki) (JS) |
||||
- [ilogtail](https://github.com/alibaba/ilogtail) (Go) |
||||
- [Vector Loki Sink](https://vector.dev/docs/reference/configuration/sinks/loki/) |
||||
- [Cribl Loki Destination](https://docs.cribl.io/stream/destinations-loki) |
||||
- [winston-loki](https://github.com/JaniAnttonen/winston-loki) (JS) |
||||
|
||||
@ -1,16 +0,0 @@ |
||||
--- |
||||
title: Sending logs from Amazon Web Services |
||||
menuTitle: Promtail on AWS |
||||
description: Tutorials for sending logs from Amazon Web Services to Loki |
||||
aliases: |
||||
- ../clients/aws/ |
||||
weight: 300 |
||||
--- |
||||
|
||||
# Sending logs from Amazon Web Services |
||||
|
||||
Sending logs from AWS services to Grafana Loki is a little different depending on the AWS service you are using: |
||||
|
||||
* [Elastic Compute Cloud (EC2)]({{< relref "./ec2" >}}) |
||||
* [Elastic Container Service (ECS)]({{< relref "./ecs" >}}) |
||||
* [Elastic Kubernetes Service (EKS)]({{< relref "./eks" >}}) |
||||
@ -0,0 +1,17 @@ |
||||
--- |
||||
title: Sending logs from the cloud |
||||
menuTitle: Configure for cloud |
||||
description: Tutorials for sending logs from cloud services with Promtail. |
||||
aliases: [] |
||||
weight: 300 |
||||
--- |
||||
|
||||
# Sending logs from the cloud |
||||
|
||||
Sending logs from cloud services to Grafana Loki is a little different depending on the AWS service you are using. The following tutorials walk you through configuring cloud services to send logs to Loki. |
||||
|
||||
- [Amazon Elastic Compute Cloud (EC2)]({{< relref "./ec2" >}}) |
||||
- [Amazon Elastic Container Service (ECS)]({{< relref "./ecs" >}}) |
||||
- [Amazon Elastic Kubernetes Service (EKS)]({{< relref "./eks" >}}) |
||||
- [Google Cloud Platform (GCP)]({{< relref "./gcp" >}}) |
||||
|
||||
|
Before Width: | Height: | Size: 862 KiB After Width: | Height: | Size: 862 KiB |
|
Before Width: | Height: | Size: 1.7 MiB After Width: | Height: | Size: 1.7 MiB |
|
Before Width: | Height: | Size: 420 KiB After Width: | Height: | Size: 420 KiB |
|
Before Width: | Height: | Size: 518 KiB After Width: | Height: | Size: 518 KiB |
|
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 224 KiB |
@ -1,8 +1,13 @@ |
||||
--- |
||||
title: Configuration |
||||
description: Configuring Promtail |
||||
title: Configure Promtail |
||||
menuTitle: Configuration reference |
||||
description: Configuration parameters for the Promtail agent. |
||||
aliases: |
||||
- ../../clients/promtail/configuration/ |
||||
weight: 200 |
||||
--- |
||||
# Configuration |
||||
|
||||
# Configure Promtail |
||||
|
||||
Promtail is configured in a YAML file (usually referred to as `config.yaml`) |
||||
which contains information on the Promtail server, where positions are stored, |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: Promtail and Log Rotation |
||||
title: Promtail and Log Rotation |
||||
menuTitle: Configure log rotation |
||||
description: Promtail and Log Rotation |
||||
aliases: |
||||
- ../../clients/promtail/logrotation/ |
||||
weight: 500 |
||||
--- |
||||
|
||||
# Promtail and Log Rotation |
||||
|
||||
## Why does log rotation matter? |
||||
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: Pipelines |
||||
description: Pipelines |
||||
menuTitle: |
||||
description: How to use Promtail pipelines to transform single log lines, labels, and timestamps. |
||||
aliases: |
||||
- ../../clients/promtail/pipelines/ |
||||
weight: 600 |
||||
--- |
||||
|
||||
# Pipelines |
||||
|
||||
A detailed look at how to set up Promtail to process your log lines, including |
||||
@ -1,8 +1,13 @@ |
||||
--- |
||||
title: Stages |
||||
description: Stages |
||||
title: Prometheus pipeline stages |
||||
menuTitle: Pipeline stages |
||||
description: Overview of the Promtail pipeline stages. |
||||
aliases: |
||||
- ../../clients/promtail/stages/ |
||||
weight: 700 |
||||
--- |
||||
# Stages |
||||
|
||||
# Prometheus pipeline stages |
||||
|
||||
This section is a collection of all stages Promtail supports in a |
||||
[Pipeline]({{< relref "../pipelines" >}}). |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: cri |
||||
description: cri stage |
||||
menuTitle: |
||||
description: The 'cri' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/cri/ |
||||
weight: |
||||
--- |
||||
|
||||
# cri |
||||
|
||||
The `cri` stage is a parsing stage that reads the log line using the standard CRI logging format. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: decolorize |
||||
description: decolorize stage |
||||
menuTitle: |
||||
description: The 'decolorize' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/decolorize/ |
||||
weight: |
||||
--- |
||||
|
||||
# decolorize |
||||
|
||||
The `decolorize` stage is a transform stage that lets you strip |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: docker |
||||
description: docker stage |
||||
menuTitle: |
||||
description: The 'decolorize' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/docker/ |
||||
weight: |
||||
--- |
||||
|
||||
# docker |
||||
|
||||
The `docker` stage is a parsing stage that reads log lines in the standard |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: drop |
||||
description: drop stage |
||||
menuTitle: |
||||
description: The 'drop' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/drop/ |
||||
weight: |
||||
--- |
||||
|
||||
# drop |
||||
|
||||
The `drop` stage is a filtering stage that lets you drop logs based on several options. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: eventlogmessage |
||||
description: eventlogmessage stage |
||||
menuTitle: |
||||
description: The 'eventlogmessage' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/eventlogmessage/ |
||||
weight: |
||||
--- |
||||
|
||||
# eventlogmessage |
||||
|
||||
The `eventlogmessage` stage is a parsing stage that extracts data from the Message string that appears in the Windows Event Log. |
||||
@ -1,12 +1,15 @@ |
||||
--- |
||||
title: geoip |
||||
description: geoip stage |
||||
menuTitle: |
||||
description: The 'geoip' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/geoip/ |
||||
weight: |
||||
--- |
||||
# geoip |
||||
|
||||
The `geoip` stage is a parsing stage that reads an ip address and |
||||
# geoip |
||||
|
||||
populates the labelset with geoip fields. [Maxmind's GeoIP2 database](https://www.maxmind.com/en/home) is used for the lookup. |
||||
The `geoip` stage is a parsing stage that reads an ip address and populates the labelset with geoip fields. [Maxmind's GeoIP2 database](https://www.maxmind.com/en/home) is used for the lookup. |
||||
|
||||
Populated fields for City db: |
||||
|
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: json |
||||
description: json stage |
||||
menuTitle: |
||||
description: The 'json' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/json/ |
||||
weight: |
||||
--- |
||||
|
||||
# json |
||||
|
||||
The `json` stage is a parsing stage that reads the log line as JSON and accepts |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: labelallow |
||||
description: labelallow stage |
||||
menuTitle: |
||||
description: The 'labelallow' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/labelallow/ |
||||
weight: |
||||
--- |
||||
|
||||
# labelallow |
||||
|
||||
The labelallow stage is an action stage that allows only the provided labels |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: labeldrop |
||||
description: labeldrop stage |
||||
menuTitle: |
||||
description: The 'labeldrop' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/labeldrop/ |
||||
weight: |
||||
--- |
||||
|
||||
# labeldrop |
||||
|
||||
The labeldrop stage is an action stage that drops labels from |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: labels |
||||
description: labels stage |
||||
menuTitle: |
||||
description: The 'labels' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/labels/ |
||||
weight: |
||||
--- |
||||
|
||||
# labels |
||||
|
||||
The labels stage is an action stage that takes data from the extracted map and |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: limit |
||||
description: limit stage |
||||
menuTitle: |
||||
description: The 'limit' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/limit/ |
||||
weight: |
||||
--- |
||||
|
||||
# limit |
||||
|
||||
The `limit` stage is a rate-limiting stage that throttles logs based on several options. |
||||
@ -1,8 +1,12 @@ |
||||
--- |
||||
title: logfmt |
||||
menuTitle: logfmt |
||||
description: The logfmt parsing stage reads logfmt log lines and extracts the data into labels. |
||||
menuTitle: |
||||
description: The 'logfmt' Promtail pipeline stage. The logfmt parsing stage reads logfmt log lines and extracts the data into labels. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/logfmt/ |
||||
weight: |
||||
--- |
||||
|
||||
# logfmt |
||||
|
||||
The `logfmt` stage is a parsing stage that reads the log line as [logfmt](https://brandur.org/logfmt) and allows extraction of data into labels. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: match |
||||
description: match stage |
||||
menuTitle: |
||||
description: The 'match' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/match/ |
||||
weight: |
||||
--- |
||||
|
||||
# match |
||||
|
||||
The match stage is a filtering stage that conditionally applies a set of stages |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: metrics |
||||
description: metrics stage |
||||
menuTitle: |
||||
description: The 'metrics' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/metrics/ |
||||
weight: |
||||
--- |
||||
|
||||
# metrics |
||||
|
||||
The `metrics` stage is an action stage that allows for defining and updating |
||||
@ -1,6 +1,10 @@ |
||||
--- |
||||
title: multiline |
||||
description: multiline stage |
||||
menuTitle: |
||||
description: The 'multiline' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/multiline/ |
||||
weight: |
||||
--- |
||||
|
||||
# multiline |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: output |
||||
description: output stage |
||||
menuTitle: |
||||
description: The 'output' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/output/ |
||||
weight: |
||||
--- |
||||
|
||||
# output |
||||
|
||||
The `output` stage is an action stage that takes data from the extracted map and |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: pack |
||||
description: pack stage |
||||
menuTitle: |
||||
description: The 'pack' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/pack/ |
||||
weight: |
||||
--- |
||||
|
||||
# pack |
||||
|
||||
The `pack` stage is a transform stage which lets you embed extracted values and labels into the log line by packing the log line and labels inside a JSON object. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: regex |
||||
description: regex stage |
||||
menuTitle: |
||||
description: The 'regex' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/regex/ |
||||
weight: |
||||
--- |
||||
|
||||
# regex |
||||
|
||||
The `regex` stage is a parsing stage that parses a log line using a regular |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: replace |
||||
description: replace stage |
||||
menuTitle: |
||||
description: The 'replace' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/replace/ |
||||
weight: |
||||
--- |
||||
|
||||
# replace |
||||
|
||||
The `replace` stage is a parsing stage that parses a log line using a regular |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: sampling |
||||
description: sampling stage |
||||
menuTitle: |
||||
description: The 'sampling' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/sampling/ |
||||
weight: |
||||
--- |
||||
|
||||
# sampling |
||||
|
||||
The `sampling` stage is a stage that sampling logs. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: static_labels |
||||
description: static_labels stage |
||||
menuTitle: |
||||
description: The 'static_labels' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/static_labels/ |
||||
weight: |
||||
--- |
||||
|
||||
# static_labels |
||||
|
||||
The static_labels stage is an action stage that adds static-labels to the label set that is sent to Loki with the log entry. |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: template |
||||
description: template stage |
||||
menuTitle: |
||||
description: The 'template' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/template/ |
||||
weight: |
||||
--- |
||||
|
||||
# template |
||||
|
||||
The `template` stage is a transform stage that lets use manipulate the values in |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: tenant |
||||
description: tenant stage |
||||
menuTitle: |
||||
description: The 'tenant' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/tenant/ |
||||
weight: |
||||
--- |
||||
|
||||
# tenant |
||||
|
||||
The tenant stage is an action stage that sets the tenant ID for the log entry |
||||
@ -1,7 +1,12 @@ |
||||
--- |
||||
title: timestamp |
||||
description: timestamp stage |
||||
menuTitle: |
||||
description: The 'timestamp' Promtail pipeline stage. |
||||
aliases: |
||||
- ../../../clients/promtail/stages/timestamp/ |
||||
weight: |
||||
--- |
||||
|
||||
# timestamp |
||||
|
||||
The `timestamp` stage is an action stage that can change the timestamp of a log |
||||
@ -1,8 +1,12 @@ |
||||
--- |
||||
title: Troubleshooting |
||||
description: Troubleshooting Promtail |
||||
title: Troubleshooting Promtail |
||||
menuTitle: Troubleshooting |
||||
description: Troubleshooting the Promtail agent |
||||
aliases: |
||||
- ../../clients/promtail/troubleshooting/ |
||||
weight: 800 |
||||
--- |
||||
# Troubleshooting |
||||
# Troubleshooting Promtail |
||||
|
||||
This document describes known failure modes of Promtail on edge cases and the |
||||
adopted trade-offs. |
||||
|
Before Width: | Height: | Size: 119 KiB After Width: | Height: | Size: 119 KiB |
Loading…
Reference in new issue