Send metrics to Prometheus

A simple guide to send metrics to Prometheus in just a few minutes.
type: tutorialdomain: sinkssink: prometheus

Metrics are an essential part of observing any service; without them you are flying blind. But collecting and analyzing them can be a real challenge -- especially at scale. Not only do you need to solve the basic task of collecting your metrics, but you must do it in a reliable, performant, and robust manner. Nothing is more frustrating than having your metrics pipeline fall on it's face during an outage, or even worse, disrupt more important services!

Fear not! In this guide we'll show you how to send send metrics to Prometheus and build a metrics pipeline that will be the backbone of your observability strategy.

Background

What is Prometheus?

Prometheus is a pull-based monitoring system that scrapes metrics from configured endpoints, stores them efficiently, and supports a powerful query language to compose dynamic information from a variety of otherwise unrelated data points.

Strategy

How This Guide Works

We'll be using Vector to accomplish this task. Vector is a popular open-source utility for building observability pipelines. It's written in Rust, making it lightweight, ultra-fast and highly reliable. And we'll be deploying Vector as a daemon.

The daemon deployment strategy is designed for data collection on a single host. Vector runs in the background, in its own process, collecting all data for that host. Typically data is collected from a process manager, such as Journald via Vector's journald source, but can be collected through any of Vector's sources. The following diagram demonstrates how it works.

Vector daemon deployment strategyVector daemon deployment strategy
1. Your service logs to STDOUT
STDOUT follows the 12 factor principles.
2. STDOUT is captured
STDOUT is captured by your platform.
3. Vector collects & fans-out data
Vector will expose an endpoint that Prometheus can scrape for metrics data.

What We'll Accomplish

To be clear, here's everything we'll accomplish in this short guide:

  • Collect your metrics from one or more sources
  • Expose an endpoint that Prometheus can scrape for metrics data.
    • Automatically aggregate metrics at the edge for improved performance.
  • All in just a few minutes!

Tutorial

  1. Install Vector

    curl --proto '=https' --tlsv1.2 -sSf https://sh.vector.dev | sh
    explain this command

    Or choose your preferred method.

  2. Configure Vector

    cat <<-VECTORCFG > vector.toml
    [sources.in]
    address = "127.0.0.1:8126" # required
    type = "statsd" # required
    [sinks.out]
    address = "0.0.0.0:9598" # required
    inputs = ["in"] # required
    namespace = "service" # required
    type = "prometheus" # required
    VECTORCFG
    explain this command
  3. Start Vector

    vector --config vector.toml

    That's it! Simple and to the point. Hit ctrl+c to exit.

Next Steps

Vector is powerful utility and we're just scratching the surface in this guide. Here are a few pages we recommend that demonstrate the power and flexibility of Vector:

Vector Github repo 4k
Vector is free and open-source!
Vector getting started series
Go from zero to production in under 10 minutes!
Vector documentation
Thoughtful, detailed docs that respect your time.