Improve this page on GitHub

Monitoring Classic Runtime

How to monitor the Codefresh Classic Runtime

`engine` component

Modern versions of the Codefresh Classic Runtime (cf-runtime chart >=8.2.0, engine >=1.179.1) provide the engine component metrics in OpenTelemetry format, with the preferable push model.

You can still use the pull model by switching to the Prometheus Metrics Exporter, which is fully compatible with Prometheus. At the same time, we recommend using the default configuration, as it is better suited for the short-lived nature of Classic Builds and provides more precise and complete metrics.

To switch to the Prometheus Metrics Exporter, use the following values in the chart:

runtime:
  engine:
    env:
      OTEL_METRICS_EXPORTER: 'prometheus'
      METRICS_SCRAPE_TIMEOUT_MS: '<4×scrape_interval>' # On exit, wait <timeout>ms for the scrape before exiting
podMonitor:
  main:
    enabled: true # Enable PodMonitor for engine pods

Please refer to the cf-runtime Chart default values on Artifact Hub for more configuration options.

Resource attributes

By default, the engine resource has the following attributes:

Attribute	Type	Description	Examples
`service.name`	string	The name of the `engine` component.	`cf-classic-engine`
`service.namespace`	string	The namespace of the `engine` component.	`cf-classic-runtime`
`service.version`	string	The version of the `engine` component; in format `<image-tag>@<image-digest>`	`1.179.1@sha256:37caef1e58f8d07ed76da753fb46eb59224e723495c1b9081d3ef7e0bc9449f9`
`cf.classic.runtime.name`	string	The name of the runtime of which this `engine` component is a part.	`my-runtime`
`cf.classic.runtime.version`	string	The version of the runtime chart.	`8.2.0`

Metrics

Default attributes

Attributes below are added to all metrics described in this section.

Attribute	Type	Description	Examples
`cf.classic.build.id`	string	The ID of the build.	`6898c4e4bc5ecdb9f1f95c0c`
`cf.classic.pipeline.id`	string	The ID of the pipeline to which the build belongs.	`6898c4ea6f064e824a33edc3`
`cf.classic.pipeline.name`	string	The name of the pipeline to which the build belongs; in format `<project-name>/<pipeline-name>`.	`my-project/my-pipeline`
`cf.classic.account.id`	string	The ID of the Codefresh account in which the build is running.	`6898c4df2d142ffac1720fbf`
`cf.classic.account.name`	string	The name of the Codefresh account in which the build is running.	`my-account`

`codefresh.classic.build.info`

The metric is always emitted.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.info`	Gauge	—	Contains information about the classic build.

Attribute	Type	Description	Examples
`cf.classic.build.phase`	string enum	The phase of the build.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated`
`cf.classic.build.volume`	string enum	Indicates whether the new or reused volume has been assigned to the build.	`new` \| `reused`

`codefresh.classic.build.start.timestamp`

The metric is always emitted.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.start.timestamp`	Gauge	`s`	Start time in unix timestamp for a build.

`codefresh.classic.build.completion.timestamp`

The metric is always emitted.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.completion.timestamp`	Gauge	`s`	Completion time in unix timestamp for a build.

`codefresh.classic.build.phase.start.timestamp`

The metric is always emitted for every build phase.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.phase.start.timestamp`	Gauge	`s`	Start time in unix timestamp for a build phase.

Attribute	Type	Description	Examples
`cf.classic.build.phase`	string enum	The phase of the build.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated`

`codefresh.classic.build.phase.completion.timestamp`

The metric is always emitted for every build phase.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.phase.completion.timestamp`	Gauge	`s`	Completion time in unix timestamp for a build phase.

Attribute	Type	Description	Examples
`cf.classic.build.phase`	string enum	The phase of the build.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated`

`codefresh.classic.build.step.info`

The metric is always emitted for every build step.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.info`	Gauge	—	Contains information about the classic build step.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`
`cf.classic.build.step.type`	string enum	The type of the step (for internal steps).	`_internal:pre-step` \| `_internal:post-step` \| `_internal:init`
`cf.classic.build.step.type`	string	The type of the step.	`freestyle`; `build`
`cf.classic.build.step.version`	string	The version of the step.	`1.0.0`; `latest`
`cf.classic.build.step.phase`	string enum	The phase of the build step.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated` \| `finished`

`codefresh.classic.build.step.start.timestamp`

The metric is always emitted for every build step.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.start.timestamp`	Gauge	`s`	Start time in unix timestamp for a build step.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`

`codefresh.classic.build.step.completion.timestamp`

The metric is always emitted for every build step.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.completion.timestamp`	Gauge	`s`	Completion time in unix timestamp for a build step.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`

`codefresh.classic.build.step.phase.start.timestamp`

The metric is always emitted for every build step phase.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.phase.start.timestamp`	Gauge	`s`	Start time in unix timestamp for a build step phase.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`
`cf.classic.build.step.phase`	string enum	The phase of the build step.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated` \| `finished`

`codefresh.classic.build.step.phase.completion.timestamp`

The metric is always emitted for every build step phase.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.phase.completion.timestamp`	Gauge	`s`	Completion time in unix timestamp for a build step phase.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`
`cf.classic.build.step.phase`	string enum	The phase of the build step.	`preparing` \| `running` \| `finalizing` \| `failed` \| `succeeded` \| `terminated` \| `finished`

`codefresh.classic.build.step.cpu.time`

The metric is emitted for every build step, unless the step was too short to collect Docker metrics.

Emitted for Linux builds only. Not emitted if dind component is rootless.

For steps of type build that are not using buildx with docker-container driver, this metric may be underreported.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.cpu.time`	Counter	`s`	Cumulative cpu time consumed by step in seconds.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`

`codefresh.classic.build.step.memory.usage`

The metric is emitted for every build step, unless the step was too short to collect Docker metrics.

Emitted for Linux builds only. Not emitted if dind component is rootless.

For steps of type build that are not using buildx with docker-container driver, this metric may be underreported.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.memory.usage`	Gauge	`By`	Current memory usage for step, including all memory regardless of when it was accessed.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`

`codefresh.classic.build.step.memory.working_set`

The metric is emitted for every build step, unless the step was too short to collect Docker metrics.

Emitted for Linux builds only. Not emitted if dind component is rootless.

For steps of type build that are not using buildx with docker-container driver, this metric may be underreported.

Name	Instrument Type	Unit	Description
`codefresh.classic.build.step.memory.working_set`	Gauge	`By`	Current working set for step. Calculated as the current memory usage minus `inactive_file`.

Attribute	Type	Description	Examples
`cf.classic.build.step.name`	string	The name of the step as defined in the pipeline YAML. Unique per build.	`my-clone`