Giter VIP home page Giter VIP logo

docker-promtool's Introduction

docker-promtool

Why?

Keeping your prometheus config files under source control is great for shared ownership of a monitoring system. But you want to use a CI/CD system to make sure that nobody breaks monitoring by pushing an invalid config file.

Prometheus has a nice utility called promtool which can be used to check that a config/rules file is valid. But to use it, you need to build it yourself, or run it from the base prom/prometheus docker image which isn't compatible with the drone.io CI system because it runs as a custom user inside the container.

We built this image to be lightweight, just alpine linux with the promtool binary, and nothing else.

About this repo

This repo just tracks changes to the Dockerfile. The built image can be found at https://hub.docker.com/r/dnanexus/promtool/

Usage

Using docker run

Check a prometheus config file:

docker run \
  -v /path/to/local/prometheus/configs:/tmp \
  dnanexus/promtool:2.9.2 \
  check config /tmp/prometheus.yml

Check a prometheus rules file

docker run \
  -v /path/to/local/prometheus/configs:/tmp \
  dnanexus/promtool:2.9.2 \
  check rules /tmp/prometheus.rules.yml

Using drone pipeline step

pipeline:
  validate:
    image: dnanexus/promtool:2.9.2
    commands:
      - promtool check rules prometheus.rules.yml
      - promtool check config prometheus.yml

Using wercker pipeline step

validate-prometheus-config:
  box:
    id: dnanexus/promtool:2.9.2
  steps:
  - script:
    name: Validate prometheus configuration rules (alerting rules)
    description: if this is failing prometheus will not be able to start, better fail fast
    code: |
      promtool check config prometheus.yml
      promtool check rules prometheus.rules.yml

Version History

  • 2.9.2: Alignment with prometheus releases
  • 1.0: Initial release

docker-promtool's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.