Function TestProvisionerJobQueueWaitMetric

coderd/workspaces_test.go:6413–6462

(t *testing.T)

}

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

	logger := testutil.Logger(t)
	reg := prometheus.NewRegistry()
	metrics := provisionerdserver.NewMetrics(logger)
	err := metrics.Register(reg)
	require.NoError(t, err)

	client := coderdtest.New(t, &coderdtest.Options{
		IncludeProvisionerDaemon:  true,
		ProvisionerdServerMetrics: metrics,
	})
	user := coderdtest.CreateFirstUser(t, client)

	// Create a template version - this triggers a template_version_import job.
	version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
	coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)

	// Check that the queue wait metric was recorded for the template_version_import job.
	importMetric := promhelp.MetricValue(t, reg, "coderd_provisioner_job_queue_wait_seconds", prometheus.Labels{
		"provisioner_type": string(database.ProvisionerTypeEcho),
		"job_type":         string(database.ProvisionerJobTypeTemplateVersionImport),
		"transition":       "",
		"build_reason":     "",
	})
	require.NotNil(t, importMetric, "import job metric should be recorded")
	importHistogram := importMetric.GetHistogram()
	require.NotNil(t, importHistogram)
	require.Equal(t, uint64(1), importHistogram.GetSampleCount(), "import job should have 1 sample")
	require.Greater(t, importHistogram.GetSampleSum(), 0.0, "import job queue wait should be non-zero")

	// Create a template and workspace - this triggers a workspace_build job.
	template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
	workspace := coderdtest.CreateWorkspace(t, client, template.ID)
	coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)

	// Check that the queue wait metric was recorded for the workspace_build job.
	buildMetric := promhelp.MetricValue(t, reg, "coderd_provisioner_job_queue_wait_seconds", prometheus.Labels{
		"provisioner_type": string(database.ProvisionerTypeEcho),
		"job_type":         string(database.ProvisionerJobTypeWorkspaceBuild),
		"transition":       string(database.WorkspaceTransitionStart),
		"build_reason":     string(database.BuildReasonInitiator),
	})
	require.NotNil(t, buildMetric, "workspace build job metric should be recorded")
	buildHistogram := buildMetric.GetHistogram()
	require.NotNil(t, buildHistogram)
	require.Equal(t, uint64(1), buildHistogram.GetSampleCount(), "workspace build job should have 1 sample")
	require.Greater(t, buildHistogram.GetSampleSum(), 0.0, "workspace build job queue wait should be non-zero")
}

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