自定义插件接入AOM

前提条件

• 主机已安装UniAgent，且状态为运行中。
• 已创建ECS Prometheus实例。

创建自定义插件

AOM支持用户按需求通过自定义脚本的方式创建插件，并在自定义插件接入中创建采集任务使用该插件，将指标上报到AOM。

1. 登录AOM 2.0控制台。
2. 在左侧导航栏选择“接入中心 > 接入中心”，进入旧版接入中心。（当前新版接入中心不支持自定义插件接入AOM。如果您进入的是新版接入中心，可单击“接入中心”页面右上角“返回旧版”，进入旧版接入中心。）
3. 在“Prometheus 自定义插件接入”面板单击“新增自定义插件”卡片。
4. 在创建插件页面中，配置相关参数信息。
   • 插件信息

     表1 插件信息参数表

     参数	说明
     插件名称	自定义插件的名称。由字母、数字、下划线组成，且以字母开头，最大32个字符。
     插件类型	插件的类型。默认为自定义类型。
     描述	对创建插件的描述。描述长度不能超过20000个字符。

   • 插件配置

     表2 插件配置参数表

     参数	说明
     插件版本	自定义插件的版本号。
     插件脚本	自定义插件脚本。通过插件脚本自定义需要上报到AOM的指标数据，脚本类型为Linux和Windows。 Linux：Shell脚本和Python脚本。 示例： #!/bin/bash #Examples echo "metric_name{label_name=\"label_value\"} 100" Windows：Bat脚本 示例： ::Examples @echo off echo metric_name{label_name="label_value"} 100
     默认脚本参数	自定义插件脚本的默认参数。如果执行插件脚本时，需要默认的参数进行脚本建模，可在此处进行配置，否则可为空。具体的填写规则如下： ${参数名}：参数名支持以字母、数字或下划线组成，且必须是以字母开头，长度不能超过64个字符，例如：${a_b}。 您可以根据自己的需求任意组合，如配置多个参数可以用以空格分隔，总字符长度不能超过250。例如：${a} ${b}。
     脚本参数	配置自定义插件脚本的默认参数的属性。您可以根据实际需求，配置脚本参数的属性信息如下： 必填：开启该按钮，插件调试中的参数值为必填项；关闭该按钮，插件调试中的参数值可不填写。 参数名：脚本参数的名称。当配置了“默认脚本参数”后，会根据“默认脚本参数”中自定义的参数自动识别脚本参数名称，此处灰化，不可配置。 默认值：脚本参数默认值。 描述：对参数的描述。 为该自定义插件配置采集任务时，页面会根据此处配置的脚本参数属性，展示对应的脚本参数。您可根据脚本参数属性信息，进行相关采集配置。

5. 完成后，单击“保存”。

   插件创建完成后，您可以对自定义插件进行编辑插件、为插件创建新版本和删除插件等操作。

   表3 相关操作

   操作	说明
   查看插件状态	选择待操作的插件，鼠标悬浮显示，选择“版本”。在弹出页面中查看插件状态。 未上线：当新建插件或创建新版本插件时，插件状态为“未上线”；单击版本号可以编辑插件信息。 已上线：当单击操作列下的“上线”后，插件状态为“已上线”；单击版本号可以查看插件信息。
   创建新版本	选择待操作的插件，鼠标悬浮显示，选择“版本”。单击“创建新版本”，在弹出页面中，进行插件配置。 创建新版本时注意以下事项： 一个插件最多可创建5个不同版本。 当只有一个插件版本时，操作列下只有复制插件操作；当存在两个及以上版本的插件时，操作列下有复制和删除操作，单击插件对应操作列下的“删除”按钮，可删除该插件版本信息。
   编辑插件	选择待操作的插件，鼠标悬浮显示，选择“编辑”，在弹出的编辑页面中，修改插件信息。
   删除插件	选择待操作的插件，鼠标悬浮显示，选择“删除”，在弹出页面中，单击“确认”，删除插件。 如果插件已配置采集任务，则删除后，该插件对应的采集任务也会被删除。

配置自定义插件接入AOM

1. 登录AOM 2.0控制台。
2. 在左侧导航栏选择“接入中心 > 接入中心”，进入旧版接入中心。（当前新版接入中心不支持自定义插件接入AOM。如果您进入的是新版接入中心，可单击“接入中心”页面右上角“返回旧版”，进入旧版接入中心。）
3. 在“Prometheus 自定义插件接入”面板单击创建的自定义插件卡片。
4. 在配置页面中，参考下表配置采集任务相关参数信息。
   图1 配置采集任务
   

   表4 采集任务参数配置表

   操作	参数	说明
   选择实例	Prometheus实例	选择一个ECS Prometheus实例用于存储采集数据。 采集任务通过关联ECS Prometheus实例，对采集数据进行标记分类。若当前没有可选的Prometheus实例，可以创建Prometheus for ECS类型实例。
   插件配置	操作系统	主机的操作系统，支持Linux和Windows。基于创建的自定义插件脚本的操作系统自动选择。
   	采集插件	默认已创建的自定义插件卡片。
   	插件版本	选择插件的版本。未上线的插件版本，则置灰，无法选择。
   采集任务	采集任务名	自定义采集任务的名称。长度范围为1到50个字符，支持大小写字母、数字、下划线、中划线，以字母开头。
   	主机	单击“添加主机”，在“添加主机”页面中选择用于配置采集任务和安装Exporter的主机： 可通过主机名称、IP地址和Agent状态搜索选择主机。 可通过右上角，取消已勾选的主机。 选择的主机必须是UniAgent状态为运行中的主机，否则创建的采集任务无法采集数据。
   	插件采集配参	配置自定义的插件脚本参数信息。该参数来自创建自定义插件脚本时定义的默认脚本参数。
   	高级设置	配置如下采集信息： 采集周期(秒)：采集数据的周期，单位为秒（s），默认为60s，可选择10s、30s和60s。 超时时间(秒)：执行采集任务的超时时间，单位为秒（s），默认为60s，可选择10s、30s和60s。超时时间必须小于等于采集周期。 执行用户：执行采集任务的用户，即所选主机的用户，默认为root。您可以根据主机用户，填写执行采集任务的用户，推荐填写root。

5. 单击“立即创建”，完成自定义插件接入。
6. 已接入的插件会显示在插件卡片的采集任务页签。单击插件卡片，然后在采集任务页签单击对应的采集任务名称，在弹出的面板中可以查看采集任务的配置信息。