Use Grafana Agent with qryn cloud

This guide will show you how to migrate your current Grafana Agent observability pipeline to use qryn cloud.

Pre-requisites

The following assumptions are done:

• You are using Grafana Agent to push your data to Loki, Tempo, and Prometheus.
• You have access to the configuration of the agent.
• You are using the latest version in static mode.

note

This is not a guide on how to install and configure the agent. For that you should refer to the official documentation.

Compatibility

qryn cloud is compatible with all 3 types of signals exported by Grafana Agent in the Loki, Tempo and Prometheus format.

Logs	Metrics	Traces
✅	✅	✅

Authentication

Both basic auth and custom headers are supported by Grafana Agent.

Basic auth

Use the provided API Key as the username and the API Secret as the password.

Custom headers

You can declare either a X-API-KEY and X-API-SECRET header or if you are using the revokable tokens feature from Gigapipe add an X-API-TOKEN header.

For more information about the authentication options for qryn cloud please refer to the documentation.

Setup

We will guide you to all the required changed for each observability signal.

Logs

The logs_config block defines how the Grafana Agent collects logs and sends them to a Loki API compatible endpoint.

In order to forward your logs to qryn cloud you need to update the clients block in all the log instances and the global_config.

Key/Secret

logs:
  configs:
    - name: default
      clients:
        - url: YOUR_QRYN_CLOUD_URL/loki/api/v1/push
          headers:
            X-API-KEY: YOUR_API_KEY
            X-API-SECRET: YOUR_API_SECRET

Token

logs:
  configs:
    - name: default
      clients:
        - url: YOUR_QRYN_CLOUD_URL/loki/api/v1/push
          headers:
            X-API-TOKEN: YOUR_API_TOKEN

Basic auth

logs:
  configs:
    - name: default
      clients:
        - url: YOUR_QRYN_CLOUD_URL/loki/api/v1/push
          basic_auth:
            username: YOUR_API_KEY
            password: YOUR_API_SECRET

Traces

The traces_config block is responsible to configure the tracing pipelines.

In order to forward your traces to qryn cloud you need to update the remote_write block of all the tracing pipelines you have defined in your agent config.

Key/Secret

traces:
  configs:
    - name: default
      remote_write:
        - endpoint: YOUR_QRYN_CLOUD_URL
          headers:
            X-API-KEY: YOUR_API_KEY
            X-API-SECRET: YOUR_API_SECRET
          insecure: true # TCP is required
          protocol: http # We only support HTTP ???

Token

traces:
  configs:
    - name: default
      remote_write:
        - endpoint: YOUR_QRYN_CLOUD_URL
          headers:
            X-API-TOKEN: YOUR_API_TOKEN
          insecure: true # TCP is required
          protocol: http # We only support HTTP ???

Basic auth

traces:
  configs:
    - name: default
      remote_write:
        - endpoint: YOUR_QRYN_CLOUD_URL
          basic_auth:
            username: YOUR_API_KEY
            password: YOUR_API_SECRET
          insecure: true # TCP is required
          protocol: http # We only support HTTP ???

Metrics

The metrics_config block is responsible to configure the metrics instances.

In order to forward your metrics to qryn cloud you need to update the remote_write block of all the metrics instances or the global_config.

Key/Secret

metrics:
  configs:
    - name: default
      remote_write:
        - url: YOUR_QRYN_CLOUD_URL/api/v1/prom/remote/write
          headers:
            X-API-SECRET: YOUR_API_SECRET
            X-API-KEY: YOUR_API_KEY

Token

metrics:
  configs:
    - name: default
      remote_write:
        - url: YOUR_QRYN_CLOUD_URL/api/v1/prom/remote/write
          headers:
            X-API-TOKEN: YOUR_API_TOKEN

Basic auth

metrics:
  configs:
    - name: default
      remote_write:
        - url: YOUR_QRYN_CLOUD_URL/api/v1/prom/remote/write
          basic_auth:
            username: YOUR_API_SECRET
            password: YOUR_API_KEY