metrics

Documentation

Overview

Package metrics provides Prometheus metrics for monitoring gitlab-shell components.

Index

• Variables
• func NewRoundTripper(next http.RoundTripper) promhttp.RoundTripperFunc

Variables

var (
	// SshdSessionDuration is a histogram of latencies for connections to gitlab-shell sshd.
	SshdSessionDuration = promauto.NewHistogram(
		prometheus.HistogramOpts{
			Namespace: namespace,
			Subsystem: sshdSubsystem,
			Name:      sshdSessionDurationSecondsName,
			Help:      "A histogram of latencies for connections to gitlab-shell sshd.",
			Buckets: []float64{
				5.0,
				30.0,
				60.0,
			},
		},
	)

	// SshdSessionEstablishedDuration is a histogram of latencies until session established to gitlab-shell sshd.
	SshdSessionEstablishedDuration = promauto.NewHistogram(
		prometheus.HistogramOpts{
			Namespace: namespace,
			Subsystem: sshdSubsystem,
			Name:      sshdSessionEstablishedDurationSecondsName,
			Help:      "A histogram of latencies until session established to gitlab-shell sshd.",
			Buckets: []float64{
				0.5,
				1.0,
				5.0,
			},
		},
	)

	// SshdConnectionsInFlight is a gauge of connections currently being served by gitlab-shell sshd.
	SshdConnectionsInFlight = promauto.NewGauge(
		prometheus.GaugeOpts{
			Namespace: namespace,
			Subsystem: sshdSubsystem,
			Name:      sshdConnectionsInFlightName,
			Help:      "A gauge of connections currently being served by gitlab-shell sshd.",
		},
	)

	// SshdHitMaxSessions is the number of times the concurrent sessions limit was hit in gitlab-shell sshd.
	SshdHitMaxSessions = promauto.NewCounter(
		prometheus.CounterOpts{
			Namespace: namespace,
			Subsystem: sshdSubsystem,
			Name:      sshdHitMaxSessionsName,
			Help:      "The number of times the concurrent sessions limit was hit in gitlab-shell sshd.",
		},
	)

	// SliSshdSessionsTotal is the number of SSH sessions that have been established.
	SliSshdSessionsTotal = promauto.NewCounter(
		prometheus.CounterOpts{
			Name: sliSshdSessionsTotalName,
			Help: "Number of SSH sessions that have been established",
		},
	)

	// SliSshdSessionsErrorsTotal is the number of SSH sessions that have failed.
	SliSshdSessionsErrorsTotal = promauto.NewCounter(
		prometheus.CounterOpts{
			Name: sliSshdSessionsErrorsTotalName,
			Help: "Number of SSH sessions that have failed",
		},
	)

	// GitalyConnectionsTotal is a counter for the number of Gitaly connections that have been established,
	GitalyConnectionsTotal = promauto.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: namespace,
			Subsystem: gitalySubsystem,
			Name:      gitalyConnectionsTotalName,
			Help:      "Number of Gitaly connections that have been established",
		},
		[]string{"status"},
	)

	// LfsHTTPConnectionsTotal is the number of LFS over HTTP connections that have been established.
	LfsHTTPConnectionsTotal = promauto.NewCounter(
		prometheus.CounterOpts{
			Name: lfsHTTPConnectionsTotalName,
			Help: "Number of LFS over HTTP connections that have been established",
		},
	)

	// LfsSSHConnectionsTotal is the number of LFS over SSH connections that have been established.
	LfsSSHConnectionsTotal = promauto.NewCounter(
		prometheus.CounterOpts{
			Name: lfsSSHConnectionsTotalName,
			Help: "Number of LFS over SSH connections that have been established",
		},
	)
)

Functions

func NewRoundTripper

func NewRoundTripper(next http.RoundTripper) promhttp.RoundTripperFunc

NewRoundTripper wraps an http.RoundTripper to instrument it with Prometheus metrics.