common

README

PagerDuty Agent: Common Package

Common utilities used across agent packages.

Documentation

Index

• Variables
• func GenerateKey() string
• func GetPid(pidfile string) (int, error)
• func InitPidfile(pidfile string) error
• func IsProduction() bool
• func IsRunning(pidfile string) (bool, error)
• func IsSuccessResponse(resp *http.Response, err error) bool
• func PdApiUrl() string
• func PdEventsUrl() string
• func RemovePidfile(pidfile string) error
• func TerminateProcess(pidfile string) error
• func UserAgent() string
• type Clock
  • func NewClock() Clock
• type RetryTransport
  • func NewRetryTransport() RetryTransport
  • func (r RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var BaseLogger *zap.Logger

var Commit = "unavailable"

Normally set at build time.

var Date = time.Now().Format(time.RFC3339)

var ErrPidfileDoesntExist = errors.New("pidfile doesn't exist")

var ErrPidfileExists = errors.New("pidfile already exists")

var Logger *zap.SugaredLogger

var Version = "unavailable"

Functions

func GenerateKey

func GenerateKey() string

GenerateKey generates a random lowercase alphanumeric key.

These keys approximate the Events API's routing keys for use in testing, but may be useful more generally.

func GetPid

func GetPid(pidfile string) (int, error)

func InitPidfile

func InitPidfile(pidfile string) error

func IsProduction

func IsProduction() bool

func IsRunning

func IsRunning(pidfile string) (bool, error)

func IsSuccessResponse

func IsSuccessResponse(resp *http.Response, err error) bool

IsSuccessResponse returns true if the corresponding request was successful.

Per documentation this is when the server responds with a 202, but we treat any 2XX as a success.

func PdApiUrl

func PdApiUrl() string

func PdEventsUrl

func PdEventsUrl() string

func RemovePidfile

func RemovePidfile(pidfile string) error

func TerminateProcess

func TerminateProcess(pidfile string) error

func UserAgent

func UserAgent() string

Types

type Clock

type Clock interface {
	Now() time.Time
}

func NewClock

func NewClock() Clock

type RetryTransport

type RetryTransport struct {
	MaxRetries  int
	MaxInterval time.Duration
	Transport   http.RoundTripper
	Backoff     func(int, time.Duration) time.Duration
	IsRetryable func(*http.Response, error) bool
	IsSuccess   func(*http.Response, error) bool
	// contains filtered or unexported fields
}

RetryTransport provides automatic retry support as an `http.RoundTripper`.

Default cases are when a 429 or 500-series error is encountered, with an exponential backoff determined by `Backoff` and a maximum retry count of `MaxRetries`.

Example basic usage:

    client :=  &http.Client{
		   Transport: NewRetryTransport(),
	   }

    client.Get("https://www.pagerduty.com")

func NewRetryTransport

func NewRetryTransport() RetryTransport

func (RetryTransport) RoundTrip

func (r RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

Implementing the `http.RoundTripper` interface.