插件集成

Site24x7 的插件集成（即插件）帮助您扩展整个技术栈的监控能力，支持采集针对特定应用程序、服务或系统的性能指标。

通过插件集成，您可以：

• 使用 100 多个开箱即用的插件集成监控流行的应用程序和服务，包括 Web 服务器、数据库、缓存和消息队列。
• 使用自定义脚本构建专属插件，从任何应用程序、系统或服务中采集性能数据，满足您组织或 IT 生态系统的特定需求，并在 Site24x7 中查看数据。
• 利用 Site24x7 的平台功能构建自定义仪表板，设置基于阈值的通知，自动修复 IT 事件等。

工作原理

无论是开箱即用还是自定义的插件集成，都利用脚本从相关应用程序或服务中采集监控数据。在 Site24x7 中安装和添加插件需要 Windows 或 Linux 服务器监控 Agent。Agent 成功安装后，将执行添加到 Agent 目录中的插件脚本，并将输出推送至 Site24x7 数据中心。所得数据可在 Site24x7 Web 客户端中查看。

什么是插件模板？

Site24x7 中的插件模板是一种用户自定义的监视器类型，允许自定义监控属性和单位。插件中 JSON 输出的键在模板中定义其属性。该模板允许用户通过选择相关属性并在插件监视器详情页面显示来自定义性能图表。

注册新插件脚本时，Site24x7 会检查属性是否与现有模板匹配。如果不匹配，将创建新模板；否则，将映射到现有模板。修改插件的 JSON 键（即编辑模板）需要将插件版本号加 1。

例如，在 Site24x7 服务器上注册自定义插件脚本后，将自动生成相应的插件模板，定义其性能属性。

了解更多关于插件模板及其编辑方法，请点击此处。

什么是插件监视器？

插件监视器在 Site24x7 中根据已注册的插件模板生成，用于跟踪模板中定义的属性。

例如，安装在 N 台服务器上的 mysql_monitoring.py 模板将创建 N 个 MySQL 插件监视器。

入门

100 多个开箱即用的插件集成

Site24x7 提供 100 多个开箱即用的插件集成，包括 Apache、MongoDB、Kafka、Tomcat 和 Nagios，可监控您的应用程序、数据库、负载均衡器、消息代理、缓存等。

查看 Site24x7 支持的所有插件集成列表，请点击此处。

如何设置开箱即用的插件集成

您可以通过导航到应用 > 插件集成 > +，点击所需插件，并按照每个插件的详细内联文档进行安装。您也可以访问此处的插件专属网页并查看相关文档。 

一般情况下，请按以下步骤安装任意插件：

1. 安装 Site24x7 服务器监控 Agent（Windows | Linux）。
2. 确保已满足特定插件的相关前提条件（包括提供访问权限或安装依赖模块）。
3. 从我们的 GitHub 仓库下载所需的插件文件。Site24x7 Web 客户端中的详细文档或插件网页上也列出了每个插件需要下载的文件。
4. 将下载的文件放在与文件同名的文件夹中。
   例如，如果您下载了 Apache 监控插件文件 apache_monitoring.py 和 apache_monitoring.cfg，请将这些文件放在名为 apache_monitoring 的文件夹中。
5. 编辑 .cfg 文件，添加特定于应用程序的配置。每个插件的配置内容不同。请参阅每个插件的详细文档，了解需要在 .cfg 文件中进行哪些编辑。
6. 将文件夹（连同其中的文件）放置在 Site24x7 服务器监控 Agent 文件夹中。
   Linux：/opt/site24x7/monagent/plugins/
   Windows：C:\Program Files (x86)\Site24x7\WinAgent\monitoring\plugins/

构建自定义插件

在 Site24x7 中使用 Zia 创建自定义监控插件。支持以多种语言生成脚本，用于监控应用程序、数据库、操作系统指标、云服务、API 等。

您也可以编写自己的插件脚本，从系统和服务中监控所需的自定义指标，并在 Site24x7 Web 客户端中查看数据。 

Site24x7 支持 Linux 上的 Python 或 Shell 脚本，以及 Windows 上的 Batch、PowerShell、VB 和 DLL。

了解编写自定义插件的一些前提条件。

如果您在环境中有适用于流行服务和应用程序的插件脚本，并希望与其他 Site24x7 用户共享，请按照此文档中的步骤操作。如果插件在我们的仓库中发布，您将有机会赢得礼品券。

在单个插件脚本中添加多个配置

如果您的环境中运行着多个应用程序实例，可以使用单个插件脚本配置所有实例的监控。 

对于开箱即用的插件，请在插件的 .cfg 文件中添加多个配置，如下所示。请注意，这些配置因安装的插件不同而有所差异。

[instance_1]
hostname='193.167.1.0'
port = 3306
username = 'test'
password = 'test'

[instance_2]
hostname='194.168.2.0'
port = 3306
username = 'test'
password = 'test'

对于自定义插件，请按照此文档中的步骤操作。

批量安装

