You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ConsulManager/README.md

7.9 KiB

如何优雅的使用Consul管理站点监控

关注公众号【云原生DevOps】加入运维群交流,获取更多...

实现功能

  • 基于Prometheus + Blackbox_Exporter实现站点与接口监控。
  • 基于Consul实现Prometheus监控目标的自动发现。
  • Blackbox Manager基于Flask + Vue实现的Web管理平台可以简单的对监控目标增删改查便于分类维护管理。
  • 实现了一个脚本可批量导入监控目标到Consul。
  • 更新了一个Blackbox Exporter的Grafana展示看板。

v0.1.2更新

  • 所有字段增加了排序功能
  • 新增筛选功能:可以根据名称或实例来进行关键字筛选
  • 新增清空查询条件按钮
  • 简化了web界面新增操作
    • 选择选项查询后,点击新增或自动填写好选择的选项
    • 增加确认并新增按钮可以自动填上之前填写的前4个字段
  • 新增批量删除功能
  • 新增分页功能
更新docker-compose pull && docker-compose up -d

截图

Blackbox Manager Web管理界面

0

Blackbox Exporter Dashboard 截图

12

部署说明

部署Consul

安装
# 使用yum部署consul
yum install -y yum-utils
yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo
yum -y install consul
# 或者直接下RPM包安装
wget https://rpm.releases.hashicorp.com/RHEL/7/x86_64/stable/consul-1.11.1-1.x86_64.rpm
rpm -ivh ./consul-1.11.1-1.x86_64.rpm
配置
vi /etc/consul.d/consul.hcl
data_dir = "/opt/consul"
client_addr = "0.0.0.0"
ui_config{
  enabled = true
}
server = true
bootstrap = true
acl = {
  enabled = true
  default_policy = "deny"
  enable_token_persistence = true
}
启动与鉴权配置
systemctl enable consul.service
systemctl start consul.service
# 获取登录密码
consul acl bootstrap
# 记录 SecretID

部署Blackbox Manager

使用docker-compose来部署

编辑docker-compose.yaml文件修改传入的3个环境变量

  • consul的tokenconsul的URL(/v1要保留)登录Blackbox Manager的密码

  • 启动:docker-compose up -d

  • 访问:http://{IP}:1026

Consul字段设计说明
  • 所有数据存在一个名为blackbox_exporter的Services项中每个监控目标为一个子Service。
  • 每个Service包含一个Tag会自动配置为meta中的module的值作为Prometheus自动发现的tags。
  • 每个Service使用Meta的kv保存监控目标的明细
  • modulecompanyprojectenvnameinstance
  • 分别表示监控类型公司部门项目环境名称实例url
  • 前5个字段合并即为consul的serviceID作为唯一监控项标识
  • 建议监控类型字段:meta内的moduleblackbox-exporter配置中的modulePrometheus的job名使用同一命名。

配置Prometheus

基于Consul实现Prometheus的自动发现功能配置
  • 根据Consul每个service的tag来把监控目标关联到Prometheus的JOB。
  • 把Consul每个service的Meta的KV关联到Prometheus每个指标的标签。
  • 根据每个指标的标签来对监控目标分类,分组,方便管理维护。

以下配置的同一个job的job_namemoduletags使用同一命名关联jobmodule与consul的tags

vi prometheus.yml
#####blackbox_exporter#####
  - job_name: 'http_2xx'
    metrics_path: /probe
    params:
      module: [http_2xx]
    consul_sd_configs:
      - server: 'x.x.x.x:8500'
        token: 'xxx-xxx-xxx-xxx'
        services: ['blackbox_exporter']
        tags: ['http_2xx']
    relabel_configs:
      - source_labels: ["__meta_consul_service_metadata_instance"]
        target_label: __param_target
      - source_labels: ["__meta_consul_service_metadata_company"]
        target_label: company
      - source_labels: ["__meta_consul_service_metadata_env"]
        target_label: env
      - source_labels: ["__meta_consul_service_metadata_name"]
        target_label: name
      - source_labels: ["__meta_consul_service_metadata_project"]
        target_label: project
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9115
  - job_name: 'http_4xx'
    metrics_path: /probe
    params:
      module: [http_4xx]
    consul_sd_configs:
      - server: 'x.x.x.x:8500'
        token: 'xxx-xxx-xxx-xxx'
        services: ['blackbox_exporter']
        tags: ['http_4xx']
    relabel_configs:
      - source_labels: ["__meta_consul_service_metadata_instance"]
        target_label: __param_target
      - source_labels: ["__meta_consul_service_metadata_company"]
        target_label: company
      - source_labels: ["__meta_consul_service_metadata_env"]
        target_label: env
      - source_labels: ["__meta_consul_service_metadata_name"]
        target_label: name
      - source_labels: ["__meta_consul_service_metadata_project"]
        target_label: project
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9115
  - job_name: 'tcp_connect'
    metrics_path: /probe
    params:
      module: [tcp_connect]
    consul_sd_configs:
      - server: 'x.x.x.x:8500'
        token: 'xxx-xxx-xxx-xxx'
        services: ['blackbox_exporter']
        tags: ['tcp_connect']
    relabel_configs:
      - source_labels: ["__meta_consul_service_metadata_instance"]
        target_label: __param_target
      - source_labels: ["__meta_consul_service_metadata_company"]
        target_label: company
      - source_labels: ["__meta_consul_service_metadata_env"]
        target_label: env
      - source_labels: ["__meta_consul_service_metadata_name"]
        target_label: name
      - source_labels: ["__meta_consul_service_metadata_project"]
        target_label: project
      - source_labels: [__param_target]
        target_label: instance
      - target_label: __address__
        replacement: 127.0.0.1:9115

配置Blackbox_Exporter

参考配置2XX4XXTCP类型的监控注意模块名称不要与已有的重复。

cat blackbox.yml
modules:
  http_2xx:
    prober: http
    http:
      valid_status_codes:
      - 200
      - 301
      - 302
      - 303
      no_follow_redirects: true
      preferred_ip_protocol: ip4
      ip_protocol_fallback: false

  http_4xx:
    prober: http
    http:
      valid_status_codes:
      - 401
      - 403
      - 404
      preferred_ip_protocol: ip4
      ip_protocol_fallback: false

  tcp_connect:
    prober: tcp

批量导入脚本

在units目录下instance.list中写入监控目标的信息JOB名称公司/部门项目环境名称实例url每行一个空格分隔。 注意前5个字段组合起来必须唯一作为一个监控项的ID。 修改units目录下导入脚本中的consul_token和consul_url保存后执行input.py即可导入所有监控目标到Consul并符合Prometheus的自动发现配置。

导入Blackbox Exporter Dashboard

  • 支持Grafana 8基于blackbox_exporter 0.19.0设计
  • 采用图表+曲线图方式展示TCPICMPHTTPS的服务状态各阶段请求延时HTTPS证书信息等
  • 优化展示效果,支持监控目标的分组、分类级联展示,多服务同时对比展示。
导入ID9965
详细URLhttps://grafana.com/grafana/dashboards/9965

GitHub

所有代码都在里面,抛砖引玉。

https://github.com/starsliao/ConsulManager