webhooks

README

Webhooks Input Plugin

This is a service plugin that start an http server and register multiple webhook listeners.

circonus-unified-agent config -input-filter webhooks -output-filter circonus > config.conf.new

Change the config file to point to add Circonus API token key you are using and adjust the settings to match your environment. Once that is complete:

cp config.conf.new /etc/circonus-unified-agent/circonus-unified-agent.conf
sudo service circonus-unified-agent start

Configuration

[[inputs.webhooks]]
  instance_id = "" # unique instance identifier (REQUIRED)

  ## Address and port to host Webhook listener on
  service_address = ":1619"

  [inputs.webhooks.filestack]
    path = "/filestack"

  [inputs.webhooks.github]
    path = "/github"
    # secret = ""

  [inputs.webhooks.mandrill]
    path = "/mandrill"

  [inputs.webhooks.rollbar]
    path = "/rollbar"

  [inputs.webhooks.papertrail]
    path = "/papertrail"

  [inputs.webhooks.particle]
    path = "/particle"

Available webhooks

• Filestack
• Github
• Mandrill
• Rollbar
• Papertrail
• Particle

Adding new webhooks plugin

1. Add your webhook plugin inside the webhooks folder
2. Your plugin must implement the Webhook interface
3. Import your plugin in the webhooks.go file and add it to the Webhooks struct

Both Github and Rollbar are good example to follow.

Documentation

Index

• type Webhook
• type Webhooks
  • func NewWebhooks() *Webhooks
  • func (wh *Webhooks) AvailableWebhooks() []Webhook
  • func (*Webhooks) Description() string
  • func (*Webhooks) Gather(_ context.Context, _ cua.Accumulator) error
  • func (*Webhooks) SampleConfig() string
  • func (wh *Webhooks) Start(ctx context.Context, acc cua.Accumulator) error
  • func (wh *Webhooks) Stop()

Types

type Webhook

type Webhook interface {
	Register(router *mux.Router, acc cua.Accumulator)
}

type Webhooks

type Webhooks struct {
	Github     *github.Webhook
	Filestack  *filestack.Webhook
	Mandrill   *mandrill.Webhook
	Rollbar    *rollbar.Webhook
	Papertrail *papertrail.Webhook
	Particle   *particle.Webhook

	ServiceAddress string
	// contains filtered or unexported fields
}

func NewWebhooks

func NewWebhooks() *Webhooks

func (*Webhooks) AvailableWebhooks

func (wh *Webhooks) AvailableWebhooks() []Webhook

Looks for fields which implement Webhook interface

func (*Webhooks) Description

func (*Webhooks) Description() string

func (*Webhooks) Gather

func (*Webhooks) Gather(_ context.Context, _ cua.Accumulator) error

func (*Webhooks) SampleConfig

func (*Webhooks) SampleConfig() string

func (*Webhooks) Start

func (wh *Webhooks) Start(ctx context.Context, acc cua.Accumulator) error

func (*Webhooks) Stop

func (wh *Webhooks) Stop()