如果需要同时在多台服务器上安装插件，可以使用我们的插件批量安装方法。

a. 通过 Web 客户端批量安装开箱即用的插件

您可以从我们支持的插件中选择，通过 Web 客户端在您的服务器上快速部署预定义插件。
操作步骤：

1. 确保已为 Linux/Windows 监控 Agent 启用 IT 自动化模块。 
2. 导航到应用 > 插件批量安装。
3. 选择开箱即用插件单选按钮。
4. 从选择插件下拉菜单中，选择要添加到服务器的插件。
5. 在显示的字段中，为批量安装提供名称，选择操作系统类型，选择要安装插件的所有主机，并根据需要提供相关配置。
6. 阅读并勾选免责声明，然后点击安装。上传的插件将安装到所选主机上。如果所选主机上已存在同名插件，将被新插件替换。

要检查安装状态，请点击页面右上角的安装历史选项卡。

b. 通过 Web 客户端在 Windows 或 Linux 服务器上批量安装任意插件

您可以从 GitHub 仓库配置和部署插件，或在 Windows 和 Linux 环境中安装自定义插件。
操作步骤：配置插件文件，并将其压缩为 ZIP 文件进行批量安装。

请参阅以下文档中的详细步骤以开始操作：

• Windows 服务器批量安装指南
• Linux 服务器批量安装指南

应用程序发现

应用程序发现可帮助您自动检测在服务器上运行的应用程序，并从单一界面快速部署监控插件。

它提供对环境的即时可视化，并简化跨多台服务器的插件部署。

容量规划

容量规划为插件监视器提供分析洞察，帮助您确定特定操作或工作负载所需的容量，以优化资源。通过分析指标相关数据，您可以高效地规划、管理和按需分配额外资源。

安全性

所有插件文件均可在 Site24x7 的 GitHub 仓库中获取。 Site24x7 监控 Agent 将根据您的轮询设置，通过标准协议（在插件脚本文件中定义）与应用程序监控接口通信，采集性能数据。只有已执行插件的输出会被上传到 Site24x7 数据中心。Site24x7 不存储或访问脚本文件中的任何敏感和机密数据。您可以选择在安装 Agent 时禁用插件添加功能。

如果插件配置文件包含密码，这些密码将在第一次数据采集时被加密。插件配置存储在插件脚本所在的服务器上。不会有任何配置被发送到 Site24x7；只有从应用程序实例采集的指标才会发送到 Site24x7 并以图形形式展示。

Windows 插件文件夹路径：C:\Program Files (x86)\Site24x7\WinAgent\monitoring\Plugins\

Linux 插件文件夹路径：/opt/site24x7/monagent/plugins/

后续步骤

库存仪表板

您可以在库存仪表板中查看插件的安装状态、关联的服务器监视器、轮询间隔、版本等信息。进入应用 > 库存仪表板，在同一位置查看所有插件监视器。  

设置阈值

添加插件监视器后，关联阈值与可用性配置文件，帮助告警引擎判断特定资源是否需要被声明为严重或宕机状态。  

结合日志分析指标

为了分析应用程序日志并找出问题的确切根因，您可以通过向插件配置文件添加 logs_enabled、log_type_name 和 log_file_path 来进行配置更改。

log_type_name 定义应用程序写入日志的格式。Site24x7 支持 30 多种不同的日志类型。此外，您还可以创建自定义日志类型。

示例：

logs_enabled ="true"
log_type_name="MySQL Error"
log_file_path="/var/mysql/log/error.txt"

在插件脚本中，在字典名称 "applog" 下添加 logs_enabled、log_type_name、log_file_path，如下所示：

"applog": {
logs_enabled ="true"
log_type_name="MySQL Error"
log_file_path="/var/mysql/log/error.txt"
                  }

请注意，执行这些更改需要在账户级别和服务器级别启用 AppLogs。

启用 AppLogs 的步骤：

1. 登录 Site24x7。
2. 要在账户级别启用 AppLogs，进入管理 > AppLogs > 设置，将是配置为使用 AppLogs 从服务器采集应用程序日志。
3. 要在服务器级别启用 AppLogs，进入服务器 > 服务器监控 > 服务器，选择服务器监视器，导航到 AppLogs 选项卡，然后点击启用 AppLogs。

许可

为服务器监视器添加的第一个插件免费。之后，每个插件监视器按基本监视器计费。

故障排除提示

• 插件错误处理消息
• Linux 插件未添加到 Site24x7 账户的可能原因
• Windows 插件未添加到账户的可能原因
• 为什么我的 MySQL 插件无法添加到 Site24x7？
• Nagios 插件无法正常工作的可能原因
• 从 Site24x7 Web 客户端删除插件监视器后会发生什么？
• 在哪些情况下插件监视器会移至忽略列表？

有关完整的文章列表，请参阅我们的插件集成知识库。

相关文章

• 构建自定义插件：Windows | Linux
• 插件的阈值与可用性
• 构建和分享自定义仪表板
• 添加服务器监视器
• 服务器监控架构 
• IT 自动化