Function TestInTxMetrics

coderd/database/dbmetrics/dbmetrics_test.go:20–110

(t *testing.T)

)

func TestInTxMetrics(t *testing.T) {
	t.Parallel()

	successLabels := prometheus.Labels{
		"success": "true",
		"tx_id":   "unlabeled",
	}
	const inTxHistMetricName = "coderd_db_tx_duration_seconds"
	const inTxCountMetricName = "coderd_db_tx_executions_count"
	t.Run("QueryMetrics", func(t *testing.T) {
		t.Parallel()

		db, _ := dbtestutil.NewDB(t)
		reg := prometheus.NewRegistry()
		db = dbmetrics.NewQueryMetrics(db, testutil.Logger(t), reg)

		err := db.InTx(func(s database.Store) error {
			return nil
		}, nil)
		require.NoError(t, err)

		// Check that the metrics are registered
		inTxMetric := promhelp.HistogramValue(t, reg, inTxHistMetricName, successLabels)
		require.NotNil(t, inTxMetric)
		require.Equal(t, uint64(1), inTxMetric.GetSampleCount())
	})

	t.Run("DBMetrics", func(t *testing.T) {
		t.Parallel()

		db, _ := dbtestutil.NewDB(t)
		reg := prometheus.NewRegistry()
		db = dbmetrics.NewDBMetrics(db, testutil.Logger(t), reg)

		err := db.InTx(func(s database.Store) error {
			return nil
		}, nil)
		require.NoError(t, err)

		// Check that the metrics are registered
		inTxMetric := promhelp.HistogramValue(t, reg, inTxHistMetricName, successLabels)
		require.NotNil(t, inTxMetric)
		require.Equal(t, uint64(1), inTxMetric.GetSampleCount())
	})

	// Test log output and metrics on failures
	// Log example:
	//  [erro]  database transaction hit serialization error and had to retry  success=false  executions=2  id=foobar_factory
	t.Run("SerializationError", func(t *testing.T) {
		t.Parallel()

		var output bytes.Buffer
		logger := slog.Make(sloghuman.Sink(&output))

		reg := prometheus.NewRegistry()
		db, _ := dbtestutil.NewDB(t)
		db = dbmetrics.NewDBMetrics(db, logger, reg)
		const id = "foobar_factory"