Skip to main content

Grafana Loki

Reading time: 0 minute(s) (0 words)

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 / 0.88.0-beta

Creating SLOs with Grafana Loki​

Nobl9 Web​

Follow the instructions below to create your SLOs with Grafana Loki in the Nobl9 web application.

  1. Navigate to Service Level Objectives.
  2. Click .
  3. Select a Service.
    It will be the location for your SLO in Nobl9.
  4. Select your Grafana Loki data source.
  5. Metric refers to the way of calculating and interpreting calculate and interpret data from your data source.
    • Threshold metric is defined by a single numerical value (the threshold) that separates satisfactory performance from unsatisfactory performance. It's represented by a single time series evaluated against the threshold.
    • Ratio metric expresses the performance as a fraction or proportion, typically by dividing the number of successful events by the total number of potential events (successes + failures). It's represented by two-time series for comparison for good events and total events.
      For ratio metrics, select the Data count method.

      SLI values for good and total
      When choosing the query for the ratio SLI (countMetrics), keep in mind that the values ​​resulting from that query for both good and total:
      • Must be positive.
      • While we recommend using integers, fractions are also acceptable.
        • If using fractions, we recommend them to be larger than 1e-4 = 0.0001.
      • Shouldn't be larger than 1e+20.

  1. Specify Query using the LogQL syntax.

    Click to open query samples
    Total metric
    sum(sum_over_time({topic="cdc"} |= "kafka_consumergroup_lag" | logfmt | line_format "{{.kafka_consumergroup_lag}}" | unwrap kafka_consumergroup_lag [1m]))
    Ratio metric, numerator
    count(count_over_time(({app="nobl9", component="ingest", container="ingest container"} | json | line_format "{{.log}}" | json | http_useragent != "ELB-HealthChecker/2.0" | http_status_code >= 200 and http_status_code < 300)[1m]))
    Ratio metric, denominator
    count(count_over_time(({app="nobl9", component="ingest", container="ingest-container"} | json | line_format "{{.log}}" | json | http_useragent != "ELB-HealthChecker/2.0" | http_status_code > 0)[1m]))
  1. Define the Time window for your SLO:
  2. Configure the Error budget calculation method and Objectives:
    • Occurrences method counts good attempts against the count of total attempts.
    • Time Slices method measures how many good minutes were achieved (when a system operates within defined boundaries) during a time window.
    • You can define up to 12 objectives for an SLO.

      • Similar threshold values for objectives
      To use similar threshold values for different objectives in your SLO, we recommend differentiating them by setting varying decimal points for each objective.
      For example, if you want to use threshold value 1 for two objectives, set it to 1.0000001 for the first objective and to 1.0000002 for the second one.
  3. Add the Display name, Name, and other settings for your SLO:
    • Name identifies your SLO in Nobl9. After you save the SLO, its name becomes read-only.
      Use only lowercase letters, numbers, and dashes.
    • Select No data anomaly alert to receive notifications when your SLO stops reporting data for a specified period:
      • Choose up to five supported Alert methods.
      • Specify the delay period before Nobl9 sends an alert about the missing data.
        From 5 minutes to 31 days. Default: 15 minutes
    • Add alert policies, labels, and links, if required.
      Limits per SLO: 20 alert policies or links, 30 labels.
  4. Click CREATE SLO.

    5. SLO configuration use case
    Check the SLO configuration use case for a real-life SLO example.

YAML​

Sample Grafana Loki threshold SLO
apiVersion: n9/v1alpha
kind: SLO
metadata:
  name: api-server-slo
  displayName: API Server SLO
  project: default
  labels:
    area:
      - latency
      - slow-check
    env:
      - prod
      - dev
    region:
      - us
      - eu
    team:
      - green
      - sales
  annotations:
    area: latency
    env: prod
    region: us
    team: sales
spec:
  description: Example Grafana Loki SLO
  indicator:
    metricSource:
      name: grafana-loki
      project: default
      kind: Agent
  budgetingMethod: Occurrences
  objectives:
    - displayName: Good response (200)
      value: 200
      name: ok
      target: 0.95
      rawMetric:
        query:
          grafanaLoki:
            logql: >-
              sum(sum_over_time({topic="cdc"} |= "kafka_consumergroup_lag" |
              logfmt | line_format "{{.kafka_consumergroup_lag}}" | unwrap
              kafka_consumergroup_lag [1m]))
      op: lte
      primary: true
  service: api-server
  timeWindows:
    - unit: Month
      count: 1
      isRolling: false
      calendar:
        startTime: '2022-12-01 00:00:00'
        timeZone: UTC
  alertPolicies:
    - fast-burn-5x-for-last-10m
  attachments:
    - url: https://docs.nobl9.com
      displayName: Nobl9 Documentation
  anomalyConfig:
    noData:
      alertMethods:
        - name: slack-notification
          project: default
      alertAfter: 1h
