Skip to content

fix(classic-runtime-monitoring): document build metrics limitations #1364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions _docs/installation/runner/classic-runtime-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,9 @@ The metric is always emitted for every build step phase.

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

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand All @@ -212,7 +214,9 @@ For steps of type `build` that are not using `buildx` with `docker-container` dr

#### `codefresh.classic.build.step.cpu.periods`

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand All @@ -229,7 +233,9 @@ For steps of type `build` that are not using `buildx` with `docker-container` dr

#### `codefresh.classic.build.step.cpu.throttled.periods`

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand All @@ -246,7 +252,9 @@ For steps of type `build` that are not using `buildx` with `docker-container` dr

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

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand All @@ -265,7 +273,9 @@ For steps of type `build` that are not using `buildx` with `docker-container` dr

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

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand All @@ -282,7 +292,9 @@ For steps of type `build` that are not using `buildx` with `docker-container` dr

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

The metric is always emitted for every build step, unless the step was too short to collect Docker metrics.
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.

Expand Down