agent

module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2020 License: Apache-2.0

README

Grafana Cloud Agent

Grafana Cloud Agent is an observability data collector optimized for sending metrics and log data to Grafana Cloud.

Users of Prometheus cloud storage vendors can struggle sending their data at scale: Prometheus is sometimes called a single point of failure that generally requires a giant machine with a lot of resources allocated to it.

The Grafana Cloud Agent tackles these issues by stripping Prometheus down to its most relavant parts for interaction with hosted metrics:

  1. Service Discovery
  2. Scraping
  3. Write Ahead Log (WAL)
  4. Remote Write

On top of these, the Grafana Cloud Agent allows for an optional host filter mechanism, enabling users to easily shard the Agent across their cluster and lower the memory requirements per machine.

A typical deployment of the Grafana Cloud Agent for Prometheus metrics can see up to a 40% reduction in memory usage with comparable scrape loads.

Despite called the "Grafana Cloud Agent," it can be utilized with any Prometheus remote_write API.

Trade-offs

By heavily optimizing Prometheus for remote write and resource reduction, some trade-offs have been made:

  • You can't query the Agent; you can only query metrics from the remote write storage.
  • Recording rules aren't supported.
  • Alerts aren't supported.
  • When sharding the Agent, if your node has problems that interrupt metric availability, metrics tracking that node won't be sent for alerting on.

The Agent sets the expectation that recording rules and alerts should be the responsibility of the remote write system rather than the responsibility of the metrics collector.

Roadmap

  • Prometheus metrics
  • Promtail for Loki logs
  • carbon-relay-ng for Graphite metrics.
  • A second clustering mode to solve sharding monitoring availability problems.

Getting Started

The easiest way to get started with the Grafana Cloud Agent is to use the Kubernetes install script. Simply copy and paste the following line in your terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/grafana/agent/master/production/kubernetes/install.sh)" | kubectl apply -f -

Other installation methods can be found in our Production documentation.

More detailed documentation is provided as part of the repository.

Example

A docker-compose config is provided in example/. It deploys the Agent, Cortex, Grafana, and Avalanche for load testing. See the README in example/ for more information.

Getting Help

If you have any questions or feedback regarding the Grafana Cloud Agent:

  • Ask a question on the Agent Slack channel. To invite yourself to the Grafana Slack, visit https://slack.grafana.com/ and join the #agent channel.
  • File an issue for bugs, issues and feature suggestions.

Directories

Path Synopsis
cmd
e2e module
internal
pkg
tools

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