Este conteúdo não está disponível no idioma selecionado.

Observability


builds for Red Hat OpenShift 1.4

Build controller observability

Red Hat OpenShift Documentation Team

Abstract

This document provides information about build controller observability.

Chapter 1. Logging

When a build fails or behaves unexpectedly, accessing detailed logs can help you identify the issue. The logs provide information about what happened during the build run.

1.1. Viewing logs

You can view the logs of a build run to identify any runtime errors and to resolve them.

Prerequisites

  • You have installed the oc CLI.
  • Optional: You have installed the shp CLI.

Procedure

  • View logs of a build run by using one of the CLIs:

    Using oc CLI

    $ oc logs <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

    Using shp CLI

    $ shp buildrun logs <buildrun_resource_name>
    Copy to Clipboard Toggle word wrap

Chapter 2. Monitoring

Builds exposes several metrics to help you monitor the performance and functioning of your build resources. The build controller metrics are exposed on the port 8383.

2.1. Build controller metrics

You can check the following build controller metrics for monitoring purposes:

Expand
Table 2.1. Build controller metrics
NameTypeDescriptionLabelsStatus

build_builds_registered_total

Counter

The number of total registered builds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>

experimental

build_buildruns_completed_total

Counter

The number of total completed build runs.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

build_buildrun_establish_duration_seconds

Histogram

The build run establish duration in seconds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

build_buildrun_completion_duration_seconds

Histogram

The build run completion duration in seconds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

build_buildrun_rampup_duration_seconds

Histogram

The build run ramp-up duration in seconds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

build_buildrun_taskrun_rampup_duration_seconds

Histogram

The build run ramp-up duration for a task run in seconds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

build_buildrun_taskrun_pod_rampup_duration_seconds

Histogram

The build run ramp-up duration for a task run pod in seconds.

  • buildstrategy=<build_buildstrategy_name>
  • namespace=<buildrun_namespace>
  • build=<build_name>
  • buildrun=<buildrun_name>

experimental

2.1.1. Histogram metrics

To use custom buckets for the build controller, you must set the environment variable for a particular histogram metric. The following table shows the environment variables for all histogram metrics:

Expand
Table 2.2. Histogram metrics
MetricEnvironment variableDefault

build_buildrun_establish_duration_seconds

PROMETHEUS_BR_EST_DUR_BUCKETS

0,1,2,3,5,7,10,15,20,30

build_buildrun_completion_duration_seconds

PROMETHEUS_BR_COMP_DUR_BUCKETS

50,100,150,200,250,300,350,400,450,500

build_buildrun_rampup_duration_seconds

PROMETHEUS_BR_RAMPUP_DUR_BUCKETS

0,1,2,3,4,5,6,7,8,9,10

build_buildrun_taskrun_rampup_duration_seconds

PROMETHEUS_BR_RAMPUP_DUR_BUCKETS

0,1,2,3,4,5,6,7,8,9,10

build_buildrun_taskrun_pod_rampup_duration_seconds

PROMETHEUS_BR_RAMPUP_DUR_BUCKETS

0,1,2,3,4,5,6,7,8,9,10

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat