# prom-stack

**Repository Path**: glg/prom-stack

## Basic Information

- **Project Name**: prom-stack
- **Description**: Run a local Prometheus, AlertManager, Push Gateway, and Grafana locally using Docker compose
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-08-29
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Prom-Stack

This repo contains a quick start for running a development instance of Prometheus.  

## What's Included?

* Prometheus Server
* Push Gateway
* Alertmanager
* Grafana

```
               +--------------+
               |              |
               |   Grafana    |
               |              |
               +--------------+
                      |
                      | datasource
                      |
               +------v-------+           +--------------+
         +-----+              |           |              |
  scrape |     |  Prometheus  +-----------> AlertManager |
         +----->    Server    |   push    |              |
               |              |   alerts  |              |
               +--------------+           +--------------+
                      |
                      | scrape
                      |
               +------v-------+
               |              |
               | Pushgateway  |
               |              |
               +--------------+
```

## How do I use it?

1. Clone the repo.
1. Navigate to the directory and run `make up`
1. Go to [http://localhost:9090](http://localhost:9090) for Prometheus.  
1. Go to [http://localhost:9091](http://localhost:9091) for the Push Gateway.  
1. Go to [http://localhost:9093](http://localhost:9093) for Alertmanager.
1. Go to [http://localhost:3000](http://localhost:3000) for Grafana.

# Guides
## Add a Scrape Target

To add a new scrape target, edit the `scrape_configs` section of `/prometheus/prometheus.yml` and run `make reload-prom`

See [here](https://prometheus.io/docs/operating/configuration/#%3Cscrape_config%3E) for more details on scrape configs.

## Add an alert

To add a new alert, create or edit a `*.rules` file in the `prometheus/alerts` directory and run `make reload-prom`

## Use the Push Gateway

The Pushgateway can be used as an intermediary to push metrics, where the Prometheus pull model doesn't fit.  Examples
of this include short lived processes or batch jobs.

To push a metric in Prom-Stack, you can do something like this:

`echo "mymetric 99" | curl --data-binary @- http://localhost:9091/metrics/job/my-push-job`

You can confirm this has worked by navigating to the [Push Gateway](http://localhost:9091) UI or the [Prometheus](http://localhost:9090) expression browser.