From c4cb1a801c5cabe1bcf457438e6828cc2f0c63f2 Mon Sep 17 00:00:00 2001 From: "loki-gh-app[bot]" <160051081+loki-gh-app[bot]@users.noreply.github.com> Date: Tue, 26 Nov 2024 15:56:35 -0500 Subject: [PATCH] docs: add warning around using logstash plugin for new deployments (backport release-3.3.x) (#15138) Co-authored-by: Ed Welch --- docs/sources/send-data/logstash/_index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/sources/send-data/logstash/_index.md b/docs/sources/send-data/logstash/_index.md index 7e3bf7dcf377d..2cd371cbd1b36 100644 --- a/docs/sources/send-data/logstash/_index.md +++ b/docs/sources/send-data/logstash/_index.md @@ -12,6 +12,20 @@ Grafana Loki has a [Logstash](https://www.elastic.co/logstash) output plugin cal `logstash-output-loki` that enables shipping logs to a Loki instance or [Grafana Cloud](/products/cloud/). +{{< admonition type="warning" >}} +Grafana Labs does not recommend using the Logstash plugin for new deployments. Even as a mechanism for quickly testing Loki with your existing Beats/Logstash infrastructure we highly discourage the use of this plugin. + +Our experience over the years has found numerous significant challenges using Logstash and this plugin: + + * It is very difficult to configure labels correctly. Conceptually Elasticsearch is a very different database from Loki and users almost always end up sending too many high cardinality labels to Loki, which makes getting started with Loki unnecessarily complicated and confusing vs. using other clients. + * Logstash and the upstream Beats components implement backoff and flow control which we've found hard to observe, leading to ingestion delays into Loki which are extremely difficult to address. + * We at Grafana Labs have no expertise at configuring Logstash or understanding of its configuration language, so we cannot provide support for it. + * It's very hard to troubleshoot and debug. Our experience has shown that in nearly every case where it was assumed this would be the fast path to getting logs to Loki, that was not the case and it ended up taking far longer than anticipated. + +Please strongly consider using any alternative mechanism to sending logs to Loki. We recommend using [Grafana Alloy](/docs/loki/latest/send-data/alloy/). This is the tool we build and where we can offer the best experience and most support. + +{{< /admonition >}} + ## Installation ### Local