samuelengineer / grafana-agent-operator Goto Github PK

View Code? Open in Web Editor NEW

This charmed operator automates the operational procedures of running Grafana Agent, an open-soruce telemetry collector.

License: Apache License 2.0

Python 100.00%

grafana-agent-operator's Introduction

Grafana Agent Charmed Operator for Machines (LXD, MaaS, et al)

Description

Grafana Agent is a telemetry collector for sending metrics, logs, and trace data to the opinionated Grafana observability stack.

The Grafana Agent Charmed Operator deploys Grafana Agent in machines using Juju and the Charmed Operator Lifecycle Manager (OLM).

As a single entry point to the Canonical Observability Stack, the Grafana Agent charm brings several conveniences when deployed inside a monitored cluster:

Charms are related to the Grafana Agent charm, instead of to Prometheus and Loki individually. In typical deployments this would reduce the number of cross-model relations that would have been otherwise needed.
Conversion from scraping to remote writing: Grafana Agent would collect telemetry inside the cluster network and push it to the COS cluster (via loki_push_api and prometheus_remote_write), which simplifies firewall configuration, as only outgoing connections would need to be established.

See deployment scenarios for further detail.

Usage

Create a Juju model for your operators, say "cos"

juju add-model cos

The Grafana agent may be deployed using the juju command line:

juju deploy grafana-agent --trust

If required, you can remove the deployment completely:

juju destroy-model -y cos --no-wait --force --destroy-storage

Relations

Currently supported relations are:

requires:
  send-remote-write:
    interface: prometheus_remote_write
  metrics-endpoint:
    interface: prometheus_scrape
  logging-consumer:
    interface: loki_push_api

provides:
  self-metrics-endpoint:
    interface: prometheus_scrape
  grafana-dashboard:
    interface: grafana_dashboard
  logging-provider:
    interface: loki_push_api