checkers

README

checkers

Description

checkers is utility for writing check plugins.

Synopsis

chr := checkers.Ok("command ok!")
chr.Exit()

CONTRIBUTION

1. Fork (https://github.com/mackerelio/checkers/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

License

Copyright 2015 Hatena Co., Ltd.

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.

Documentation

Overview

Package checkers is utility for checker commands

Index

• func Parse(src string) (map[Status]Status, error)
• func ParseStatusMap(src string) (map[Status]Status, error)
• type Checker
  • func Critical(msg string) *Checker
  • func NewChecker(st Status, msg string) *Checker
  • func Ok(msg string) *Checker
  • func Unknown(msg string) *Checker
  • func Warning(msg string) *Checker
  • func (ckr *Checker) Exit()
  • func (ckr *Checker) ExitStatusAs(maps map[Status]Status)
  • func (ckr *Checker) String() string
• type Status
  • func (st Status) String() string

Functions

func Parse

func Parse(src string) (map[Status]Status, error)

Parse parses a string of the form <status>=<status>. <status> is one of:

• ok
• warning
• critical
• unknown

You can specify multiple key-value pairs separated by commas.

Deprecated: use ParseStatusMap instead.

func ParseStatusMap

func ParseStatusMap(src string) (map[Status]Status, error)

ParseStatusMap parses a string of the form <status>=<status>. <status> is one of:

• ok
• warning
• critical
• unknown

You can specify multiple key-value pairs separated by commas.

Types

type Checker

type Checker struct {
	Name    string
	Status  Status
	Message string
}

Checker is utility struct for check script

func Critical

func Critical(msg string) *Checker

Critical exiting with CRITICAL status

func NewChecker

func NewChecker(st Status, msg string) *Checker

NewChecker returns new Checker

func Ok

func Ok(msg string) *Checker

Ok exiting with OK status

func Unknown

func Unknown(msg string) *Checker

Unknown exiting with UNKNOWN status

func Warning

func Warning(msg string) *Checker

Warning exiting with WARNING status

func (*Checker) Exit

func (ckr *Checker) Exit()

Exit with message

func (*Checker) ExitStatusAs

func (ckr *Checker) ExitStatusAs(maps map[Status]Status)

func (*Checker) String

func (ckr *Checker) String() string

type Status

type Status int

Status declare the result of the checker command

const (
	OK Status = iota
	WARNING
	CRITICAL
	UNKNOWN
)

Statuses

func (Status) String

func (st Status) String() string