Click to open field reference
FieldTypeDescription
apiVersion
mandatory
stringAPI version. Use n9/v1alpha
kind
mandatory
stringThe resource type. Use SLO
Metadata
metadata.name
mandatory
stringName identifier for the SLO. Use only lowercase alphanumeric characters
metadata.displayNamestringUser-friendly SLO name
metadata.project
mandatory
stringThe name identifier of the project where you need to host your SLO
metadata.labelsobject (map: string[])Grouping labels for filtering or viewing
metadata.annotationsobject (map: string)Flat string annotations
Spec
spec.descriptionstringSLO description
spec.indicator.metricSource.name
mandatory
stringData source name
spec.indicator.metricSource.project
mandatory
stringProject containing the data source
spec.indicator.metricSource.kind
mandatory
stringData source connection method. Can be Agent or Direct
spec.budgetingMethod
mandatory
enumError budget calculation method. Can be Occurrences or Time slices
spec.objectives
mandatory
arrayYour SLO objective definition, up to 12 objectives per SLO.
spec.objectives[].displayNamestringUser-friendly objective name
spec.objectives[].value
mandatory
numberData point values that is considered "good" (e.g., 200.0).
In SLOs with two or more objectives, keep each objective's value unique.
In ratio (count) metrics, value is retained for legacy purposes.
spec.objectives[].name
mandatory
stringName identifier for this objective
spec.objectives[].op
mandatory
string (enum)Operator for objective. One of:
lte (less than or equal to)
lt (less than)
gte (greater than or equal to)
gt (greater than)
spec.objectives[].target
mandatory
floatThe percentage of the good minutes or occurrences that must meet the desired performance (e.g., is the target is 0.95, the good performance is expected to be observed in at least 95% of the time window)
spec.objectives[].rawMetric/.countMetric
mandatory
objectThe metric type indicator. Set:
rawMetric for a threshold metric
countMetric for a ratio metric.
A ratio metric requires the additional fields:
countMetric.incremental (boolean) the data count method
countMetric.good/.bad and countMetric.total a numerator and denominator queries
spec.objectives[].countMetric.incremental
mandatory
booleanThe data count method for a ratio (countMetric) metric type
spec.objectives[].primarybooleanThe indicator of a primary SLO objective
spec.service
mandatory
stringThe name identifier of a service to host this SLO. The service must exist in the project specified in metadata.project
spec.timeWindows
mandatory
arrayDefines SLO time window for error budget calculation. Set:
isRolling: true for the rolling time window type
isRolling: false for the calendar-aligned type
spec.timeWindows.unit
mandatory
integerThe time window units. One of:
Day | Hour | Minute for the rolling time window
Year | Quarter | Month | Week | Day for the calendar-aligned time window
spec.timeWindows.count
mandatory
integerThe number of units in a time window
spec.timeWindows.startTimestringMandatory for calendar-aligned time windows. Date and time in the format YYYY-MM-DDTHH:mm:ss
spec.timeWindows.timeZonestringMandatory for calendar-aligned time-windows. A valid IANA Time Zone Database name
spec.timeWindows.isRolling
mandatory
boolean
true for the rolling time window type
false for the calendar-aligned type
spec.alertPoliciesarrayThe name identifiers of alert policies to be linked to this SLO (must be from the same project as the SLO). Up to 20 alert policies per SLO.
spec.attachmentsarrayLinks to any additional attributes of this SLO
spec.anomalyConfigobjectSettings for a manual no data anomaly detection rule
spec.noData.alertMethodsarrayList of alert methods for no-data anomaly. Up to five alert methods per SLO. Every alert method must have the name and project fields
spec.noData.alertAfterstringWaiting time before sending a no-data notification. Must be 5m to 31d.
Default: 15m
Source-specific fields
grafanaLoki.logql
mandatory
stringYour PromQL query

Sample LogQL queries​

  • Ratio metric for Grafana Loki:
    Good query:
    count(count_over_time(({app="nobl9", component="ingest", container="ingest container"} | json | line_format "{{.log}}" | json | http_useragent != "ELB-HealthChecker/2.0" | http_status_code >= 200 and http_status_code < 300)[1m]))
    Total query:
    count(count_over_time(({app="nobl9", component="ingest", container="ingest-container"} | json | line_format "{{.log}}" | json | http_useragent != "ELB-HealthChecker/2.0" | http_status_code > 0)[1m]))

Querying the Grafana Loki server​

Nobl9 calls Loki API every minute to retrieve the log data from the previous minute. Nobl9 aggregates the total number of points to 4 per minute.

caution

Users should refrain from adding duration and Nobl9 will append [1m] to the query.

Check out these related guides and references:
Add Grafana Loki as a data sourceAdding data sourcesGrafana HTTP APIGrafana Loki documentationIntroduction to PromQLGrafana documentationCreating SLOs via TerraformTerraform
On this page