client

README

dp-nomad

Getting started

Dependencies

Configuration

Contributing

See CONTRIBUTING for details.

License

Copyright © 2020, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(nomadEndpoint, nomadCACert string, nomadTLSSkipVerify bool) (*Client, error)
  • func (c *Client) Checker(ctx context.Context, state *health.CheckState) error
  • func (c *Client) Get(ctx context.Context, path string) (int, error)
• type ErrInvalidAppResponse
  • func (e ErrInvalidAppResponse) Error() string

Constants

const ServiceName = "Nomad"

ServiceName

Variables

var (
	// StatusMessage contains a map of messages to service response statuses
	StatusMessage = map[string]string{
		health.StatusOK:       " is ok",
		health.StatusWarning:  " is degraded, but at least partially functioning",
		health.StatusCritical: " functionality is unavailable or non-functioning",
	}
)

Types

type Client

type Client struct {
	Client dphttp.Clienter
	URL    string
}

Nomad represents the nomad client

func NewClient

func NewClient(nomadEndpoint, nomadCACert string, nomadTLSSkipVerify bool) (*Client, error)

NewClient returns a Nomad HTTP client for this endpoint with optional TLS config

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, state *health.CheckState) error

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string) (int, error)

type ErrInvalidAppResponse

type ErrInvalidAppResponse struct {
	ExpectedCode int
	ActualCode   int
	URI          string
}

ErrInvalidAppResponse is returned when an app does not respond with a valid status

func (ErrInvalidAppResponse) Error

func (e ErrInvalidAppResponse) Error() string

Error should be called by the user to print out the stringified version of the error