XPack Watcher_监控报警_阿里云Elasticsearch-阿里云

本文档为您介绍阿里云Elasticsearch（简称ES）XPack Watcher的配置方法。您可以通过添加XPack Watcher实现当满足某些条件时执行某些操作，例如当logs索引中出现error日志时，自动发送报警邮件或钉钉消息。可以简单的理解为Watcher是一个基于ES实现的监控报警服务。

注意

XPack Watcher功能主要适用于单可用区的阿里云ES实例，不支持跨多可用区的阿里云ES实例。
使用XPack Watcher功能前，您需要首先在对应阿里云ES实例的ES集群配置 > YML文件配置页面，开启X-Pack Watcher功能（默认关闭），详情请参见常见问题。

功能介绍

XPack Watcher功能主要由Trigger、Input、Condition、Actions组成。

Trigger
确定何时检查，在配置Watcher时必须设置。支持丰富的时间计划方式，详情请参见Schedule Trigger。
Input
可以理解为您需要对监控的索引执行的筛选条件，详情请参见Inputs。
Condition
执行Actions的条件。
Actions
当条件发生时，执行的具体操作。

配置方式

阿里云ES的Watcher功能不支持直接与公网进行通讯，需要基于阿里云ES实例的内网地址来进行通讯（专有网络VPC环境）。如果您需要使用XPack Watcher，还需要购买一台能同时访问公网和阿里云ES实例的阿里云ECS实例，作为代理去执行Actions。

以配置Webhook Action为例（Webhook采用钉钉群机器人）。

购买阿里云ECS实例。
购买的ECS要与阿里云ES实例在同一个区域和VPC下，并且需要能够访问公网。
注意
- 阿里云ECS实例与阿里云ES实例的VPC必须相同。
- 阿里云ECS实例需要能访问公网。

配置ECS安全组。

在阿里云ECS控制台的实例列表页面，单击对应实例右方的更多 > 网络和安全组 > 安全组配置。
在安全组列表右侧的操作栏下，单击配置规则。
在安全组规则页面，单击添加安全组规则。

填写相关参数，单击确定，即可完成配置。


参数	说明
规则方向	选择入方向。
授权策略	选择允许。
协议类型	选择自定义TCP。
优先级	保持默认。
端口范围	填写您常用的端口（配置Nginx时需要用到，本文以8080为例）。
授权类型	选择IPv4地址段访问。
授权对象	添加您购买的阿里云ES实例所有节点的IP地址。说明您可以通过以下方式获取阿里云ES实例的IP地址列表。登录您购买的阿里云ES实例的Kibana控制台，单击左侧导航栏的Monitoring，再单击Nodes。

配置Nginx代理。

详情请参见Nginx安装配置。

修改Nginx配置文件，参考以下配置替换Nginx安装配置中描述的server部分的配置。

server
  {
    listen 8080;#监听端口
    server_name localhost;#域名
    index index.html index.htm index.php;
    root /usr/local/webserver/nginx/html;#站点目录
      location ~ .*\.(php|php5)?$
    {
      #fastcgi_pass unix:/tmp/php-cgi.sock;
      fastcgi_pass 127.0.0.1:9000;
      fastcgi_index index.php;
      include fastcgi.conf;
    }
    location ~ .*\.(gif|jpg|jpeg|png|bmp|swf|ico)$
    {
      expires 30d;
  # access_log off;
    }
    location / {
      proxy_pass <钉钉机器人webhook地址>;
    }
    location ~ .*\.(js|css)?$
    {
      expires 15d;
   # access_log off;
    }
    access_log off;
  }
}

<钉钉机器人webhook地址>：需要替换为接收报警消息的钉钉机器人的webhook地址。

说明您可以通过以下方式获取钉钉群机器人的webhook地址。

创建一个钉钉报警接收群，在群的右上角找到群机器人，然后添加一个自定义通过webhook接入的机器人，并获取群机器人的webhook地址。详情请参见自定义机器人。

配置修改完成后，加载新配置文件并重启Nginx。

/usr/local/webserver/nginx/sbin/nginx -s reload            # 重新载入配置文件
/usr/local/webserver/nginx/sbin/nginx -s reopen            # 重启Nginx

设置报警。

登录阿里云ES实例的Kibana控制台，单击左侧菜单栏的Dev Tools，在Console中使用API创建一个报警文档。

下文以创建log_error_watch为例，每隔10s查询logs索引中是否出现error日志，如果出现0次以上则触发报警。

PUT _xpack/watcher/watch/log_error_watch
{
  "trigger": {
    "schedule": {
      "interval": "10s"
    }
  },
  "input": {
    "search": {
      "request": {
        "indices": ["logs"],
        "body": {
          "query": {
            "match": {
              "message": "error"
            }
          }
        }
      }
    }
  },
  "condition": {
    "compare": {
      "ctx.payload.hits.total": {
        "gt": 0
      }
    }
  },
  "actions" : {
  "test_issue" : {
    "webhook" : {
      "method" : "POST",
      "url" : "http://您的ECS内网IP:8080",
      "body" : "{\"msgtype\": \"text\", \"text\": { \"content\": \"error 日志出现了，请尽快处理\"}}"
    }
  }
}
}

说明

上述actions中配置的url必须是您购买的与阿里云Elasticsearch实例相同区域和VPC的阿里云ECS实例的内网IP地址，并且已经按照上述方式进行了安全组配置，否则不能进行通信。

如果您不再需要执行报警任务，可以使用以下命令删除该报警任务。

DELETE _xpack/watcher/watch/log_error_watch

常见问题

Q：在设置报警时出现No handler found for uri [/_xpack/watcher/watch/log_error_watch_2] and method [PUT]异常。

A：设置报警时以上异常，表示您购买的阿里云ES实例未开启Watcher功能，可通过以下方式开启。

登录阿里云Elasticsearch控制台，单击实例ID > ES集群配置。
在ES集群配置页面，单击YML文件配置右侧的修改配置。
在YML参数配置页面，将开启Watcher设置为开启。

注意开启Watcher操作会触发集群重启，为保证您的业务不受影响，请确认后操作。
勾选该操作会重启实例，请确认后操作，然后单击确认。
重启过程中可在任务列表页面查看重启进度。重启完成后，即可完成Watcher的开启。