Close
Log in to Zabbix Blog
Email
Password
Show password Hide password
Forgot password?
Incorrect e-mail and/or password
or
By creating an account or logging in with an existing account, you agree to our Terms of Service
案例研究如何技术的社区会议登录

Zabbix 与 Docker API,第 2 部分:改造

在这篇博客文章中,我将向您展示如何创建一个仅通过 API 调用(无需 Zabbix agent 2)来监控 D […]

在这篇博客文章中,我将向您展示如何创建一个仅通过 API 调用(无需 Zabbix agent 2)来监控 Docker 服务器的模板。我们不会从头开始创建模板、模板监控项、LLD 规则和触发器原型,而是基于现有模板“Docker by Zabbix agent 2”对它们进行改造。

Zabbix agent 2 是如何做到的?

如果您想知道 Zabbix agent 2 是如何采集数据的,可以查看源代码,了解其背后的奥秘:https://github.com/zabbix/zabbix/blob/master/src/go/plugins/docker/metrics.go。

简而言之,它使用非 TCP 的 Unix 套接字,在主机上发起 Docker API 请求,并返回 JSON 对象。嘿,通过上一篇博客文章,我们已经知道如何自己使用它了,对吧?

要让 Zabbix agent 2 配合 Docker 模板工作,它需要访问 Unix 套接字,方法是将用户 Zabbix 添加到组 Docker 中,或者以 root 身份运行 Zabbix-agent2。

图 1. Zabbix agent 2 Docker 插件源代码

我们的实现方法

我可以改造这个模板,在遇到不存在的指标时随机应变,并努力克服任何技术挑战!该模板主要包含几个批量采集数据的 Zabbix agent 监控项,以及大量依赖监控项(还有 LLD 规则中的依赖监控项原型)。

接下来的做法非常简单:我们将克隆该模板,把 Zabbix agent 监控项类型替换为 HTTP agent 类型的监控项,并添加下文所示的其他参数。我还会在模板上添加更多用户宏,包括 Docker 服务器的 IP 地址、端口、CA、SSL 证书和密钥文件名,以便在主机级别调整这些值。

图 2. 模板修改的工作流

克隆模板并更改监控项类型

首先,克隆模板“Docker by Zabbix agent 2”,并为其指定新名称:“Docker stats by HTTP”。接下来,使用以下参数修改 Zabbix agent 类型的模板监控项配置:

图 3. 模板监控项配置的修改

修改“Docker by HTTP”模板监控项:

● Modify item: Get containers
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers/json?all=true     
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Get data_usage
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/system/df
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Get images
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/images/json
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
●Modify item: Get info
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/info
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● Modify item: Ping
  ▪ Type HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/_ping
  ▪ Type of inf: Text
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
♯ Preprocessing (additional first step)
  ▪ Boolean to Decimals

我们还需要修改 LLD 规则配置。将监控项类型从 Zabbix agent 类型更改为 HTTP agent 类型:

图 4. LLD 发现规则的修改:containers discovery
Modify LLD rule: Containers discovery
● Discovery rule
  ▪ Type: HTTP agent
  ▪ Key: docker.containers.discovery[true]
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers/json?all=true     
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
  ▪ Update interval: 1h
