# alarm-dog-golang-sdk

**Repository Path**: ta-tech-team/alarm-dog-golang-sdk

## Basic Information

- **Project Name**: alarm-dog-golang-sdk
- **Description**: 哮天犬告警平台Golang SDK
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 3
- **Created**: 2020-11-04
- **Last Updated**: 2025-07-02

## Categories & Tags

**Categories**: system-monitor

**Tags**: None

## README

# xiaotianquan-alarm-go

哮天犬监控告警平台`SDK`

## 如何安装此SDK

```bash
go get github.com/tal-tech/alarm-dog-golang-sdk
```

如果显示要输入密码，并且一直输入都没有效，可以尝试先`clone`一下，然后再次执行`go get`命令。如下：

```bash
git clone https://github.com/tal-tech/alarm-dog-golang-sdk.git

go get github.com/tal-tech/alarm-dog-golang-sdk
```

如果拉取失败，请尝试加上`-u`参数，命令如下：

```bash
go get -u github.com/tal-tech/alarm-dog-golang-sdk
```

## 使用例子

### 基本例子

```go
package main

import "github.com/tal-tech/alarm-dog-golang-sdk/alarm"

func main() {
    a := alarm.New()
    a.SetTaskID(637).SetToken("349f44f37cdde77b2c393c7761e667f382387b0d")

    var content = make(map[string]string)
    content["errno"] = "10086"
    content["error"] = "您的余额已不足"

    reportBody := alarm.ReportBody{
        Ctn: content,
    }

    response := a.Report(reportBody)
    println(response)
}
```

## 开发指南

想要高效的进行`Channel`添加和修改，我们可以使用`receiver/channel`目录下的`channel.template`模板来生成代码。使用例子：

### 安装工具

```bash
go get -u github.com/cheekybits/genny
```

### 代码生成

```bash
genny -in=channel.template -out=qq.go gen "ChannelType=QQ"
```

此时，会生成一个名字叫做`QQ`的`Channel`。

同时，我们可以生成对应的测试文件：

```bash
genny -in=channel_test.template -out=qq_test.go gen "ChannelType=QQ"
```

### 执行测试

```bash
go test -timeout 30s ./... -count=1
```

#### 手机告警测试

请确保在哮天犬后台配置了手机号。[详情参考](https://tal-tech.github.io/alarm-dog-docs/faq/cannot-receiver-sms-phone.html)