18、Zabbix与外部服务集成及API功能扩展全攻略

Zabbix与外部服务集成及API功能扩展全攻略

1. Zabbix与外部服务集成

Zabbix可以与多种外部服务集成，方便用户及时获取监控问题的通知。下面详细介绍与Microsoft Teams、Telegram和Atlassian Opsgenie的集成方法。

1.1 集成Microsoft Teams

• 操作步骤 ：在Zabbix中配置好相关条件，当问题符合条件时，会将问题发送到Microsoft Teams连接器。点击蓝色的“Add”按钮完成配置后，即可在MS Teams频道中查看新问题。
• 工作原理 ：Zabbix服务器创建问题，若问题匹配配置条件，就会将其发送到Microsoft Teams连接器，该连接器直接配置在频道上，会在频道中发布通知。例如，可配置Zabbix仅将严重程度为警告或更高的问题发送到Microsoft Teams。

1.2 集成Telegram

• 准备工作 ：确保Zabbix服务器就绪，安装Telegram应用并设置好账户。
• 操作步骤 ：
  1. 在Telegram中创建新群组，添加团队成员，设置群组名称和图片，点击“Create”按钮。
  2. 通过搜索“botfather”并点击该联系人，与@BotFather用户交互。
  3. 在聊天中输入“/start”命令获取可用命令列表。
  4. 输入“/newbot”创建新机器人，设置机器人名称和唯一用户名，保存HTTP API密钥。
  5. 将机器人添加到Zabbix Notifications群组。
  6. 导航到Zabbix前端，进入“Administration | Media types”，点击“Telegram”媒体类型，将之前生成的HTTP API密钥添加到“Token”字段，点击“Update”按钮。
  7. 在Telegram群组中添加另一个用户，返回Zabbix前端。
  8. 若未进行过相关配置，在Zabbix中创建新用户组，设置权限，点击“Add”按钮。
  9. 创建新用户，获取Telegram群组ID，添加媒体和用户角色，将群组ID添加到“Send to”字段，点击“Add”按钮。
  10. 若未进行过相关配置，在Zabbix中创建新动作，设置名称和操作，点击“Add”按钮。
• 工作原理 ：Zabbix通过Webhook将符合配置条件的问题发送到Telegram机器人，机器人接收问题并在群组中发布通知。例如，可配置仅将严重程度为警告或更高的问题发送到Telegram机器人。

graph LR
    A[Zabbix服务器] -->|符合条件的问题| B[Telegram机器人]
    B -->|发布通知| C[Telegram群组]

1.3 集成Atlassian Opsgenie

• 准备工作 ：确保Zabbix服务器就绪，拥有Atlassian Opsgenie账户并准备好使用。
• 操作步骤 ：
  1. 登录Atlassian Opsgenie，进入“Settings”，点击“Notifications”，添加邮箱和电话号码。
  2. 导航到“Teams”，点击“Add team”按钮，添加团队信息，点击“Add”按钮。
  3. 进入新团队页面，点击“Integrations”，点击“Add integration”按钮，搜索“Zabbix”并点击“Add”，复制API Key，点击“Save integration”按钮。
  4. 在Zabbix服务器CLI中执行以下代码：
     • 对于RHEL-based系统：

wget https://github.com/opsgenie/oec-scripts/releases/download/Zabbix-1.1.6_oec-1.1.3/opsgenie-zabbix-1.1.6.x86_64.rpm

    - 对于Ubuntu系统：

wget https://github.com/opsgenie/oec-scripts/releases/download/Zabbix-1.1.6_oec-1.1.3/opsgenie-zabbix_1.1.6_amd64.deb

5. 安装下载的Zabbix Opsgenie插件：
    - 对于RHEL-based系统：

rpm -i opsgenie-zabbix-1.1.6.x86_64.rpm

    - 对于Ubuntu系统：

dpkg -i opsgenie-zabbix_1.1.6_amd64.deb

6. 若未进行过相关配置，在Zabbix中创建新用户组，设置权限，点击“Add”按钮。
7. 导航到“Administration | Actions”，点击“Create action”按钮，设置名称和条件。
8. 点击“Operations”标签，添加操作，将“/home/opsgenie/oec/opsgenie-zabbix/actionCommand.txt”文件内容粘贴到操作中，重复此步骤设置恢复操作和更新操作，点击“Add”按钮。
9. 编辑配置文件：

vim /home/opsgenie/oec/conf/config.json

10. 编辑“apiKey”、“command_url”、“user”和“password”行，若不在美国，需编辑“baseUrl”。

• 工作原理 ：Zabbix中的警报通过集成发送到Opsgenie，利用Opsgenie API捕获信息并按需回复，实现两个应用之间的双向通信。

2. Zabbix API功能扩展

Zabbix不仅可以与外部服务集成，还能通过API进行功能扩展。下面介绍设置和管理API令牌以及使用API扩展功能的方法。

2.1 设置和管理API令牌

