httpoutprom

README

HTTP outgoing request Prometheus metrics

Provides simple wrappers around http.Client or http.RoundTripper for monitoring with Prometheus outgoing http requests.

Metrics

Metrics:

metric	description
http_outgoing_request_total	A counter for outgoing http requests.
http_outgoing_request_duration_seconds	A histogram of outgoing http request latencies.

Default labels:

label	description
scheme	Request scheme, such as: http, https.
host	Request host name.
method	Request method, such as: GET, POST, and so on.
code	Response status code.

Examples

See example folder.

Licensing

This project is licensed under the MIT License.

Documentation

Index

• type Client
  • func NewClient(recorder *Recorder, client HTTPClient) *Client
  • func (c *Client) Do(request *http.Request) (*http.Response, error)
• type Config
• type HTTPClient
• type Recorder
  • func NewRecorder(cfg Config) *Recorder
  • func (r *Recorder) Collect(in chan<- prometheus.Metric)
  • func (r *Recorder) Describe(in chan<- *prometheus.Desc)
  • func (r *Recorder) IncRequest(host, scheme, method, statusCode string)
  • func (r *Recorder) ObserveDurationRequest(duration time.Duration, host, scheme, method, statusCode string)
• type Transport
  • func NewTransport(recorder *Recorder, transport http.RoundTripper) *Transport
  • func (t Transport) RoundTrip(request *http.Request) (*http.Response, error)

Types

type Client

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

func NewClient

func NewClient(recorder *Recorder, client HTTPClient) *Client

func (*Client) Do

func (c *Client) Do(request *http.Request) (*http.Response, error)

type Config

type Config struct {
	DurationBuckets []float64
	Registry        prometheus.Registerer
	Service         string
	ServiceLabel    string
	HostLabel       string
	SchemeLabel     string
	MethodLabel     string
	StatusCodeLabel string
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type Recorder

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

func NewRecorder

func NewRecorder(cfg Config) *Recorder

func (*Recorder) Collect

func (r *Recorder) Collect(in chan<- prometheus.Metric)

func (*Recorder) Describe

func (r *Recorder) Describe(in chan<- *prometheus.Desc)

func (*Recorder) IncRequest

func (r *Recorder) IncRequest(host, scheme, method, statusCode string)

func (*Recorder) ObserveDurationRequest

func (r *Recorder) ObserveDurationRequest(duration time.Duration, host, scheme, method, statusCode string)

type Transport

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

func NewTransport

func NewTransport(recorder *Recorder, transport http.RoundTripper) *Transport

func (Transport) RoundTrip

func (t Transport) RoundTrip(request *http.Request) (*http.Response, error)