Golang网站和REST API监控告警插件StatusOK的使用

StatusOK简介

StatusOK是一个用于监控网站和API的工具，当你的服务器宕机或响应时间超过预期时，它会通过Slack或电子邮件通知你。

简单版本使用

步骤1：编写config.json配置文件

{
    "notifications":{
        "mail":{
            "smtpHost":"smtp.gmail.com",
            "port":587,
            "username":"yourmailid@gmail.com",
            "password":"your gmail password",
            "from":"yourmailid@gmail.com",
            "to":"destemailid@gmail.com"
        }
    },
    "requests":[
        {
            "url":"http://mywebsite.com",
            "requestType":"GET",
            "checkEvery":30,    
            "responseTime":800
        }
    ]
}

确保开启Gmail的"允许不够安全的应用"选项。

步骤2：下载并运行StatusOK

下载二进制文件后，在终端运行以下命令：

$ ./statusok --config config.json

要在后台运行，添加&：

$ ./statusok --config config.json &

停止进程：

$ jobs
$ kill %jobnumber

完整版本使用InfluxDB

你可以将数据保存到InfluxDB，并使用Grafana查看响应时间随时间的变化。

以下是一个监控REST API的配置示例：

{
    "url":"http://mywebsite.com/v1/data",
    "requestType":"POST",
    "headers":{
        "Authorization":"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f",
        "Content-Type":"application/json"
    },
    "formParams":{
        "description":"sanath test",
        "url":"http://google.com"
    },
    "checkEvery":30,
    "responseCode":200,        
    "responseTime":800
},

{
    "url":"http://mywebsite.com/v1/data",
    "requestType":"GET",
    "headers":{
        "Authorization":"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f",        
    },
    "urlParams":{
        "name":"statusok"
    },
    "checkEvery":300,
    "responseCode":200,        
    "responseTime":800
},

{
    "url":"http://something.com/v1/data",
    "requestType":"DELETE",
    "formParams":{
        "name":"statusok"
    },
    "checkEvery":300,
    "responseCode":200,        
    "responseTime":800
}

数据库支持

目前仅支持InfluxDB 0.9.3+，你也可以添加数据到你自己的数据库。

通知方式

支持以下通知方式：

1. Slack
2. SMTP电子邮件
3. Mailgun
4. HTTP端点
5. Dingding

Docker运行方式

普通Docker运行

docker run -d -v /path/to/config/folder:/config sanathp/statusok

注意：配置文件夹必须包含名为config.json的配置文件。

Docker Compose运行

准备docker-compose.yml文件：

version: '2'
services:
  statusok:
    build: sanathp/statusok
    volumes:
      - /path/to/config/folder:/config
    depends_on:
      - influxdb
  influxdb:
    image: tutum/influxdb:0.9
    environment:
      - PRE_CREATE_DB="statusok" 
    ports:
      - 8083:8083 
      - 8086:8086
  grafana:
    image: grafana/grafana
    ports:
      - 3000:3000

然后运行：

docker-compose up

贡献

欢迎贡献代码。如果发现bug请创建issue，如果有新功能或修复请发送pull request。请确保编写测试用例。

许可证

Copyright 2015 Sanath Kumar Pasumarthy

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License