Observability

builds for Red Hat OpenShift 1.1

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>
```
Using shp CLI
```
$ shp buildrun logs <buildrun_resource_name>
```

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:

Table 2.1. Build controller metrics

Name	Type	Description	Labels	Status
`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:

Table 2.2. Histogram metrics

Metric	Environment variable	Default
`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

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at Content from creativecommons.org is not included.http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat 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 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.