● LLD macros
  ▪ {#ID}   $.Id
  ▪ {#NAME} $.Names.first()
Modify LLD rule: Images discovery
● Discovery rule
  ▪ Type: Dependent item
  ▪ Master item: item> Get images
● LLD macros
  ▪ {#ID}   $.Id
  ▪ {#NAME} $.RepoTags

之后,我们还将对 LLD 规则“Containers discovery”进行更改:修改几个现有的监控项原型(Zabbix agent 类型),并添加一个新监控项。以下是需要修改的监控项原型:

● In LLD rule Containers discovery, modify parameters for item prototype: Container {#NAME}: Get info
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers{#NAME}/json       
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● In LLD rule Containers discovery, modify item prototype: Container {#NAME}: Get stats
  ▪ Type: HTTP agent
  ▪ URL: https://{$DOCKER.IP}:{$DOCKER.PORT}/containers{#NAME}/stats?stream=false  
  ▪ SSL verify peer: Checked
  ▪ SSL verify host: Checked
  ▪ SSL certificate file: {$SSL.CERTIFICATE.FILE}
  ▪ SSL key file: {$SSL.KEY.FILE}
  ▪ SSL key password: {$SSL.KEY.PASSWORD}
● In LLD rule Containers discovery, modify parameters for item prototype: Container {#NAME}: CPU percent usage
  ▪ Type: Calculated
  ▪ Formula: last(//docker.container_stats.cpu_usage.total.rate["{#NAME}"])/last(//docker.container_stats.system_cpu_usage.total.rate["{#NAME}"])*last(//docker.container_stats.online_cpus["{#NAME}"])*100
♯ Preprocessing (delete preprocessing step JSONPath)
● In LLD rule Containers discovery, add new item prototype: Container {#NAME}: System CPU total usage per second
  ▪ Name: Container {#NAME}: System CPU total usage per second
  ▪ Type: Dependent item
  ▪ Key: docker.container_stats.system_cpu_usage.total.rate["{#NAME}"]
  ▪ Type of information Numeric (float)
  ▪ Master item    prototype > Container {#NAME}: Get stats

♦ Tags (name:value)        
  ▪ component:cpu
  ▪ container:{#NAME}      

♯ Preprocessing

  ▪ JSONPath       $.cpu_stats.system_cpu_usage
  ▪ Change per second
  ▪ Custom multiplier: 1.0E-9

(再次)克隆模板并进行少量修改

接下来,我将克隆模板“Docker statistics by HTTP”,并为副本指定新名称:“Docker containers by HTTP”。在模板“Docker containers by HTTP”中,删除 LLD 规则 Images discovery;删除模板监控项;从 LLD 规则“Containers discovery”中删除所有原型实体(监控项原型),并在该 LLD 规则中添加过滤器(如下所示):

In LLD rule Containers discovery rule, in Filter tab: add additional filter option
Filters [type of calculation: A and B and C]
   ▪ {#ID} matches {HOST.HOST}

我还创建了一个主机组“Docker”,已发现的容器主机将被添加到该组中。在模板“Docker statistics by HTTP”中,删除 LLD 规则“Containers discovery”中的所有监控项原型。我们将在 LLD 发现规则“Containers discovery”中创建一个主机原型,参数如下所示:

Host prototype in LLD rule: Containers discovery
  ▪ Host name:     {#ID}
  ▪ Visible name:  {#NAME}
  ▪ Templates:     Docker containers by HTTP
图 5. LLD 规则中的主机原型设置:Containers discovery
图 6. 克隆并修改后的模板

创建主机并链接模板

现在只剩下创建主机并链接模板:“Docker statistics by HTTP”。不要忘记在用户宏中填写正确的 Docker IP 地址或 DNS 名称。

我创建了一个新主机“Docker server”,链接了模板,并修改了 Docker IP 地址对应的用户宏。该主机将采集 Docker 的整体统计信息。LLD 发现执行后,容器名称将被自动发现,并会创建链接了模板的容器主机。

图 7. 已发现的容器主机及其链接的模板

如果出于某种原因您需要监控多个 Docker 实例,可能会发现相同的容器名称,这会导致 LLD 错误,因为不能存在名称(容器 ID)或可见名称(容器名称)相同的主机。快速解决方法:针对每个 Docker 实例,为每个容器名称添加前缀。另一种解决方法:不要将模板拆分为两部分,这样监控项将在同一主机下被发现,您也就不会遇到这个问题。

Docker server 主机显示有关 Docker 服务器整体状态和运行状况的常规信息:

图 8. Docker server 主机的最新数据

系统会为每个已发现的容器自动创建一个主机,用于采集该容器特定的性能指标:

图 9. 容器 zabbix-agent2 的最新数据

总结

现在,您和我都对 Zabbix agent2 如何采集 Docker 指标有了更多了解。这篇博客文章向您展示了如何随机应变,借助不同的数据采集方法改造现有模板。Zabbix 是一款用途非常广泛的工具,如果您受到某些技术限制,可以通过多种方式获取数据。文中提供的模板既可以直接使用,也可以根据您的需求进行修改。

Prev Post Prev Post Next Post Next Post
订阅评论
提醒
0 Comments
最旧
最新 最多投票
0
希望看到您的想法,请您发表评论x