Red Hat SummitObservability
Build controller observability
Abstract
Chapter 1. Logging
As a developer, detailed logs are essential for diagnosing issues when a build fails or behaves unexpectedly. Logs provide information about what happened during the build. If logs do not show the error, you can check the build controller or histogram metrics to troubleshoot the issue.
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
ocCLI. -
Optional: You have installed the
shpCLI.
Procedure
View logs of a build run. You can do so by using the
ocCLI or theshpCLI.oc logs <buildrun_resource_name>
$ oc logs <buildrun_resource_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow shp buildrun logs <buildrun_resource_name>
$ shp buildrun logs <buildrun_resource_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 2. Monitoring
Builds exposes several metrics for cluster administrators to monitor the performance and functioning of your build resources. The build controller metrics are exposed on port 8383.
2.1. Builds controller metrics
Builds controller metrics expose the internal state and activity of the builds controller in OpenShift Container Platform.
Red Hat does not provide support for the builds controller metrics.
You can check the following builds controller metrics for monitoring purposes:
| Name | Type | Description | Labels | Status |
|---|---|---|---|---|
|
| Counter | The number of total registered builds. |
| experimental |
|
| Counter | The number of total completed build runs. |
| experimental |
|
| Histogram | The build run establish duration in seconds. |
| experimental |
|
| Histogram | The build run completion duration in seconds. |
| experimental |
|
| Histogram | The build run ramp-up duration in seconds. |
| experimental |
|
| Histogram | The build run ramp-up duration for a task run in seconds. |
| experimental |
|
| Histogram | The build run ramp-up duration for a task run pod in seconds. |
| 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:
| Metric | Environment variable | Default |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legal Notice
Copyright © 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 the OpenJS Foundation.
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.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}