• 准备工作 ：确保Zabbix设置运行正常，使用前端生成API令牌。
• 操作步骤 ：
  1. 以超级管理员用户身份登录Zabbix前端。
  2. 导航到“Administration | User groups”，点击“Create user group”按钮。
  3. 创建新用户组，将“Group name”字段填写为“API users”。
  4. 切换到“Permissions”标签，点击“Select”按钮，选择所有主机组，给予API用户组读写权限，点击“Add”按钮。
  5. 点击“Add”按钮添加新用户组。
  6. 导航到“Administration | Users”，点击“Create user”按钮。
  7. 创建新用户“API user”，切换到“Permissions”标签，添加超级管理员角色，点击“Add”按钮。
  8. 导航到“Administration | General | API tokens”，点击“Create API token”按钮，填写用户为“API”，名称为“API book key”，设置过期时间，点击“Add”按钮。

• 注意事项 ：可以通过限制API Users用户组的主机组访问来限制API访问权限，根据实际环境选择合适的方式。

通过以上集成和API功能扩展，用户可以充分发挥Zabbix的强大功能，实现更高效的监控和管理。

2.2 使用Zabbix API扩展功能

Zabbix API可用于多种功能扩展，以下将介绍几个具体的应用场景。

2.2.1 构建跳转主机

借助Zabbix API和Python，我们可以构建一个跳转主机。虽然这里没有详细的代码示例，但基本思路是通过Python脚本调用Zabbix API，实现对主机的访问和操作。以下是一个简单的Python代码框架，用于调用Zabbix API进行身份验证：

import requests
import json

# Zabbix API URL
url = "http://your-zabbix-server/zabbix/api_jsonrpc.php"
# Headers for the API request
headers = {'Content-Type': 'application/json-rpc'}
# Payload for authentication
payload = {
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "user": "your-username",
        "password": "your-password"
    },
    "id": 1
}

# Send the request
response = requests.post(url, headers=headers, data=json.dumps(payload))
# Parse the response
result = response.json()
if 'result' in result:
    auth_token = result['result']
    print(f"Authenticated successfully. Auth token: {auth_token}")
else:
    print("Authentication failed.")

在这个代码中，我们首先定义了Zabbix API的URL和请求头，然后构建了一个用于身份验证的JSON有效负载。发送请求后，解析响应并获取身份验证令牌。

graph LR
    A[Python脚本] -->|调用API| B[Zabbix API]
    B -->|返回结果| A

2.2.2 创建维护周期

作为Zabbix用户，我们可以使用脚本创建维护周期。具体步骤如下：
1. 调用Zabbix API获取主机列表。
2. 选择需要设置维护周期的主机。
3. 构建维护周期的参数，如开始时间、结束时间等。
4. 调用Zabbix API创建维护周期。

以下是一个简化的Python代码示例：

# 假设已经获得了auth_token
payload = {
    "jsonrpc": "2.0",
    "method": "maintenance.create",
    "params": {
        "name": "My Maintenance Period",
        "active_since": 1630444800,  # 开始时间，时间戳
        "active_till": 1630531200,   # 结束时间，时间戳
        "hostids": ["12345"],        # 主机ID
        "timeperiods": [
            {
                "timeperiod_type": 0,
                "start_date": 1630444800,
                "period": 86400     # 持续时间，秒
            }
        ]
    },
    "auth": auth_token,
    "id": 2
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
result = response.json()
if 'result' in result:
    print(f"Maintenance period created successfully. ID: {result['result']['maintenanceids'][0]}")
else:
    print("Failed to create maintenance period.")

在这个代码中，我们构建了一个用于创建维护周期的JSON有效负载，并调用Zabbix API发送请求。

2.2.3 从Zabbix地图启用和禁用主机

使用脚本可以实现从Zabbix地图启用和禁用主机，具体操作步骤如下：
1. 调用Zabbix API获取Zabbix地图信息。
2. 选择需要操作的主机。
3. 根据操作需求（启用或禁用）构建相应的API请求。
4. 调用Zabbix API执行操作。

以下是一个简单的Python代码示例，用于禁用主机：

# 假设已经获得了auth_token
payload = {
    "jsonrpc": "2.0",
    "method": "host.update",
    "params": {
        "hostid": "12345",  # 主机ID
        "status": 1         # 1表示禁用，0表示启用
    },
    "auth": auth_token,
    "id": 3
}

response = requests.post(url, headers=headers, data=json.dumps(payload))
result = response.json()
if 'result' in result:
    print(f"Host updated successfully. Host ID: {result['result']['hostids'][0]}")
else:
    print("Failed to update host status.")

在这个代码中，我们构建了一个用于更新主机状态的JSON有效负载，并调用Zabbix API发送请求。

graph LR
    A[Python脚本] -->|调用API| B[Zabbix API]
    B -->|获取地图信息| C[Zabbix地图]
    B -->|操作主机| D[主机]

通过以上介绍，我们可以看到Zabbix API的强大功能。无论是与外部服务集成，还是进行功能扩展，Zabbix都提供了丰富的接口和工具。用户可以根据自己的需求，灵活运用这些功能，实现更高效、更个性化的监控和管理。在实际应用中，我们还可以根据具体场景对代码进行优化和扩展，以满足不同的业务需求。同时，要注意对API的使用权限进行合理管理，确保系统的安全性和稳定性。