From 9ca53aaf0f07576d6dc5dfdb74d29a6c1f32df31 Mon Sep 17 00:00:00 2001 From: J Stickler Date: Wed, 12 Feb 2025 15:39:17 -0500 Subject: [PATCH] docs: adding Promtail deprecation banners (#16227) (cherry picked from commit b8b3ed1784f936d7903382694679db11a246e6ca) --- docs/sources/send-data/_index.md | 12 +++--- docs/sources/send-data/promtail/_index.md | 38 +++++++++---------- .../send-data/promtail/cloud/_index.md | 2 + .../send-data/promtail/cloud/ec2/_index.md | 2 + .../send-data/promtail/cloud/ecs/_index.md | 2 + .../send-data/promtail/cloud/eks/_index.md | 2 + .../send-data/promtail/cloud/gcp/_index.md | 2 + .../send-data/promtail/configuration.md | 2 + .../send-data/promtail/installation.md | 4 +- .../send-data/promtail/logrotation/_index.md | 2 + docs/sources/send-data/promtail/pipelines.md | 2 + docs/sources/send-data/promtail/scraping.md | 2 + .../send-data/promtail/stages/_index.md | 2 + docs/sources/send-data/promtail/stages/cri.md | 2 + .../send-data/promtail/stages/decolorize.md | 2 + .../send-data/promtail/stages/docker.md | 2 + .../sources/send-data/promtail/stages/drop.md | 2 + .../promtail/stages/eventlogmessage.md | 2 + .../send-data/promtail/stages/geoip.md | 2 + .../sources/send-data/promtail/stages/json.md | 2 + .../send-data/promtail/stages/labelallow.md | 2 + .../send-data/promtail/stages/labeldrop.md | 2 + .../send-data/promtail/stages/labels.md | 2 + .../send-data/promtail/stages/limit.md | 2 + .../send-data/promtail/stages/logfmt.md | 2 + .../send-data/promtail/stages/match.md | 2 + .../send-data/promtail/stages/metrics.md | 2 + .../send-data/promtail/stages/multiline.md | 2 + .../send-data/promtail/stages/output.md | 2 + .../sources/send-data/promtail/stages/pack.md | 2 + .../send-data/promtail/stages/regex.md | 2 + .../send-data/promtail/stages/replace.md | 2 + .../send-data/promtail/stages/sampling.md | 2 + .../promtail/stages/static_labels.md | 2 + .../promtail/stages/structured_metadata.md | 2 + .../send-data/promtail/stages/template.md | 2 + .../send-data/promtail/stages/tenant.md | 2 + .../send-data/promtail/stages/timestamp.md | 2 + .../promtail/troubleshooting/_index.md | 5 ++- docs/sources/shared/promtail-deprecation.md | 14 +++++++ 40 files changed, 112 insertions(+), 31 deletions(-) create mode 100644 docs/sources/shared/promtail-deprecation.md diff --git a/docs/sources/send-data/_index.md b/docs/sources/send-data/_index.md index 08ef70b014ab0..19bbe5fc7a14d 100644 --- a/docs/sources/send-data/_index.md +++ b/docs/sources/send-data/_index.md @@ -20,13 +20,13 @@ The following clients are developed and supported (for those customers who have - [Grafana Alloy](https://grafana.com/docs/alloy/latest/) - Grafana Alloy is a vendor-neutral distribution of the OpenTelemetry (OTel) Collector. Alloy offers native pipelines for OTel, Prometheus, Pyroscope, Loki, and many other metrics, logs, traces, and profile tools. In addition, you can use Alloy pipelines to do different tasks, such as configure alert rules in Loki and Mimir. Alloy is fully compatible with the OTel Collector, Prometheus Agent, and Promtail. You can use Alloy as an alternative to either of these solutions or combine it into a hybrid system of multiple collectors and agents. You can deploy Alloy anywhere within your IT infrastructure and pair it with your Grafana LGTM stack, a telemetry backend from Grafana Cloud, or any other compatible backend from any other vendor. {{< docs/shared source="alloy" lookup="agent-deprecation.md" version="next" >}} -- [Grafana Agent](/docs/agent/latest/) - The Grafana Agent is a 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](https://grafana.com/docs/loki//send-data/promtail/) - Promtail can be configured to automatically scrape logs from Kubernetes 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 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`). -Promtail works well if you want to extract metrics from logs such as counting the occurrences of a particular message. -{{< admonition type="note" >}} -Promtail is feature complete. All future feature development will occur in Grafana Alloy. -{{< /admonition >}} - [xk6-loki extension](https://github.com/grafana/xk6-loki) - The k6-loki extension lets you perform [load testing on Loki](https://grafana.com/docs/loki//send-data/k6/). +- [Grafana Agent](/docs/agent/latest/) (DEPRECATED) - The Grafana Agent is a 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](https://grafana.com/docs/loki//send-data/promtail/) (DEPRECATED) - Promtail can be configured to automatically scrape logs from Kubernetes pods running on the same node that Promtail runs on. +{{< admonition type="caution" >}} +Promtail is deprecated. If you are currently using Promtail, you should plan your [migration to Alloy](https://grafana.com/docs/loki//setup/migrate/migrate-to-alloy/). All future feature development will occur in Grafana Alloy. +{{< /admonition >}} + ## OpenTelemetry Collector diff --git a/docs/sources/send-data/promtail/_index.md b/docs/sources/send-data/promtail/_index.md index 05eec7dc43d38..545ba39e68970 100644 --- a/docs/sources/send-data/promtail/_index.md +++ b/docs/sources/send-data/promtail/_index.md @@ -8,14 +8,16 @@ weight: 300 --- # Promtail agent +{{< admonition type="caution" >}} +Promtail is now deprecated and will enter into Long-Term Support (LTS) beginning Feb. 13, 2025. This means that Promtail will no longer receive any new feature updates, but it will receive critical bug fixes and security fixes. Commercial support will end after the LTS phase, which we anticipate will extend for about 12 months until February 28, 2026. End-of-Life (EOL) phase for Promtail will begin once LTS ends. Promtail is expected to reach EOL on March 2, 2026, afterwards no future support or updates will be provided. All future feature development will occur in Grafana Alloy. + +If you are currently using Promtail, you should plan your [migration to Alloy](https://grafana.com/docs/loki//setup/migrate/migrate-to-alloy/). The Alloy migration documentation includes a migration tool for converting your Promtail configuration to an Alloy configuration with a single command. +{{< /admonition >}} + Promtail is an agent which ships the contents of local logs to a private Grafana Loki instance or [Grafana Cloud](/oss/loki). It is usually deployed to every machine that runs applications which need to be monitored. -{{< admonition type="note" >}} -Promtail is feature complete. All future feature development will occur in Grafana Alloy. -{{< /admonition >}} - It primarily: - Discovers targets @@ -74,12 +76,13 @@ scrape_configs: ``` Important details are: -* It relies on the `\n` character to separate the data into different log lines. -* The max expected log line is 2MB within the compressed file. -* The data is decompressed in blocks of 4096 bytes. i.e: it first fetches a block of 4096 bytes + +- It relies on the `\n` character to separate the data into different log lines. +- The max expected log line is 2MB within the compressed file. +- The data is decompressed in blocks of 4096 bytes. i.e: it first fetches a block of 4096 bytes from the compressed file and processes it. After processing this block and pushing the data to Loki, it fetches the following 4096 bytes, and so on. -* It supports the following extensions: +- It supports the following extensions: - `.gz`: Data will be decompressed with the native Gunzip Golang pkg (`pkg/compress/gzip`) - `.z`: Data will be decompressed with the native Zlib Golang pkg (`pkg/compress/zlib`) - `.bz2`: Data will be decompressed with the native Bzip2 Golang pkg (`pkg/compress/bzip2`) @@ -88,25 +91,20 @@ Important details are: compressed file, **the first parsed line will contains metadata together with your log line**. It is illustrated at `./clients/pkg/promtail/targets/file/decompresser_test.go`. -* `.zip` extension isn't supported as of now because it doesn't support some of the interfaces - Promtail requires. We have plans to add support for it in the near future. -* The decompression is quite CPU intensive and a lot of allocations are expected +- `.zip` extension isn't supported as of now because it doesn't support some of the interfaces + Promtail requires. +- The decompression is quite CPU intensive and a lot of allocations are expected to occur, especially depending on the size of the file. You can expect the number of garbage collection runs and the CPU usage to skyrocket, but no memory leak is expected. -* Positions are supported. That means that, if you interrupt Promtail after +- Positions are supported. That means that, if you interrupt Promtail after parsing and pushing (for example) 45% of your compressed file data, you can expect Promtail to resume work from the last scraped line and process the rest of the remaining 55%. -* Since decompression and pushing can be very fast, depending on the size +- Since decompression and pushing can be very fast, depending on the size of your compressed file Loki will rate-limit your ingestion. In that case you might configure Promtail's [`limits` stage](https://grafana.com/docs/loki//send-data/promtail/configuration/#limits_config) to slow the pace or increase [ingestion limits](https://grafana.com/docs/loki//configure/#limits_config) on Loki. - -* Log rotations on compressed files **are not supported as of now** (log rotation is fully supported for normal files), mostly because it requires us modifying Promtail to - rely on file inodes instead of file names. If you'd like to see support for it, create a new - issue on Github asking for it and explaining your use case. -* If you compress a file under a folder being scraped, Promtail might try to ingest your file before you finish compressing it. To avoid it, pick a `initial_delay` that is enough to avoid it. -* If you would like to see support for a compression protocol that isn't listed here, create a new issue on Github asking for it and explaining your use case. - +- Log rotations on compressed files are not supported (log rotation is fully supported for normal files), mostly because it requires us modifying Promtail to rely on file inodes instead of file names. +- If you compress a file under a folder being scraped, Promtail might try to ingest your file before you finish compressing it. To avoid it, pick a `initial_delay` that is enough to avoid it. ## Loki Push API diff --git a/docs/sources/send-data/promtail/cloud/_index.md b/docs/sources/send-data/promtail/cloud/_index.md index 87b450be37634..45377aa16421a 100644 --- a/docs/sources/send-data/promtail/cloud/_index.md +++ b/docs/sources/send-data/promtail/cloud/_index.md @@ -8,6 +8,8 @@ weight: 300 # Sending logs from the cloud +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + 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" >}}) diff --git a/docs/sources/send-data/promtail/cloud/ec2/_index.md b/docs/sources/send-data/promtail/cloud/ec2/_index.md index 3c4dea7565400..a554c6289c62a 100644 --- a/docs/sources/send-data/promtail/cloud/ec2/_index.md +++ b/docs/sources/send-data/promtail/cloud/ec2/_index.md @@ -11,6 +11,8 @@ weight: 100 In this tutorial we're going to setup [Promtail]({{< relref "../../../../send-data/promtail" >}}) on an AWS EC2 instance and configure it to sends all its logs to a Grafana Loki instance. +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + ## Requirements Before you start you'll need: diff --git a/docs/sources/send-data/promtail/cloud/ecs/_index.md b/docs/sources/send-data/promtail/cloud/ecs/_index.md index 1375efea1f16c..dfa69293f24b2 100644 --- a/docs/sources/send-data/promtail/cloud/ecs/_index.md +++ b/docs/sources/send-data/promtail/cloud/ecs/_index.md @@ -11,6 +11,8 @@ weight: 100 [ECS][ECS] is the fully managed container orchestration service by Amazon. Combined with [Fargate][Fargate] you can run your container workload without the need to provision your own compute resources. In this tutorial we will see how you can leverage [Firelens][Firelens] an AWS log router to forward all your logs and your workload metadata to a Grafana Loki instance. +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + After this tutorial you will able to query all your logs in one place using Grafana. ## Requirements diff --git a/docs/sources/send-data/promtail/cloud/eks/_index.md b/docs/sources/send-data/promtail/cloud/eks/_index.md index 8811f41d08198..c867d1341b316 100644 --- a/docs/sources/send-data/promtail/cloud/eks/_index.md +++ b/docs/sources/send-data/promtail/cloud/eks/_index.md @@ -11,6 +11,8 @@ weight: 100 In this tutorial we'll see how to set up Promtail on [EKS][eks]. Amazon Elastic Kubernetes Service (Amazon [EKS][eks]) is a fully managed Kubernetes service, using Promtail we'll get full visibility into our cluster logs. We'll start by forwarding pods logs then nodes services and finally Kubernetes events. +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + After this tutorial you will able to query all your logs in one place using Grafana. ## Requirements diff --git a/docs/sources/send-data/promtail/cloud/gcp/_index.md b/docs/sources/send-data/promtail/cloud/gcp/_index.md index 89ecec4a4be06..2267fdcccbac2 100644 --- a/docs/sources/send-data/promtail/cloud/gcp/_index.md +++ b/docs/sources/send-data/promtail/cloud/gcp/_index.md @@ -11,6 +11,8 @@ weight: This document explains how one can setup Google Cloud Platform to forward its cloud resource logs from a particular GCP project into Google Pubsub topic so that is available for Promtail to consume. +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + This document assumes, that reader have `gcloud` installed and have the required permissions (as mentioned in [Roles and Permission](#roles-and-permission) section). There are two flavours of how to configure this: diff --git a/docs/sources/send-data/promtail/configuration.md b/docs/sources/send-data/promtail/configuration.md index 0cd4d4eccc431..3472baaeb37ae 100644 --- a/docs/sources/send-data/promtail/configuration.md +++ b/docs/sources/send-data/promtail/configuration.md @@ -9,6 +9,8 @@ weight: 200 # Configure Promtail +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + Promtail is configured in a YAML file (usually referred to as `config.yaml`) which contains information on the Promtail server, where positions are stored, and how to scrape logs from files. diff --git a/docs/sources/send-data/promtail/installation.md b/docs/sources/send-data/promtail/installation.md index 2de8d90371e10..b499660cecc4b 100644 --- a/docs/sources/send-data/promtail/installation.md +++ b/docs/sources/send-data/promtail/installation.md @@ -9,9 +9,7 @@ weight: 100 # Install Promtail -{{< admonition type="note" >}} -Promtail is feature complete. All future feature development will occur in Grafana Alloy. -{{< /admonition >}} +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} Promtail is distributed as a binary, in a Docker container, or there is a Helm chart to install it in a Kubernetes cluster. diff --git a/docs/sources/send-data/promtail/logrotation/_index.md b/docs/sources/send-data/promtail/logrotation/_index.md index 24e93fbc2a8c4..2408f939586a7 100644 --- a/docs/sources/send-data/promtail/logrotation/_index.md +++ b/docs/sources/send-data/promtail/logrotation/_index.md @@ -9,6 +9,8 @@ weight: 500 # Promtail and Log Rotation +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + ## Why does log rotation matter? At any point in time, there may be three processes working on a log file as shown in the image below. diff --git a/docs/sources/send-data/promtail/pipelines.md b/docs/sources/send-data/promtail/pipelines.md index cee217a88987a..db48f88161a64 100644 --- a/docs/sources/send-data/promtail/pipelines.md +++ b/docs/sources/send-data/promtail/pipelines.md @@ -9,6 +9,8 @@ weight: 600 # Pipelines +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + A detailed look at how to set up Promtail to process your log lines, including extracting metrics and labels. diff --git a/docs/sources/send-data/promtail/scraping.md b/docs/sources/send-data/promtail/scraping.md index 605bdeb5aaac4..f490d6a188660 100644 --- a/docs/sources/send-data/promtail/scraping.md +++ b/docs/sources/send-data/promtail/scraping.md @@ -9,6 +9,8 @@ weight: 400 # Configuring Promtail for service discovery +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + Promtail currently supports scraping from the following sources: - [Azure event hubs]({{< relref "#azure-event-hubs" >}}) diff --git a/docs/sources/send-data/promtail/stages/_index.md b/docs/sources/send-data/promtail/stages/_index.md index 1530fedd4ad1b..b8275d5080094 100644 --- a/docs/sources/send-data/promtail/stages/_index.md +++ b/docs/sources/send-data/promtail/stages/_index.md @@ -9,6 +9,8 @@ weight: 700 # Promtail pipeline stages +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + This section is a collection of all stages Promtail supports in a [Pipeline]({{< relref "../pipelines" >}}). diff --git a/docs/sources/send-data/promtail/stages/cri.md b/docs/sources/send-data/promtail/stages/cri.md index c78c92c8029e7..8b7a75bd58a24 100644 --- a/docs/sources/send-data/promtail/stages/cri.md +++ b/docs/sources/send-data/promtail/stages/cri.md @@ -9,6 +9,8 @@ weight: # cri +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `cri` stage is a parsing stage that reads the log line using the standard CRI logging format. ## Schema diff --git a/docs/sources/send-data/promtail/stages/decolorize.md b/docs/sources/send-data/promtail/stages/decolorize.md index 0d7baae0efadc..7b653ffc82cb9 100644 --- a/docs/sources/send-data/promtail/stages/decolorize.md +++ b/docs/sources/send-data/promtail/stages/decolorize.md @@ -9,6 +9,8 @@ weight: # decolorize +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `decolorize` stage is a transform stage that lets you strip ANSI color codes from the log line, thus making it easier to parse logs further. diff --git a/docs/sources/send-data/promtail/stages/docker.md b/docs/sources/send-data/promtail/stages/docker.md index 4256b3304b057..b1d682525c279 100644 --- a/docs/sources/send-data/promtail/stages/docker.md +++ b/docs/sources/send-data/promtail/stages/docker.md @@ -9,6 +9,8 @@ weight: # docker +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `docker` stage is a parsing stage that reads log lines in the standard format of Docker log files. diff --git a/docs/sources/send-data/promtail/stages/drop.md b/docs/sources/send-data/promtail/stages/drop.md index 0c6c15a1feda9..d6eba38b67b2d 100644 --- a/docs/sources/send-data/promtail/stages/drop.md +++ b/docs/sources/send-data/promtail/stages/drop.md @@ -9,6 +9,8 @@ weight: # drop +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `drop` stage is a filtering stage that lets you drop logs based on several options. It's important to note that if you provide multiple options they will be treated like an AND clause, diff --git a/docs/sources/send-data/promtail/stages/eventlogmessage.md b/docs/sources/send-data/promtail/stages/eventlogmessage.md index 4323333942152..c3346f39c5bd3 100644 --- a/docs/sources/send-data/promtail/stages/eventlogmessage.md +++ b/docs/sources/send-data/promtail/stages/eventlogmessage.md @@ -9,6 +9,8 @@ weight: # eventlogmessage +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `eventlogmessage` stage is a parsing stage that extracts data from the Message string that appears in the Windows Event Log. ## Schema diff --git a/docs/sources/send-data/promtail/stages/geoip.md b/docs/sources/send-data/promtail/stages/geoip.md index 769bb3908b98e..2f8d8b7aab0a5 100644 --- a/docs/sources/send-data/promtail/stages/geoip.md +++ b/docs/sources/send-data/promtail/stages/geoip.md @@ -9,6 +9,8 @@ weight: # geoip +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + 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: diff --git a/docs/sources/send-data/promtail/stages/json.md b/docs/sources/send-data/promtail/stages/json.md index 79a4c2438fb8d..f8ccd65386322 100644 --- a/docs/sources/send-data/promtail/stages/json.md +++ b/docs/sources/send-data/promtail/stages/json.md @@ -9,6 +9,8 @@ weight: # json +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `json` stage is a parsing stage that reads the log line as JSON and accepts [JMESPath](http://jmespath.org/) expressions to extract data. diff --git a/docs/sources/send-data/promtail/stages/labelallow.md b/docs/sources/send-data/promtail/stages/labelallow.md index a83659c3d451f..d6a55352e5237 100644 --- a/docs/sources/send-data/promtail/stages/labelallow.md +++ b/docs/sources/send-data/promtail/stages/labelallow.md @@ -9,6 +9,8 @@ weight: # labelallow +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The labelallow stage is an action stage that allows only the provided labels to be included in the label set that is sent to Loki with the log entry. diff --git a/docs/sources/send-data/promtail/stages/labeldrop.md b/docs/sources/send-data/promtail/stages/labeldrop.md index d552c9e34edec..0353fd671453b 100644 --- a/docs/sources/send-data/promtail/stages/labeldrop.md +++ b/docs/sources/send-data/promtail/stages/labeldrop.md @@ -9,6 +9,8 @@ weight: # labeldrop +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The labeldrop stage is an action stage that drops labels from the label set that is sent to Loki with the log entry. diff --git a/docs/sources/send-data/promtail/stages/labels.md b/docs/sources/send-data/promtail/stages/labels.md index d996f2154302f..61f2e8694e82b 100644 --- a/docs/sources/send-data/promtail/stages/labels.md +++ b/docs/sources/send-data/promtail/stages/labels.md @@ -9,6 +9,8 @@ weight: # labels +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The labels stage is an action stage that takes data from the extracted map and modifies the label set that is sent to Loki with the log entry. diff --git a/docs/sources/send-data/promtail/stages/limit.md b/docs/sources/send-data/promtail/stages/limit.md index c4612431b0f2a..675c9cf583758 100644 --- a/docs/sources/send-data/promtail/stages/limit.md +++ b/docs/sources/send-data/promtail/stages/limit.md @@ -9,6 +9,8 @@ weight: # limit +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `limit` stage is a rate-limiting stage that throttles logs based on several options. ## Limit stage schema diff --git a/docs/sources/send-data/promtail/stages/logfmt.md b/docs/sources/send-data/promtail/stages/logfmt.md index d625929983e2c..554941beb0a61 100644 --- a/docs/sources/send-data/promtail/stages/logfmt.md +++ b/docs/sources/send-data/promtail/stages/logfmt.md @@ -9,6 +9,8 @@ weight: # logfmt +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + 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. ## Schema diff --git a/docs/sources/send-data/promtail/stages/match.md b/docs/sources/send-data/promtail/stages/match.md index c76a3a8dc8340..e4f3dca3198a4 100644 --- a/docs/sources/send-data/promtail/stages/match.md +++ b/docs/sources/send-data/promtail/stages/match.md @@ -9,6 +9,8 @@ weight: # match +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The match stage is a filtering stage that conditionally applies a set of stages or drop entries when a log entry matches a configurable LogQL [stream selector]({{< relref "../../../query/log_queries#log-stream-selector" >}}) and diff --git a/docs/sources/send-data/promtail/stages/metrics.md b/docs/sources/send-data/promtail/stages/metrics.md index ea1c7b78150c5..b9572eae6504c 100644 --- a/docs/sources/send-data/promtail/stages/metrics.md +++ b/docs/sources/send-data/promtail/stages/metrics.md @@ -9,6 +9,8 @@ weight: # metrics +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `metrics` stage is an action stage that allows for defining and updating metrics based on data from the extracted map. Note that created metrics are not pushed to Loki and are instead exposed via Promtail's `/metrics` endpoint. diff --git a/docs/sources/send-data/promtail/stages/multiline.md b/docs/sources/send-data/promtail/stages/multiline.md index d22e90246da59..088e9c6e181bd 100644 --- a/docs/sources/send-data/promtail/stages/multiline.md +++ b/docs/sources/send-data/promtail/stages/multiline.md @@ -9,6 +9,8 @@ weight: # multiline +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `multiline` stage merges multiple lines into a multiline block before passing it on to the next stage in the pipeline. A new block is identified by the `firstline` regular expression. Any line that does *not* match the expression is considered to be part of the block of the previous match. diff --git a/docs/sources/send-data/promtail/stages/output.md b/docs/sources/send-data/promtail/stages/output.md index e9e01023fd5b0..f997e8f6b8b35 100644 --- a/docs/sources/send-data/promtail/stages/output.md +++ b/docs/sources/send-data/promtail/stages/output.md @@ -9,6 +9,8 @@ weight: # output +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `output` stage is an action stage that takes data from the extracted map and changes the log line that will be sent to Loki. diff --git a/docs/sources/send-data/promtail/stages/pack.md b/docs/sources/send-data/promtail/stages/pack.md index 405214f4774db..d7acac3563a74 100644 --- a/docs/sources/send-data/promtail/stages/pack.md +++ b/docs/sources/send-data/promtail/stages/pack.md @@ -9,6 +9,8 @@ weight: # pack +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + 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. For example, if you wanted to remove the labels `container` and `pod` but still wanted to keep their values you could use this stage to create the following output: diff --git a/docs/sources/send-data/promtail/stages/regex.md b/docs/sources/send-data/promtail/stages/regex.md index 26800e020eadd..4294fb8c76991 100644 --- a/docs/sources/send-data/promtail/stages/regex.md +++ b/docs/sources/send-data/promtail/stages/regex.md @@ -9,6 +9,8 @@ weight: # regex +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `regex` stage is a parsing stage that parses a log line using a regular expression. Named capture groups in the regex support adding data into the extracted map. diff --git a/docs/sources/send-data/promtail/stages/replace.md b/docs/sources/send-data/promtail/stages/replace.md index 1d9585bcf441d..d12e6d3626eaf 100644 --- a/docs/sources/send-data/promtail/stages/replace.md +++ b/docs/sources/send-data/promtail/stages/replace.md @@ -9,6 +9,8 @@ weight: # replace +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `replace` stage is a parsing stage that parses a log line using a regular expression and replaces the log line. Named capture groups in the regex support adding data into the extracted map. diff --git a/docs/sources/send-data/promtail/stages/sampling.md b/docs/sources/send-data/promtail/stages/sampling.md index 00127b431dd57..bf2ed7fd6fe9d 100644 --- a/docs/sources/send-data/promtail/stages/sampling.md +++ b/docs/sources/send-data/promtail/stages/sampling.md @@ -9,6 +9,8 @@ weight: # sampling +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `sampling` stage is a stage that sampling logs. ## Sampling stage schema diff --git a/docs/sources/send-data/promtail/stages/static_labels.md b/docs/sources/send-data/promtail/stages/static_labels.md index deb638e95cdca..794d3197b5c5d 100644 --- a/docs/sources/send-data/promtail/stages/static_labels.md +++ b/docs/sources/send-data/promtail/stages/static_labels.md @@ -9,6 +9,8 @@ weight: # static_labels +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + 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. ## Schema diff --git a/docs/sources/send-data/promtail/stages/structured_metadata.md b/docs/sources/send-data/promtail/stages/structured_metadata.md index 129dd757c4a25..8952f55b9d239 100644 --- a/docs/sources/send-data/promtail/stages/structured_metadata.md +++ b/docs/sources/send-data/promtail/stages/structured_metadata.md @@ -5,6 +5,8 @@ description: The 'structured_metadata' Promtail pipeline stage # structured_metadata +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `structured_metadata` stage is an action stage that takes data from the extracted map and modifies the [structured metadata]({{< relref "../../../get-started/labels/structured-metadata" >}}) that is sent to Loki with the log entry. diff --git a/docs/sources/send-data/promtail/stages/template.md b/docs/sources/send-data/promtail/stages/template.md index 7f7ae46928a85..e7af02500d903 100644 --- a/docs/sources/send-data/promtail/stages/template.md +++ b/docs/sources/send-data/promtail/stages/template.md @@ -9,6 +9,8 @@ weight: # template +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `template` stage is a transform stage that lets use manipulate the values in the extracted map using [Go's template syntax](https://golang.org/pkg/text/template/). diff --git a/docs/sources/send-data/promtail/stages/tenant.md b/docs/sources/send-data/promtail/stages/tenant.md index a5cc7dadba176..d36e7cb1334a1 100644 --- a/docs/sources/send-data/promtail/stages/tenant.md +++ b/docs/sources/send-data/promtail/stages/tenant.md @@ -9,6 +9,8 @@ weight: # tenant +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The tenant stage is an action stage that sets the tenant ID for the log entry picking it from a field in the extracted data map. If the field is missing, the default promtail client [`tenant_id`]({{< relref "../configuration#clients" >}}) will diff --git a/docs/sources/send-data/promtail/stages/timestamp.md b/docs/sources/send-data/promtail/stages/timestamp.md index f1b08143fd579..64a957396152e 100644 --- a/docs/sources/send-data/promtail/stages/timestamp.md +++ b/docs/sources/send-data/promtail/stages/timestamp.md @@ -9,6 +9,8 @@ weight: # timestamp +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} + The `timestamp` stage is an action stage that can change the timestamp of a log line before it is sent to Loki. When a `timestamp` stage is not present, the timestamp of a log line defaults to the time when the log entry is scraped. diff --git a/docs/sources/send-data/promtail/troubleshooting/_index.md b/docs/sources/send-data/promtail/troubleshooting/_index.md index b06f0af4e2af7..a97672c8f915f 100644 --- a/docs/sources/send-data/promtail/troubleshooting/_index.md +++ b/docs/sources/send-data/promtail/troubleshooting/_index.md @@ -8,8 +8,9 @@ weight: 800 --- # Troubleshooting Promtail -This document describes known failure modes of Promtail on edge cases and the -adopted trade-offs. +This document describes known failure modes of Promtail on edge cases and the adopted trade-offs. + +{{< docs/shared source="loki" lookup="promtail-deprecation.md" version="" >}} ## Dry running diff --git a/docs/sources/shared/promtail-deprecation.md b/docs/sources/shared/promtail-deprecation.md new file mode 100644 index 0000000000000..f86f0993afc51 --- /dev/null +++ b/docs/sources/shared/promtail-deprecation.md @@ -0,0 +1,14 @@ +--- +description: Deprecation notice for Promtail. +headless: true +labels: + products: + - enterprise + - oss +--- + +[//]: # 'This file provides an admonition caution for the deprecation of Promtail.' + +{{< admonition type="caution" >}} +Promtail has been deprecated and is in Long-Term Support (LTS) through February 28, 2026. Promtail will reach an End-of-Life (EOL) on March 2, 2026. You can find migration resources [here](https://grafana.com/docs/alloy/latest/set-up/migrate/from-promtail/). +{{< /admonition >}}