This is archived documentation for v1.4.2. Go to the latest version.

Manage an instanceUsing label-based access control (LBAC)

Overview

Label-based access control can be used to create access policies that will only allow for data to be queried that meets specific label requirements. The feature allows multiple sets of Prometheus label selectors to be associated with a policy and queries will only return data from series that match at least one of the provided selectors. This correlates to disjunctive normal form which allows any required policy to be expressed.

Setting up a label policy

Label policies are set when creating an access policy on a per instance basis. This means each instance associated with an access policy can have a unique label policy.


Examples

Exclude a label

One common use case for creating an LBAC policy is to exclude metrics with a specific label. For instance, a label policy that excludes all series with the label secret=true would be created by just adding a select with secret!="true" when creating an access policy. This can be seen in the image below:

create-exclude-label

Exclude a metric

Expanding upon the previous example, lets say we wanted to create an access policy that only excludes metrics with the label secret=true on the metric named sensitive_requests_total. Since the name of a metric is actually just a label with the key __name__, we can leverage the existing LBAC label selector syntax to enforce this:

create-exclude-metric

You may notice above that two different selectors where added to enforce the policy. Specifically:

{secret!="true", __name__="sensitive_requests_total"}

and

{__name__!="sensitive_requests_total"}

The first selector will match when returning a series from the metrics sensitive_requests_total and will ensure all of the returned series do not have the secret: true label. However, when requesting a metric besides sensitive_requests_total, the second label selector will match and return any data even if it has the secret: true label.