bernhard

package module

v3.0.1+incompatible Latest Latest Go to latest Published: Jun 24, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/essentialkaos/bernhard

Links

Open Source Insights

README ¶

Installation • Build Status • License

bernhard is Go package for sending alerts to Bernhard service.

Installation

Make sure you have a working Go 1.15+ workspace (instructions), then:

go get pkg.re/essentialkaos/go-bernhard.v3

For update to the latest stable release, do:

go get -u pkg.re/essentialkaos/go-bernhard.v3

Build Status

Branch	Status
`master`
`develop`

License

Apache License, Version 2.0

Documentation ¶

Index ¶

Constants
Variables
type Alert
type Client
- func NewClient(bernhardURL string) (*Client, error)
- func (c *Client) Add(a Alert) error
- func (c *Client) Send() error

Constants ¶

View Source

const (
	STATE_OK       = "ok"
	STATE_WARN     = "warn"
	STATE_PROBLEM  = "problem"
	STATE_CRITICAL = "critical"
)

Variables ¶

View Source

var ErrBadServiceName = errors.New("Service name contains disallowed symbols")

View Source

var ErrHostNotSet = errors.New("Host field is mandatory and must be set")

View Source

var ErrServiceNotSet = errors.New("Service field is mandatory and must be set")

View Source

var ErrStateNotSet = errors.New("State field is mandatory and must be set")

Functions ¶

This section is empty.

Types ¶

type Alert ¶

type Alert struct {
	Service string `json:"service"`
	Host    string `json:"host"`
	TTL     int    `json:"ttl"`
	State   string `json:"state"`
	Desc    string `json:"description"`
}

Alert contains alert data

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client basic Bernhard client

func NewClient ¶

func NewClient(bernhardURL string) (*Client, error)

NewClient creates new client instance

func (*Client) Add ¶

func (c *Client) Add(a Alert) error

Add adds new alert to stack

func (*Client) Send ¶

func (c *Client) Send() error

Send sends alerts data to Bernhard service

Source Files ¶

View all Source files

bernhard.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL