report

README

自定义上报命令使用说明

实现发送自定义事件/自定义时序等自定义数据

支持通过gse agent和bkmonitorporxy(http接口)两种方式实现自定义上报, 上报之前会在本地进行jsonschema校验

如果通过bkmonitorproxy上报，具体bkmonitorproxy地址可以在监控插件页面右侧看到各个云区域bkmonitorproxy服务地址。

使用方法

# 输出帮助信息(实际输出更多，发送自定义数据相关参数带有report关键字)
:!./bkmonitorbeat -h
Usage of ./bkmonitorbeat:
  -report
    	Report event to time series to bkmonitorproxy
  -report.agent.address string
    	agent ipc address, default /var/run/ipc.state.report (default "/var/run/ipc.state.report")
  -report.bk_data_id int
    	bk_data_id, required
  -report.event.content string
    	event content
  -report.event.name string
    	event name
  -report.event.target string
    	event target
  -report.event.timestamp int
    	event timestamp
  -report.http.server string
    	http server address, required if report type is http
  -report.http.token string
    	token, , required if report type is http
  -report.message.body string
    	message content that will be send, json format
  -report.message.kind string
    	message kind, event or timeseries
  -report.type http
    	report type http or `agent`

基本使用

基本使用部分提供通用的使用方法，适用于自定义事件和自定义时序数据上报，由于事件内容涉及到较多特殊字符处理，后面单独介绍针对自定义事件的上报方法。 如下代码演示用于发送自定义事件的数据（其中json内容来自监控插件配置右侧的帮助信息）。

# 通过gse agent发送自定义事件, 无返回
./bkmonitorbeat -report -report.bk_data_id 1500512 \
-report.type agent \
-report.message.kind event \
-report.message.body '{
    "data_id":1500512,
    "access_token":"991146b7e97b409f8952d59355b5f5c7",
    "data":[{
        "event_name":"input_your_event_name",
        "target":"127.0.0.1",
        "event":{
            "content":"user xxx login failed"
        },
        "dimension":{
            "amodule":"db",
            "aset":"guangdong"
        },
        "metrics":{
            "field1":1.1
        },
        "timestamp":1591067660370
        }
    ]}'

# 通过http方式发送自定义事件，成功返回code200，result true
./bkmonitorbeat -report -report.bk_data_id 1500512 -report.type http -report.http.server 127.0.0.1:10205 -report.message.kind event -report.message.body '{
    "data_id":1500512,
    "access_token":"991146b7e97b409f8952d59355b5f5c7",
    "data":[{
        "event_name":"input_your_event_name",
        "target":"127.0.0.1",
        "event":{
            "content":"user xxx login failed"
        },
        "dimension":{
            "amodule":"db",
            "aset":"guangdong"
        },
        "metrics":{
            "field1":1.1
        },
        "timestamp":1591067660370
        }
    ]}'
{"code":"200","message":"success","request_id":"4a6b1b1e-0af0-4834-87c5-6443662df7d3","result":"true"}

通过gse agent上报自定义事件数据

本示例采用单独指定各个上报字段的方式, 用于解决拼装json麻烦的问题

# 通过指定各个字段的方式发送自定义事件数据，采用默认时间
./bkmonitorbeat -report \
-report.type agent \
-report.message.kind event \
-report.bk_data_id 1500512 \
-report.event.target 127.0.0.1 \
-report.event.name xxxxxxxxx \
-report.event.target yyyyyyyyy \
-report.event.content zzzzzz

# 通过指定各个字段的方式发送自定义事件数据，指定上报时间
./bkmonitorbeat -report \
-report.type agent \
-report.message.kind event \
-report.bk_data_id 1500512 \
-report.event.target 127.0.0.1 \
-report.event.name xxxxxxxxx \
-report.event.target yyyyyyyyy \
-report.event.content zzzzzz \
-report.event.timestamp 1595944620000

通过bkmonitorproxy上报自定义事件数据

./bkmonitorbeat -report \
-report.type http \
-report.http.server 127.0.0.1:10205 \
-report.http.token 991146b7e97b409f8952d59355b5f5c7 \
-report.message.kind event \
-report.bk_data_id 1500512 \
-report.event.target 127.0.0.1 \
-report.event.name xxxxxxxxx \
-report.event.target yyyyyyyyy \
-report.event.content zzzzzz

Documentation

Index

• Variables
• func CompareAndPrepareArgs() error
• func DoReport() error
• func RegisterSender(name string, sender NewSender)
• type NewSender
• type ReportConfig
• type Sender
• type SenderFactory
  • func NewSenderFactory() *SenderFactory
  • func (sf *SenderFactory) NewSender(name string, config ReportConfig) (Sender, error)

Variables

var (
	ReportTargetTypeKey     = "report.type"
	ReportHTTPServerKey     = "report.http.server"
	ReportHTTPTokenKey      = "report.http.token"
	ReportAgentAddressKey   = "report.agent.address"
	ReportDataIDKey         = "report.bk_data_id"
	ReportMessageKindKey    = "report.message.kind"
	ReportMessageBodyKey    = "report.message.body"
	ReportEventNameKey      = "report.event.name"
	ReportEventContentKey   = "report.event.content"
	ReportEventTargetKey    = "report.event.target"
	ReportEventTimestampKey = "report.event.timestamp"
)

Functions

func CompareAndPrepareArgs

func CompareAndPrepareArgs() error

func DoReport

func DoReport() error

DoReport is enter of report package

func RegisterSender

func RegisterSender(name string, sender NewSender)

Types

type NewSender

type NewSender func(config ReportConfig) (Sender, error)

type ReportConfig

type ReportConfig struct {
	ReportType      string
	HTTPServer      string
	HTTPToken       string
	AgentIPCAddress string
	DataID          int64
	MessageKind     string
	MessageContent  string
	EventName       string
	EventContent    string
	EventTarget     string
	EventTimestamp  int64
}

type Sender

type Sender interface {
	Send(bkDataID int64, m *message.Message) error
	SendSync(bkDataID int64, m *message.Message) error
}

Sender is a interface of message sender

type SenderFactory

type SenderFactory struct{}

func NewSenderFactory

func NewSenderFactory() *SenderFactory

func (*SenderFactory) NewSender

func (sf *SenderFactory) NewSender(name string, config ReportConfig) (Sender, error)