https://github.com/prometheus-community/prometheus-playground

Turnkey sandbox projects demonstrating a wide variety of Prometheus use cases
https://github.com/prometheus-community/prometheus-playground

alertmanager cadvisor docker docker-compose prometheus turnkey

Last synced: about 1 month ago
JSON representation

Turnkey sandbox projects demonstrating a wide variety of Prometheus use cases

• Host: GitHub
• URL: https://github.com/prometheus-community/prometheus-playground
• Owner: prometheus-community
• License: apache-2.0
• Created: 2018-11-15T01:29:44.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T20:32:33.000Z (over 1 year ago)
• Last Synced: 2024-09-28T21:05:28.254Z (about 1 month ago)
• Topics: alertmanager, cadvisor, docker, docker-compose, prometheus, turnkey
• Language: Go
• Size: 106 KB
• Stars: 164
• Watchers: 13
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# The Prometheus Playground

This repo houses a variety of [Docker-Compose](https://docs.docker.com/compose)-based "sandbox" projects showcasing the [Prometheus](https://prometheus.io) monitoring system. All projects are "turnkey" and require just a single `docker-compose up` command to run.

Each sandbox project has a `README` with an explanation of the project, a `docker-compose.yml` configuration file for Docker Compose, and other necessary resources (config files, `Dockerfile`s, etc.). To run a project, navigate to the appropriate directory and run `make run` (which is just an alias for `docker-compose up --build`). This will run the project in the *foreground*. To run the project in detached mode, use `make run-detached`.

## Prerequisites

In order to run the sandbox projects you'll need to install [Docker](https://docker.com) and [Docker Compose](https://docs.docker.com/compose) and have a Docker daemon running locally.

## Projects

Directory | Scenario

:---------|:--------

[`alertmanager`](./alertmanager) | Prometheus monitors a basic web service and notifies [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/) if the service is down; Alertmanager, in turns, notifies a web service via webhook

[`blackbox-exporter`](./blackbox-exporter) | A [BlackBox prober exporter](https://github.com/prometheus/blackbox_exporter) probes a simple web service and provides probe-based metrics to Prometheus

[`cadvisor`](./cadvisor) | Prometheus scrapes [cAdvisor](https://github.com/google/cadvisor)-gathered metrics for several containers

[`federation`](./federation) | Three Prometheus instances run together as a single federation

[`file-sd`](./file-sd) | A Prometheus instance discovers a simple instrumented web service via file-based service discovery

[`go-app`](./go-app) | An instrumented Go application using the Prometheus [Go client](https://github.com/prometheus/client_golang)

[`haproxy`](./haproxy) | Prometheus runs behind [HAProxy](https://haproxy.org/), which acts as a reverse proxy and provides basic auth and TLS encryption

[`nginx`](./nginx) | Prometheus runs behind [nginx](https://nginx.org), which acts as a reverse proxy and provides basic auth and TLS encryption

[`node-exporter`](./node-exporter) | Prometheus scrapes Linux host metrics from a [Node Exporter](https://prometheus.io/docs/guides/node-exporter/)

[`python-flask-app`](./python-flask-app) | An instrumented [Flask](https://flask.pocoo.org) application demonstrating the Prometheus [Python client](https://github.com/prometheus/client_python)