Grafana Loki
Grafana Loki (or Loki) is a horizontally scalable, multi-tenant log aggregation system that is extremely easy to operate. Loki does not index the contents of the logs, but rather a set of labels for each log stream. Nobl9 users can leverage Loki to query and build metrics on top of their logs.
Grafana Loki parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent
- Replay and SLI Analyzer: Not supported
- Event logs: Not supported
- Query checker: Not supported
- Query parameters retrieval: Supported
- Timestamp cache persistence: Not supported
- Query parameters:
- Query interval: 1 min
- Query delay: 1 min
- Jitter: 15 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Plugin name: n9grafana_loki
- Query delay environment variable: GRAFANA_LOKI_QUERY_DELAY
- Query parameters retrieval: 0.73.2
- Custom HTTP headers: 0.88.0-beta
Authentication
Loki does not provide an authentication layer.
Authentication is up to the customer.
Users are expected
to run an authenticating reverse proxy in front of their services,
such as NGINX using basic auth
or an OAuth2
proxy.
Nobl9 collects only the URL for the Loki integration definition and calls the GET /loki/api/v1/query_range
URL. For details, refer to HTTP API Grafana Loki | Grafana Loki documentation.
Basic authentication
Since Loki does not provide an authentication layer, the authentication method is up to the users. Normally, Loki's users are expected to run an authenticating reverse proxy in front of their services, such as NGINX
using basic_auth
proxy.
If that's the method you use, the Nobl9 agent version equal to or higher than 0.40.0, allows you to send an additional Authorization request header with the basic_auth
. Refer to the section below for more details.
Adding Grafana Loki as a data source
To ensure data transmission between Nobl9 and Grafana Loki, it may be necessary to list Nobl9 IP addresses as trusted.
app.nobl9.com
instance:- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
us1.nobl9.com
instance:- 34.121.54.120
- 34.123.193.191
- 34.134.71.10
- 35.192.105.150
- 35.225.248.37
- 35.226.78.175
- 104.198.44.161
You can add the Grafana Loki data source using the agent connection method.
Nobl9 Web
Follow the instructions below to configure your Grafana Loki agent:
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Add the URL (mandatory).
Theurl
is an entry point to Grafana Loki. It depends on the configuration of your Loki instance, for more details, refer to the Configuration | Grafana Loki documentation section of Grafana Loki technical documentation.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Grafana Loki integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in Grafana Loki integration for Query delay is
- Click Add Data Source
- Deploy your agent in a Kubernetes cluster or Docker container.
sloctl
- Create a YAML definition to set up an agent connection with Grafana Loki. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: grafana-loki
displayName: Grafana Loki Agent
project: default
spec:
description: Example Grafana Loki Agent
releaseChannel: stable
grafanaLoki:
url: http://grafana-loki.loki:3100
queryDelay:
value: 2
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . • Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. • Must be a number less than 1440 minutes (24 hours). • Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
grafanaLoki.url mandatory | string | an entry point to Grafana Loki. The `url` depends on the configuration of your Loki instance. See Configuration | Grafana Loki documentation. |
- Apply your YAML definition using the
sloctl apply
command. - Deploy your agent in a Kubernetes cluster or Docker container.