1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/observability/cluster_observability_operator/cluster-observability-operator-release-notes.adoc
2025-09-01 10:36:39 +00:00

400 lines
23 KiB
Plaintext

// Cluster Observability Operator Release Notes
:_mod-docs-content-type: ASSEMBLY
include::_attributes/common-attributes.adoc[]
[id="cluster-observability-operator-release-notes"]
= {coo-full} release notes
:context: cluster-observability-operator-release-notes
toc::[]
The {coo-first} is an optional {product-title} Operator that enables administrators to create standalone monitoring stacks that are independently configurable for use by different services and users.
The {coo-short} complements the built-in monitoring capabilities of {product-title}. You can deploy it in parallel with the default platform and user workload monitoring stacks managed by the {cmo-first}.
These release notes track the development of the {coo-full} in {product-title}.
The following table provides information about which features are available depending on the version of {coo-full} and {product-title}:
[cols="1,1,1,1,1,1,1", options="header"]
|===
| COO Version | OCP Versions | Distributed tracing | Logging | Troubleshooting panel | ACM alerts | Incident detection
| 1.1+ | 4.12 - 4.14 | ✔ | ✔ | ✘ | ✘ | ✘
| 1.1+ | 4.15 | ✔ | ✔ | ✘ | ✔ | ✘
| 1.1+ | 4.16 - 4.18 | ✔ | ✔ | ✔ | ✔ | ✘
| 1.2+ | 4.19+ | ✔ | ✔ | ✔ | ✔ | ✔
|===
include::snippets/unified-perspective-web-console.adoc[]
[id="cluster-observability-operator-release-notes-1-2-2_{context}"]
== {coo-full} 1.2.2
The following advisory is available for {coo-full} 1.2.2:
* link:https://access.redhat.com/errata/RHBA-2025:11689[RHBA-2025:11689 {coo-full} 1.2.2]
[id="cluster-observability-operator-1-2-2-bug-fixes_{context}"]
=== Bug fixes
* Before this update, the installation of the incident detection feature could fail intermittently. The symptoms include the incident detection UI being visible but not including any data. In addition, the health-analyzer `ServiceMonitor` resource is in a failed state, with the error message `tls: failed to verify certificate: x509`. With this release, the incident detection feature installs correctly. (link:https://issues.redhat.com/browse/COO-1062[COO-1062])
+
If you are upgrading from 1.2.1 where the bug was occurring, you must recreate the monitoring UI plugin to resolve the issue.
[id="cluster-observability-operator-1-2-2-known-issues_{context}"]
=== Known issues
These are the known issues in {coo-full} 1.2.2:
* When installing version 1.2.2 or when upgrading from version 1.2.0, the monitoring plugin's `UIPlugin` resource can be corrupted. This occurs when you have also deployed distributed tracing, the troubleshooting panel, and Advance Cluster Management (ACM), together with the monitoring UI plugin. You can resolve this issue by recreating the UI plugin. (link:https://issues.redhat.com/browse/COO-1051[COO-1051])
+
If you have previously resolved the issue in 1.2.1 and then upgrade to 1.2.2, this issue will not reoccur.
[id="cluster-observability-operator-release-notes-1-2-1_{context}"]
== {coo-full} 1.2.1
The following advisory is available for {coo-full} 1.2.1:
* link:https://access.redhat.com/errata/RHBA-2025:10696[RHBA-2025:10696 {coo-full} 1.2.1]
[id="cluster-observability-operator-1-2-1-bug-fixes_{context}"]
=== Bug fixes
* Before this update, an old version label matcher was retained during the Operator version 1.2 upgrade. This caused Perses dashboards to become unavailable. With this release, the version label is removed and Perses dashboards are correctly reconciled.
[id="cluster-observability-operator-1-2-1-known-issues_{context}"]
=== Known issues
These are the known issues in {coo-full} 1.2.1:
* The installation of the incident detection feature could fail intermittently. The symptoms include the incident detection UI being visible but not including any data. In addition, the health-analyzer `ServiceMonitor` resource is in a failed state, with the error message `tls: failed to verify certificate: x509`. You can resolve this issue by upgrading to 1.2.2 and recreating the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-1062[COO-1062])
* When installing version 1.2.1 or when upgrading from version 1.2.0, the monitoring plugin's `UIPlugin` resource can be corrupted. This occurs when you have also deployed distributed tracing, the troubleshooting panel, and Advance Cluster Management (ACM), together with the monitoring UI plugin. You can resolve this issue by recreating the UI plugin. (link:https://issues.redhat.com/browse/COO-1051[COO-1051])
[id="cluster-observability-operator-release-notes-1-2_{context}"]
== {coo-full} 1.2
The following advisory is available for {coo-full} 1.2:
* link:https://access.redhat.com/errata/RHBA-2025:8940[RHBA-2025:8940 {coo-full} 1.2]
[id="cluster-observability-operator-1-2-new-features-enhancements_{context}"]
=== New features and enhancements
* The logging UI plugin now supports the OTEL format, in addition to the previously supported ViaQ scheme. (link:https://issues.redhat.com/browse/COO-816[COO-816])
* Accelerators Perses dashboards are deployed by default when you install the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-942[COO-942])
* Multiple results per graph node are now displayed for Korrel8r. (link:https://issues.redhat.com/browse/COO-785[COO-785])
* Direct navigation to individual incident detail is now supported in the incident detection panel, and this enables the incidents overview functionality in {rh-rhacm-first} 2.14. (link:https://issues.redhat.com/browse/COO-977[COO-977], link:https://issues.redhat.com/browse/ACM-18751[ACM-18751])
* Advanced filters have been added to the tracing view. (link:https://issues.redhat.com/browse/COO-979[COO-979])
* The status of the distributed tracing UI plugin is now General Availability (GA), supporting Patternfly 4, 5 and 6. (link:https://issues.redhat.com/browse/COO-873[COO-873])
[id="cluster-observability-operator-1-2-bug-fixes_{context}"]
=== Bug fixes
* Previously, LokiStack was a prerequisite for installing the logging UI plugin. With this release, you can install the logging UI plugin without LokiStack. (link:https://issues.redhat.com/browse/COO-760[COO-760])
* Previously, the *Silence Alert* button in the **Incidents** -> **Component** section did not pre-populate the fields and was not usable. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-970[COO-970])
[id="cluster-observability-operator-1-2-known-issues_{context}"]
=== Known issues
These are the known issues in {coo-full} 1.2.0:
* When upgrading from {coo-short} 1.1.1 to {coo-short} 1.2, the Perses dashboard is not correctly reconciled, and this requires the monitoring UI plugin to be reinstalled. (link:https://issues.redhat.com/browse/COO-978[COO-978])
[id="cluster-observability-operator-release-notes-1-1-1_{context}"]
== {coo-full} 1.1.1
// Back fill advisory when it is created by KOnflux
// The following advisory is available for {coo-full} 1.1.1:
//
// * link:https://access.redhat.com/errata/RHBA-2025:????[RHBA-2025:??? {coo-full} 1.1.1]
[id="cluster-observability-operator-1-1-1-bug-fixes_{context}"]
=== Bug fixes
* Previously, `observability-operator` and `perses-operator` pods on many clusters entered a `CrashLoopBackOff` state due to `OutOfMemory` errors, after upgrading from {coo-full} 1.0. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-784[*COO-784*])
[id="cluster-observability-operator-release-notes-1-1_{context}"]
== {coo-full} 1.1
The following advisory is available for {coo-full} 1.1:
* link:https://access.redhat.com/errata/RHBA-2025:4360[RHBA-2025:4360 {coo-full} 1.1]
[id="cluster-observability-operator-1-1-new-features-enhancements_{context}"]
=== New features and enhancements
* You can now install the monitoring UI plugin using {coo-short}. (link:https://issues.redhat.com/browse/COO-262[*COO-262*])
* You can enable incident detection in the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-690[*COO-690*])
* TLS support for the Thanos web endpoint has been added. (link:https://issues.redhat.com/browse/COO-222[*COO-222*])
[id="cluster-observability-operator-1-1-known-issues_{context}"]
=== Known issues
These are the known issues in {coo-full} 1.1.0:
* `observability-operator` and `perses-operator` pods enter a `CrashLoopBackOff` state due to `OutOfMemory` errors, after upgrading from {coo-full} 1.0.
+
A workaround is provided in the knowledge base article link:https://access.redhat.com/solutions/7113898[ClusterObservability and perses operator pod in CrashLoopBackOff due to OOMKilled in RHOCP4].
+
This issue is being tracked in link:https://issues.redhat.com/browse/COO-784[*COO-784*].
[id="cluster-observability-operator-1-1-bug-fixes_{context}"]
=== Bug fixes
* Previously, the logging UI plugin did not support setting a custom LokiStack name or namespace. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-332[*COO-332*])
[id="cluster-observability-operator-release-notes-1-0_{context}"]
== {coo-full} 1.0
// Need to check if there is an advisory generated now that the build system has moved to Konflux
// The following advisory is available for {coo-full} 1.0:
//
// * link:https://access.redhat.com/errata/RHSA-2024:????[RHEA-2024:??? {coo-full} 1.0]
[id="cluster-observability-operator-1-0-new-features-enhancements_{context}"]
=== New features and enhancements
* {coo-short} is now enabled for {product-title} platform monitoring. (link:https://issues.redhat.com/browse/COO-476[*COO-476*])
** Implements HTTPS support for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-480[*COO-480*])
** Implements authn/authz for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-481[*COO-481*])
** Configures ServiceMonitor resource to collect metrics from {coo-short}. (link:https://issues.redhat.com/browse/COO-482[*COO-482*])
** Adds `operatorframework.io/cluster-monitoring=true` annotation to the OLM bundle. (link:https://issues.redhat.com/browse/COO-483[*COO-483*])
** Defines the alerting strategy for {coo-short} . (link:https://issues.redhat.com/browse/COO-484[*COO-484*])
** Configures PrometheusRule for alerting. (link:https://issues.redhat.com/browse/COO-485[*COO-485*])
* Support level annotations have been added to the `UIPlugin` CR when created. The support level is based on the plugin type, with values of `DevPreview`, `TechPreview`, or `GeneralAvailability`. (link:https://issues.redhat.com/browse/COO-318[*COO-318*])
// must-gather postponed to 1.1
//* You can now gather debugging information about {coo-short} by using the `oc adm must-gather` CLI command. (link:https://issues.redhat.com/browse/COO-194[*COO-194*])
* You can now configure the Alertmanager `scheme` and `tlsConfig` fields in the Prometheus CR. (link:https://issues.redhat.com/browse/COO-219[*COO-219*])
// Dev preview so cannot document
//* You can now install the Monitoring UI plugin using {coo-short}. (link:https://issues.redhat.com/browse/COO-262[*COO-262*])
* The extended Technical Preview for the troubleshooting panel adds support for correlating traces with Kubernetes resources and directly with other observable signals including logs, alerts, metrics, and network events. (link:https://issues.redhat.com/browse/COO-450[*COO-450*])
** You can select a Tempo instance and tenant when you navigate to the tracing page by clicking *Observe -> Tracing* in the web console. The preview troubleshooting panel only works with the `openshift-tracing / platform` instance and the `platform` tenant.
** The troubleshooting panel works best in the *Administrator* perspective. It has limited functionality in the Developer perspective due to authorization issues with some back ends, most notably Prometheus for metrics and alerts. This will be addressed in a future release.
The following table provides information about which features are available depending on the version of {coo-full} and {product-title}:
[cols="1,1,1,1,1", options="header"]
|===
| COO Version | OCP Versions | Distributed Tracing | Logging | Troubleshooting Panel
| 1.0 | 4.12 - 4.15 | ✔ | ✔ | ✘
| 1.0 | 4.16+ | ✔ | ✔ | ✔
|===
[id="cluster-observability-operator-1-0-CVEs"]
=== CVEs
* link:https://access.redhat.com/security/cve/CVE-2023-26159[CVE-2023-26159]
* link:https://access.redhat.com/security/cve/CVE-2024-28849[CVE-2024-28849]
* link:https://access.redhat.com/security/cve/CVE-2024-45338[CVE-2024-45338]
[id="cluster-observability-operator-1-0-bug-fixes_{context}"]
=== Bug fixes
* Previously, the default namespace for the {coo-short} installation was `openshift-operators`. With this release, the defaullt namespace changes to `openshift-cluster-observability-operator`. (link:https://issues.redhat.com/browse/COO-32[*COO-32*])
* Previously, `korrel8r` was only able to parse time series selector expressions. With this release, `korrel8r` can parse any valid PromQL expression to extract the time series selectors that it uses for correlation. (link:https://issues.redhat.com/browse/COO-558[*COO-558*])
* Previously, when viewing a Tempo instance from the Distributed Tracing UI plugin, the scatter plot graph showing the traces duration was not rendered correctly. The bubble size was too large and overlapped the x and y axis. With this release, the graph is rendered correctly. (link:https://issues.redhat.com/browse/COO-319[*COO-319*])
== Features available on older, Technology Preview releases
The following table provides information about which features are available depending on older version of {coo-full} and {product-title}:
[cols="1,1,1,1,1,1", options="header"]
|===
| COO Version | OCP Versions | Dashboards | Distributed Tracing | Logging | Troubleshooting Panel
| 0.2.0 | 4.11 | ✔ | ✘ | ✘ | ✘
| 0.3.0+, 0.4.0+ | 4.11 - 4.15 | ✔ | ✔ | ✔ | ✘
| 0.3.0+, 0.4.0+ | 4.16+ | ✔ | ✔ | ✔ | ✔
|===
[id="cluster-observability-operator-release-notes-0-4-1_{context}"]
== {coo-full} 0.4.1
The following advisory is available for {coo-full} 0.4.1:
* link:https://access.redhat.com/errata/RHSA-2024:8040[RHEA-2024:8040 {coo-full} 0.4.1]
[id="cluster-observability-operator-0-4-1-new-features-enhancements_{context}"]
=== New features and enhancements
* You can now configure WebTLS for Prometheus and Alertmanager.
[id="cluster-observability-operator-0-4-1-CVEs"]
=== CVEs
* link:https://access.redhat.com/security/cve/CVE-2024-6104[CVE-2024-6104]
* link:https://access.redhat.com/security/cve/CVE-2024-24786[CVE-2024-24786]
[id="cluster-observability-operator-0-4-1-bug-fixes_{context}"]
=== Bug fixes
* Previously, when you deleted the dashboard UI plugin, the `consoles.operator.openshift.io` resource still contained `console-dashboards-plugin`. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-152[*COO-152*])
* Previously, the web console did not display the correct icon for Red Hat {coo-short} . This release resolves the issue. (link:https://issues.redhat.com/browse/COO-353[*COO-353*])
* Previously, when you installed the {coo-short} from the web console, the support section contained an invalid link. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-354[*COO-354*])
* Previously, the cluster service version (CSV) for {coo-short} linked to an unofficial version of the documentation. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-356[*COO-356*])
[id="cluster-observability-operator-release-notes-0-4-0_{context}"]
== {coo-full} 0.4.0
The following advisory is available for {coo-full} 0.4.0:
// Test the errata link just before publishing
* link:https://access.redhat.com/errata/RHEA-2024:6699[RHEA-2024:6699 {coo-full} 0.4.0]
[id="cluster-observability-operator-0-4-0-new-features-enhancements_{context}"]
=== New features and enhancements
// COO-264
==== Troubleshooting UI plugin
* The troubleshooting UI panel has been improved so you can now select and focus on a specific starting signal.
* There is more visibility into Korrel8r queries, with the option of selecting the depth.
* Users of {product-title} version 4.17+ can access the troubleshooting UI panel from the Application Launcher {launch}. Alternatively, on versions 4.16+, you can access it in the web console by clicking on **Observe** -> **Alerting**.
For more information, see xref:../../observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc#troubleshooting-ui-plugin[troubleshooting UI plugin].
// COO-263
==== Distributed tracing UI plugin
* The distributed tracing UI plugin has been enhanced, with a Gantt chart now available for exploring traces.
For more information, see xref:../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[distributed tracing UI plugin].
[id="cluster-observability-operator-0-4-0-bug-fixes_{context}"]
=== Bug fixes
* Previously, metrics were not available to normal users when accessed in the Developer perspective of the web console, by clicking on **Observe** -> **Logs**.
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-288[*COO-288*])
* Previously, the troubleshooting UI plugin used the wrong filter for network observability.
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-299[*COO-299*])
* Previously, the troubleshooting UI plugin generated an incorrect URL for pod label searches.
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-298[*COO-298*])
* Previously, there was an authorization vulnerability in the Distributed tracing UI plugin.
This release resolves the issue and the Distributed tracing UI plugin has been hardened by using only multi-tenant `TempoStack` and `TempoMonolithic` instances going forward.
[id="cluster-observability-operator-release-notes-0-3-2_{context}"]
== {coo-full} 0.3.2
The following advisory is available for {coo-full} 0.3.2:
* link:https://access.redhat.com/errata/RHEA-2024:5985[RHEA-2024:5985 {coo-full} 0.3.2]
[id="cluster-observability-operator-0-3-2-new-features-enhancements_{context}"]
=== New features and enhancements
* With this release, you can now use tolerations and node selectors with `MonitoringStack` components.
[id="cluster-observability-operator-0-3-2-bug-fixes_{context}"]
=== Bug fixes
* Previously, the logging UIPlugin was not in the `Available` state and the logging pod was not created, when installed on a specific version of {product-title}.
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-260[*COO-260*])
[id="cluster-observability-operator-release-notes-0-3-0"]
== {coo-full} 0.3.0
The following advisory is available for {coo-full} 0.3.0:
* link:https://access.redhat.com/errata/RHEA-2024:4399[RHEA-2024:4399 {coo-full} 0.3.0]
[id="cluster-observability-operator-0-3-0-new-features-enhancements"]
=== New features and enhancements
* With this release, the {coo-full} adds backend support for future {product-title} observability web console UI plugins and observability components.
[id="cluster-observability-operator-release-notes-0-2-0"]
== {coo-full} 0.2.0
The following advisory is available for {coo-full} 0.2.0:
* link:https://access.redhat.com/errata/RHEA-2024:2662[RHEA-2024:2662 {coo-full} 0.2.0]
[id="cluster-observability-operator-0-2-0-new-features-enhancements"]
=== New features and enhancements
* With this release, the {coo-full} supports installing and managing observability-related plugins for the {product-title} web console user interface (UI). (link:https://issues.redhat.com/browse/COO-58[*COO-58*])
[id="cluster-observability-operator-release-notes-0-1-3"]
== {coo-full} 0.1.3
The following advisory is available for {coo-full} 0.1.3:
* link:https://access.redhat.com/errata/RHEA-2024:1744[RHEA-2024:1744 {coo-full} 0.1.3]
[id="cluster-observability-operator-0-1-3-bug-fixes"]
=== Bug fixes
* Previously, if you tried to access the Prometheus web user interface (UI) at `\http://<prometheus_url>:9090/graph`, the following error message would display: `Error opening React index.html: open web/ui/static/react/index.html: no such file or directory`.
This release resolves the issue, and the Prometheus web UI now displays correctly. (link:https://issues.redhat.com/browse/COO-34[*COO-34*])
[id="cluster-observability-operator-release-notes-0-1-2"]
== {coo-full} 0.1.2
The following advisory is available for {coo-full} 0.1.2:
* link:https://access.redhat.com/errata/RHEA-2024:1534[RHEA-2024:1534 {coo-full} 0.1.2]
[id="cluster-observability-operator-0-1-2-CVEs"]
=== CVEs
* link:https://access.redhat.com/security/cve/CVE-2023-45142[CVE-2023-45142]
[id="cluster-observability-operator-0-1-2-bug-fixes"]
=== Bug fixes
* Previously, certain cluster service version (CSV) annotations were not included in the metadata for {coo-short}.
Because of these missing annotations, certain {coo-short} features and capabilities did not appear in the package manifest or in the OperatorHub user interface.
This release adds the missing annotations, thereby resolving this issue. (link:https://issues.redhat.com/browse/COO-11[*COO-11*])
* Previously, automatic updates of the {coo-short} did not work, and a newer version of the Operator did not automatically replace the older version, even though the newer version was available in OperatorHub.
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-12[*COO-12*])
* Previously, Thanos Querier only listened for network traffic on port 9090 of 127.0.0.1 (`localhost`), which resulted in a `502 Bad Gateway` error if you tried to reach the Thanos Querier service.
With this release, the Thanos Querier configuration has been updated so that the component now listens on the default port (10902), thereby resolving the issue.
As a result of this change, you can also now modify the port via server side apply (SSA) and add a proxy chain, if required. (link:https://issues.redhat.com/browse/COO-14[*COO-14*])
[id="cluster-observability-operator-release-notes-0-1-1"]
== {coo-full} 0.1.1
The following advisory is available for {coo-full} 0.1.1:
* link:https://access.redhat.com/errata/RHEA-2024:0550[2024:0550 {coo-full} 0.1.1]
[id="cluster-observability-operator-0-1-1-new-features-enhancements"]
=== New features and enhancements
This release updates the {coo-full} to support installing the Operator in restricted networks or disconnected environments.
[id="cluster-observability-operator-release-notes-0-1"]
== {coo-full} 0.1
This release makes a Technology Preview version of the {coo-full} available on OperatorHub.