metrics

Documentation

Index

• Constants
• Variables

Constants

const (
	// IndexerNameLabel values contain the name of the relevant indexer.
	IndexerNameLabel = "indexerID"

	// IndexerVersionLabel values contain the version of the relevant indexer.
	// Values should derive from indexer.Version.
	IndexerVersionLabel = "indexerVersion"

	// SourceLabel values indicates whether the metric was produced during
	// indexing or reindexing operations.
	// Values should derive from MetricSource.
	SourceLabel = "metricSource"
	// SourceValueIndex indicates the metric originated during normal indexing operations.
	SourceValueIndex = "index"
	// SourceValueReindex indicates the metric originated during a reindex job.
	SourceValueReindex = "reindex"

	// ReindexStatusSuccess indicates the reported job as a whole has completed successfully.
	ReindexStatusSuccess = 1
	// ReindexStatusInProcess indicates the reported job as a whole is currently active.
	ReindexStatusInProcess = 0
	// ReindexStatusIncomplete indicates the reported job as a whole is incomplete.
	// This is the default status.
	ReindexStatusIncomplete = -1
)

Variables

var (
	IndexErrors = promauto.NewCounterVec(
		prometheus.CounterOpts{
			Name: "stateindexer_indexerrors_count",
			Help: "Number of per-state errors reported by indexers",
		},
		[]string{IndexerNameLabel, IndexerVersionLabel, SourceLabel},
	)
	IndexerVersion = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "stateindexer_indexerversion",
			Help: "Indexer's actual version (may be stale)",
		},
		[]string{IndexerNameLabel},
	)
	ReindexStatus = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "stateindexer_reindexjob_status",
			Help: "Status of indexer's most-recent reindex job: 1 succeeded, 0 in-progress, -1 considered failed",
		},
		[]string{IndexerNameLabel},
	)
	ReindexAttempts = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "stateindexer_reindexjob_attempts",
			Help: "Number of times indexer's most-recent reindex job has been attempted",
		},
		[]string{IndexerNameLabel},
	)
	ReindexDuration = promauto.NewGaugeVec(
		prometheus.GaugeOpts{
			Name: "stateindexer_reindexjob_seconds",
			Help: "Duration of indexer's most-recent reindex job attempt",
		},
		[]string{IndexerNameLabel},
	)
)