Documentation
¶
Overview ¶
Package metrics defines the server's Prometheus metrics. Labels stay bounded: route patterns, methods, status codes, job and source IDs, never URLs with IDs, titles, user names or credentials.
Index ¶
- type Metrics
- func (m *Metrics) HTTP(route, method string, code int, d time.Duration)
- func (m *Metrics) Handler() http.Handler
- func (m *Metrics) ImageRetry(outcome string)
- func (m *Metrics) JobFinished(job, status, trigger string, d time.Duration)
- func (m *Metrics) JobStarted(job string)
- func (m *Metrics) TaskEnded(kind, outcome string, d time.Duration)
- func (m *Metrics) TaskStarted(kind string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Metrics ¶
type Metrics struct {
Registry *prometheus.Registry
HTTPRequests *prometheus.CounterVec
HTTPDuration *prometheus.HistogramVec
JobRuns *prometheus.CounterVec
JobDuration *prometheus.HistogramVec
JobRunning *prometheus.GaugeVec
TasksFinished *prometheus.CounterVec
TaskDuration *prometheus.HistogramVec
TasksRunning *prometheus.GaugeVec
ImageRetries *prometheus.CounterVec
}
Metrics holds every collector the server updates. A nil *Metrics is valid and records nothing, so code doesn't have to check whether metrics are on.
func New ¶
func New() *Metrics
New registers the server's metrics, plus the Go runtime and process ones, on a fresh registry.
func (*Metrics) HTTP ¶
HTTP records one request. route is the matched pattern (e.g. "/api/v1/works/{id}"), or "unmatched".
func (*Metrics) ImageRetry ¶
ImageRetry records how a failed page image ended.
func (*Metrics) JobFinished ¶
JobFinished records a finished (or skipped) run.
func (*Metrics) JobStarted ¶
JobStarted marks a job as running. Safe on a nil *Metrics.
func (*Metrics) TaskStarted ¶
TaskStarted counts a running task.