From f9abd8608e818d73ae8c7a0c1edf6fceb8297f9f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joan=20L=C3=B3pez=20de=20la=20Franca=20Beltran?= <5459617+joanlopez@users.noreply.github.com> Date: Mon, 27 Mar 2023 22:44:16 +0200 Subject: [PATCH] Docs: Add 'tenant_id' for Loki clients (Auditing & Analytics) (#63098) * Docs: Add 'tenant_id' for Loki clients (Auditing & Analytics) * Apply suggestions from code review Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Mitch Seaman --------- Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> Co-authored-by: Mitch Seaman --- .../configure-grafana/enterprise-configuration/index.md | 8 ++++++++ .../setup-grafana/configure-security/audit-grafana.md | 3 +++ .../setup-grafana/configure-security/export-logs.md | 3 +++ 3 files changed, 14 insertions(+) diff --git a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md index 06314069a00..0c9c18c3dbc 100644 --- a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md +++ b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md @@ -102,6 +102,10 @@ Set the address for writing logs to Loki (format must be host:port). Decide whether or not to enable the TLS (Transport Layer Security) protocol when establishing the connection to Loki. Defaults to true. +### tenant_id + +Set the tenant ID for Loki communication, which is disabled by default. The tenant ID is required to interact with Loki running in [multi-tenant mode](/docs/loki/latest/operations/multi-tenancy/). + ## [analytics.summaries] ### buffer_write_interval @@ -212,6 +216,10 @@ Set the URL for writing logs to Loki. If true, it establishes a secure connection to Loki. Defaults to true. +### tenant_id + +Set the tenant ID for Loki communication, which is disabled by default. The tenant ID is required to interact with Loki running in [multi-tenant mode](/docs/loki/latest/operations/multi-tenancy/). + ## [auth.saml] ### enabled diff --git a/docs/sources/setup-grafana/configure-security/audit-grafana.md b/docs/sources/setup-grafana/configure-security/audit-grafana.md index 1bc989ea6d3..7fbb873fc57 100644 --- a/docs/sources/setup-grafana/configure-security/audit-grafana.md +++ b/docs/sources/setup-grafana/configure-security/audit-grafana.md @@ -424,6 +424,9 @@ type = grpc url = localhost:9095 # Defaults to true. If true, it establishes a secure connection to Loki tls = true +# Set the tenant ID for Loki communication, which is disabled by default. +# The tenant ID is required to interact with Loki running in multi-tenant mode. +tenant_id = ``` If you have multiple Grafana instances sending logs to the same Loki service or if you are using Loki for non-audit logs, audit logs come with additional labels to help identifying them: diff --git a/docs/sources/setup-grafana/configure-security/export-logs.md b/docs/sources/setup-grafana/configure-security/export-logs.md index ca7bfa95df0..61a4be55fa7 100644 --- a/docs/sources/setup-grafana/configure-security/export-logs.md +++ b/docs/sources/setup-grafana/configure-security/export-logs.md @@ -85,6 +85,9 @@ type = grpc url = localhost:9095 # Defaults to true. If true, it establishes a secure connection to Loki tls = true +# Set the tenant ID for Loki communication, which is disabled by default. +# The tenant ID is required to interact with Loki running in multi-tenant mode. +tenant_id = ``` Using `logger` will print usage insights to your [Grafana server log]({{< relref "../../setup-grafana/configure-grafana/#log" >}}).