jsonapi

Documentation

Overview

Package jsonapi implements the json api related metrics documented here: https://lab.jamit.de/pace/web/meta/wikis/concept/metrics#m2-microservice-any-pace-microservice

Index

• Constants
• func AddPaceAPIHTTPRequestDurationSeconds(duration float64, method, path, service string)
• func AddPaceAPIHTTPSizeBytes(size float64, method, path, service, requestOrResponse string)
• func IncPaceAPIHTTPRequestTotal(code, method, path, service, clientID string)
• type Metric
  • func NewMetric(serviceName, path string, w http.ResponseWriter, r *http.Request) *Metric
  • func (m *Metric) Write(p []byte) (int, error)
  • func (m *Metric) WriteHeader(statusCode int)

Constants

const (
	TypeRequest  = "req"
	TypeResponse = "resp"
)

Functions

func AddPaceAPIHTTPRequestDurationSeconds

func AddPaceAPIHTTPRequestDurationSeconds(duration float64, method, path, service string)

AddPaceAPIHTTPRequestDurationSeconds adds an observed value for the pace_api_http_request_duration_seconds histogram metric

func AddPaceAPIHTTPSizeBytes

func AddPaceAPIHTTPSizeBytes(size float64, method, path, service, requestOrResponse string)

AddPaceAPIHTTPSizeBytes adds an observed value for the pace_api_http_size_bytes histogram metric.

func IncPaceAPIHTTPRequestTotal

func IncPaceAPIHTTPRequestTotal(code, method, path, service, clientID string)

IncPaceAPIHTTPRequestTotal increments the pace_api_http_request_total counter metric

Types

type Metric

type Metric struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

Metric is an http.ResponseWriter implementing metrics collector because the metrics depend on the http StatusCode.

func NewMetric

func NewMetric(serviceName, path string, w http.ResponseWriter, r *http.Request) *Metric

NewMetric creates a new metric collector (per request) with given service and path (pattern! not the request path) and collects the pace_api_http_size_bytes histogram metric.

func (*Metric) Write

func (m *Metric) Write(p []byte) (int, error)

Write captures the length of the response body.

func (*Metric) WriteHeader

func (m *Metric) WriteHeader(statusCode int)

WriteHeader captures the status code for metric submission and collects the pace_api_http_request_total counter and pace_api_http_request_duration_seconds histogram metric