tenant
stage
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
will
be used.
Schema
tenant:
# Name from extracted data to whose value should be set as tenant ID.
# Either source or value config option is required, but not both (they
# are mutually exclusive).
[ source: <string> ]
# Value to use to set the tenant ID when this stage is executed. Useful
# when this stage is included within a conditional pipeline with "match".
[ value: <string> ]
Example: extract the tenant ID from a structured log
For the given pipeline:
pipeline_stages:
- json:
expressions:
customer_id: customer_id
- tenant:
source: customer_id
Given the following log line:
{"customer_id":"1","log":"log message\n","stream":"stderr","time":"2019-04-30T02:12:41.8443515Z"}
The first stage would extract customer_id
into the extracted map with a value of
1
. The tenant stage would set the X-Scope-OrgID
request header (used by Loki to
identify the tenant) to the value of the customer_id
extracted data, which is 1
.
Example: override the tenant ID with the configured value
For the given pipeline:
pipeline_stages:
- json:
expressions:
app:
message:
- labels:
app:
- match:
selector: '{app="api"}'
stages:
- tenant:
value: "team-api"
- output:
source: message
Given the following log line:
{"app":"api","log":"log message\n","stream":"stderr","time":"2019-04-30T02:12:41.8443515Z"}
The pipeline would:
- Decode the JSON log
- Set the label
app="api"
- Process the
match
stage checking if the{app="api"}
selector matches and - whenever it matches - run the sub stages. Thetenant
sub stage would override the tenant with the value"team-api"
.
Related Loki resources
Getting started with logging and Grafana Loki (APAC timezone)
Join this webinar to learn why correlating metrics and logs is critical across the development lifecycle, and how Loki helps reduce logging costs and operations overhead.
Logging with Loki: Essential configuration settings
This webinar focuses on Grafana Loki configuration including agents Promtail and Docker; the Loki server; and Loki storage for popular backends.
Observability with logs & Grafana
Discover how you can utilize, manage, and visualize log events with Grafana and Grafana’s logging application Loki.