Documentation
¶
Index ¶
- Constants
- func HTTPMetrics(mc *Collector) func(http.Handler) http.Handler
- type Collector
- func (mc *Collector) Export() string
- func (mc *Collector) Handler() http.HandlerFunc
- func (mc *Collector) IncrementCounter(name string, value float64)
- func (mc *Collector) InitDefaultMetrics()
- func (mc *Collector) ObserveHistogram(name string, value float64)
- func (mc *Collector) RecordContainerEvent()
- func (mc *Collector) RecordContainerMonitorFallback()
- func (mc *Collector) RecordContainerMonitorMethod(usingEvents bool)
- func (mc *Collector) RecordContainerWaitDuration(seconds float64)
- func (mc *Collector) RecordDockerError(operation string)
- func (mc *Collector) RecordDockerOperation(operation string)
- func (mc *Collector) RecordJobComplete(jobName string, durationSeconds float64, panicked bool)
- func (mc *Collector) RecordJobRetry(jobName string, attempt int, success bool)
- func (mc *Collector) RecordJobScheduled(jobName string)
- func (mc *Collector) RecordJobStart(jobName string)
- func (mc *Collector) RecordWorkflowComplete(rootJobName, status string)
- func (mc *Collector) RecordWorkflowJobResult(jobName, result string)
- func (mc *Collector) RegisterCounter(name, help string)
- func (mc *Collector) RegisterGauge(name, help string)
- func (mc *Collector) RegisterHistogram(name, help string, buckets []float64)
- func (mc *Collector) SetGauge(name string, value float64)
- type Histogram
- type JobMetrics
- type Metric
Constants ¶
const (
// Metric type constants
MetricTypeGauge = "gauge"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Collector ¶
type Collector struct {
// contains filtered or unexported fields
}
Collector handles Prometheus-style metrics
func (*Collector) Handler ¶
func (mc *Collector) Handler() http.HandlerFunc
Handler returns an HTTP handler for the metrics endpoint
func (*Collector) IncrementCounter ¶
IncrementCounter increments a counter metric
func (*Collector) InitDefaultMetrics ¶
func (mc *Collector) InitDefaultMetrics()
DefaultMetrics initializes common metrics
func (*Collector) ObserveHistogram ¶
ObserveHistogram records a value in a histogram
func (*Collector) RecordContainerEvent ¶
func (mc *Collector) RecordContainerEvent()
RecordContainerEvent records a container event received
func (*Collector) RecordContainerMonitorFallback ¶
func (mc *Collector) RecordContainerMonitorFallback()
RecordContainerMonitorFallback records a fallback to polling
func (*Collector) RecordContainerMonitorMethod ¶
RecordContainerMonitorMethod records the monitoring method being used
func (*Collector) RecordContainerWaitDuration ¶
RecordContainerWaitDuration records the time spent waiting for a container
func (*Collector) RecordDockerError ¶
RecordDockerError records a Docker API error
func (*Collector) RecordDockerOperation ¶
RecordDockerOperation records a Docker API operation
func (*Collector) RecordJobComplete ¶ added in v0.13.0
RecordJobComplete records a job completing (from go-cron ObservabilityHooks)
func (*Collector) RecordJobRetry ¶
RecordJobRetry records a job retry attempt
func (*Collector) RecordJobScheduled ¶ added in v0.13.0
RecordJobScheduled records when a job's next run is scheduled (from go-cron ObservabilityHooks)
func (*Collector) RecordJobStart ¶ added in v0.13.0
RecordJobStart records a job starting (from go-cron ObservabilityHooks)
func (*Collector) RecordWorkflowComplete ¶ added in v0.21.0
RecordWorkflowComplete records a workflow completion (from go-cron ObservabilityHooks). TODO: add label dimensions (root_job_name, status) once Collector supports labeled metrics.
func (*Collector) RecordWorkflowJobResult ¶ added in v0.21.0
RecordWorkflowJobResult records an individual job result within a workflow (from go-cron ObservabilityHooks). TODO: add label dimensions (job_name, result) once Collector supports labeled metrics.
func (*Collector) RegisterCounter ¶
RegisterCounter registers a new counter metric
func (*Collector) RegisterGauge ¶
RegisterGauge registers a new gauge metric
func (*Collector) RegisterHistogram ¶
RegisterHistogram registers a new histogram metric
type Histogram ¶
type Histogram struct {
Count int64
Sum float64
Bucket map[float64]int64 // bucket threshold -> count
}
Histogram for tracking distributions
type JobMetrics ¶
type JobMetrics struct {
// contains filtered or unexported fields
}
JobMetrics tracks job execution metrics
func NewJobMetrics ¶
func NewJobMetrics(collector *Collector) *JobMetrics
NewJobMetrics creates a job metrics tracker
func (*JobMetrics) JobCompleted ¶
func (jm *JobMetrics) JobCompleted(jobID string, success bool)
JobCompleted records job completion
func (*JobMetrics) JobStarted ¶
func (jm *JobMetrics) JobStarted(jobID string)
JobStarted records job start