diff --git a/.changeset/flat-items-perform.md b/.changeset/flat-items-perform.md index 3b3dec9013..949814c064 100644 --- a/.changeset/flat-items-perform.md +++ b/.changeset/flat-items-perform.md @@ -11,35 +11,35 @@ Added a set of default Prometheus metrics around scaffolding. See below for a li - `template`: The entity ref of the scaffolded template - `user`: The entity ref of the user that invoked the template run -- scaffolder_task_error_count: a count that track how many task runs error out +- `scaffolder_task_error_count`: a count that track how many task runs error out Labels: - `template`: The entity ref of the scaffolded template - `user`: The entity ref of the user that invoked the template run -- scaffolder_task_duration: a histogram which tracks the duration of a task run +- `scaffolder_task_duration`: a histogram which tracks the duration of a task run Labels: - `template`: The entity ref of the scaffolded template - `result`: A boolean describing whether the task ran successfully -- scaffolder_step_success_count: a count that tracks each step run +- `scaffolder_step_success_count`: a count that tracks each step run Labels: - `template`: The entity ref of the scaffolded template - `step`: The name of the step that was run -- scaffolder_step_error_count: a count that tracks how many steps error out +- `scaffolder_step_error_count`: a count that tracks how many steps error out Labels: - `template`: The entity ref of the scaffolded template - `step`: The name of the step that was run -- scaffolder_step_duration: a histogram which tracks the duration of each step run +- `scaffolder_step_duration`: a histogram which tracks the duration of each step run Labels: diff --git a/contrib/docs/tutorials/prometheus-metrics.md b/contrib/docs/tutorials/prometheus-metrics.md index 5b7dc61df3..a46a2286cd 100644 --- a/contrib/docs/tutorials/prometheus-metrics.md +++ b/contrib/docs/tutorials/prometheus-metrics.md @@ -106,3 +106,9 @@ There are some custom metrics that have been added to Backstage will be output f - `catalog_processing_duration_seconds`: Time spent executing the full processing flow - `catalog_processors_duration_seconds`: Time spent executing catalog processors - `catalog_processing_queue_delay_seconds`: The amount of delay between being scheduled for processing, and the start of actually being processed +- `scaffolder_task_success_count`: Tracks successful task runs. +- `scaffolder_task_error_count`: a count that track how many task runs error out +- `scaffolder_task_duration`: a histogram which tracks the duration of a task run +- `scaffolder_step_success_count`: a count that tracks each step run +- `scaffolder_step_error_count`: a count that tracks how many steps error out +- `scaffolder_step_duration`: a histogram which tracks the duration of each step run