# PrometheusStackDockerCompose

**Repository Path**: atompi/PrometheusStackDockerCompose

## Basic Information

- **Project Name**: PrometheusStackDockerCompose
- **Description**: Deploy Prometheus Stack with Docker Compose
- **Primary Language**: Docker
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 5
- **Created**: 2018-08-14
- **Last Updated**: 2022-02-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Deploy Prometheus Stack with Docker Compose

## 项目介绍

Deploy Prometheus Stack with Docker Compose

## 软件架构

![Prometheus Consul Grafana](imgs/PromStack.png)

### Prometheus

[Prometheus](https://prometheus.io/) 是由 SoundCloud 开源监控告警解决方案，从 2012 年开始编写代码，再到 2015 年 github 上开源以来，已经吸引了 18k+ 关注，以及很多大公司的使用；2016 年 Prometheus 成为继 k8s 后，第二名 CNCF(Cloud Native Computing Foundation) 成员。

CNCF announced the graduation status of Prometheus at the PromCon 2018 conference.

Prometheus, an open-source monitoring system and time series database, has become the second project after Kubernetes to graduate from the Cloud Native Computing Foundation (CNCF).

2018 年 CNCF 在 PromCon 2018 上宣布 Prometheus 从 CNCF Graduated ，这是继 Kubernetes 后第二个 Graduated 的成员。

![prometheus architecture](imgs/prometheus-architecture.png)

#### 它有什么特点？

+ 自定义多维数据模型(时序列数据由metric名和一组key/value标签组成)
+ 在多维度上灵活且强大的查询语言(PromQl)
+ 不依赖分布式存储，支持单主节点工作
+ 通过基于HTTP的pull方式采集时序数据
+ 可以通过push gateway进行时序列数据推送(pushing)
+ 可以通过服务发现或者静态配置去获取要采集的目标服务器
+ 多种可视化图表及仪表盘支持

### Consul

[Consul](http://www.consul.io/) 是一个分布式服务网格（ service mesh ），用于跨任何运行时平台以及公共云 / 私有云连接的服务发现、服务分割和服务配置。

关键概念：

+ `API-Driven` 对服务定义、运行状况检查、服务授权策略、故障转移逻辑等进行编码和自动化。
+ `Run and Connect Anywhere` 跨任何运行时平台和公共云 / 私有云连接服务。将服务从 Kubernetes 连接到 VM （ Kubernetes to VMs ）、容器到无服务器（ Containers to Serverless ）功能。
+ `Extend and Integrate` 在任何基础架构上配置群集，通过代理集成连接到TLS上的服务，使用可插拔证书颁发机构提供TLS证书。

### Grafana

_The open platform for beautiful analytics and monitoring_

[Grafana](https://grafana.com/) 是一个领先的时序数据（ time series ）分析开源软件，同时提供通用仪表板和告警功能（ Grafana4.0 及之后版本）作为 Web 应用程序运行。它支持 graphite ， InfluxDB 或 opentsdb 作为后端存储。

## 安装教程

1. 创建目录： 

    + `/usr/local/prometheus`
    + `/usr/local/grafana`
    + `/data/nginx/logs`
    + `/data/nginx/conf/ssl.d`
    + `/data/nginx/conf/stream.d`
    + `/data/nginx/conf/conf.d`

2. 复制配置文件到指定目录，详见 [docker-compose.yml](docker-compose.yml) volume 结构

3. 启动服务：

```
# cd ~/PrometheusStackDockerCompose
# docker-compose up -d
```

4. 卸载服务：

```
# 完全卸载（删除 volumes ）
# cd ~/PrometheusStackDockerCompose
# docker-compose down -v
# 删除容器，保留数据（保留 volumes ）
# cd ~/PrometheusStackDockerCompose
# docker-compose down
```

## 使用说明

1. 配置修改：

    + 修改相应的配置文件
    + 重启 service ： `docker-compose -f ~/PrometheusStackDockerCompose/docker-compose.yml restart <service-name>`

2. 注册 Exporter 到 Consul 以供 Prometheus Server 发现并拉取 metrics 数据

比如将

```
curl -X PUT -d '{"id": "host1-node","name": "host1-node","address": "<host1-ip>","port": 9100,"tags": ["node_exporter"],"checks": [{"http": "http://<host1-ip>:9100/","interval": "5s"}]}' http://<monitor-ip>:8500/v1/agent/service/register
```

其中 `-d` 参数 `json` 数据内容为：

```
{
  "id": "host1-node",
  "name": "host1-node",
  "address": "<host1-ip>",
  "port": 9100,
  "tags": [
    "node_exporter"
  ],
  "checks": [
    {
      "http": "http://<host1-ip>:9100/",
      "interval": "5s"
    }
  ]
}
```

```
cat temp.json|jq -a
cat temp.json|jq -c
```

3. 将 Exporter 从 Consul 中移除（同时回从 Prometheus Server 中移除对此 Exporter 的 metrics 数据的拉取）

```
# 将 service monitor-node 移除
curl  --request PUT  http://localhost:8500/v1/agent/service/deregister/monitor-node
```

*. 访问 grafana

    + 浏览器访问： https://gf.domain.name
    + dashboard 可以浏览器导入，插件安装具体操作见[官方文档](http://docs.grafana.org/plugins/installation/)

## Supported Exporters

+ [node_exporter v0.15.2](https://gitee.com/atompi/node_exporter/releases/v0.15.2)
+ [mysqld_exporter 0.10.0](https://github.com/prometheus/mysqld_exporter/releases/tag/v0.10.0)
+ [redis_exporter v0.21.0](https://github.com/oliver006/redis_exporter/releases/tag/v0.21.0)
+ [nginx_exporter](https://github.com/mission802/nginx_exporter/releases/tag/v1.0)
+ [prometheus-pusher](https://gitee.com/atompi/prometheus-pusher)
+ [*_client](https://prometheus.io/docs/instrumenting/clientlibs/)

## 参与贡献

1. Fork 本项目
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


## 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [http://git.mydoc.io/](http://git.mydoc.io/)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)