mirror of
https://github.com/coder/coder.git
synced 2026-06-02 20:48:20 +00:00
Spike Curtis
bddb808b25
Fixes all our Go file imports to match the preferred spec that we've _mostly_ been using. For example: ``` import ( "context" "time" "github.com/prometheus/client_golang/prometheus" "golang.org/x/xerrors" "gopkg.in/natefinch/lumberjack.v2" "cdr.dev/slog/v3" "github.com/coder/coder/v2/codersdk/agentsdk" "github.com/coder/serpent" ) ``` 3 groups: standard library, 3rd partly libs, Coder libs. This PR makes the change across the codebase. The PR in the stack above modifies our formatting to maintain this state of affairs, and is a separate PR so it's possible to review that one in detail.
111 lines
3.2 KiB
Go
111 lines
3.2 KiB
Go
package dbmetrics_test
|
|
|
|
import (
|
|
"bytes"
|
|
"testing"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/stretchr/testify/require"
|
|
"golang.org/x/xerrors"
|
|
|
|
"cdr.dev/slog/v3"
|
|
"cdr.dev/slog/v3/sloggers/sloghuman"
|
|
"github.com/coder/coder/v2/coderd/coderdtest/promhelp"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbmetrics"
|
|
"github.com/coder/coder/v2/coderd/database/dbtestutil"
|
|
"github.com/coder/coder/v2/testutil"
|
|
)
|
|
|
|
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"
|
|
|
|
txOpts := database.DefaultTXOptions().WithID(id)
|
|
database.IncrementExecutionCount(txOpts) // 2 executions
|
|
|
|
err := db.InTx(func(s database.Store) error {
|
|
return xerrors.Errorf("some dumb error")
|
|
}, txOpts)
|
|
require.Error(t, err)
|
|
|
|
// Check that the metrics are registered
|
|
inTxHistMetric := promhelp.HistogramValue(t, reg, inTxHistMetricName, prometheus.Labels{
|
|
"success": "false",
|
|
"tx_id": id,
|
|
})
|
|
require.NotNil(t, inTxHistMetric)
|
|
require.Equal(t, uint64(1), inTxHistMetric.GetSampleCount())
|
|
|
|
inTxCountMetric := promhelp.CounterValue(t, reg, inTxCountMetricName, prometheus.Labels{
|
|
"success": "false",
|
|
"retries": "1",
|
|
"tx_id": id,
|
|
})
|
|
require.NotNil(t, inTxCountMetric)
|
|
require.Equal(t, 1, inTxCountMetric)
|
|
|
|
// Also check the logs
|
|
require.Contains(t, output.String(), "some dumb error")
|
|
require.Contains(t, output.String(), "database transaction hit serialization error and had to retry")
|
|
require.Contains(t, output.String(), "success=false")
|
|
require.Contains(t, output.String(), "executions=2")
|
|
require.Contains(t, output.String(), "id="+id)
|
|
})
|
|
}
|