Skip to content

Latest commit

 

History

History
722 lines (506 loc) · 24 KB

otel-rn.adoc

File metadata and controls

722 lines (506 loc) · 24 KB

Release notes for the {OTELName}

You can use the {OTELName} in combination with the {TempoName}.

Release notes for {OTELName} 3.3

The {OTELName} is provided through the {OTELOperator}.

The {OTELName} 3.3 is based on the open source OpenTelemetry release 0.107.0.

CVEs

This release fixes the following CVEs:

Technology Preview features

This update introduces the following Technology Preview features:

  • Group-by-Attributes Processor

  • Transform Processor

  • Routing Connector

  • Prometheus Remote Write Exporter

  • Exporting logs to the LokiStack log store

New features and enhancements

This update introduces the following enhancements:

  • Collector dashboard for the internal Collector metrics and analyzing Collector health and performance. (TRACING-3768)

  • Support for automatically reloading certificates in both the OpenTelemetry Collector and instrumentation. (TRACING-4186)

Bug fixes

This update introduces the following bug fixes:

  • Before this update, the ServiceMonitor object was failing to scrape operator metrics due to missing permissions for accessing the metrics endpoint. With this update, this issue is fixed by creating the ServiceMonitor custom resource when operator monitoring is enabled. (TRACING-4288)

  • Before this update, the Collector service and the headless service were both monitoring the same endpoints, which caused duplication of metrics collection and ServiceMonitor objects. With this update, this issue is fixed by not creating the headless service. (OBSDA-773)

Release notes for {OTELName} 3.2.2

The {OTELName} is provided through the {OTELOperator}.

CVEs

This release fixes the following CVEs:

Bug fixes

This update introduces the following bug fix:

  • Before this update, secrets were perpetually generated on {product-title} 4.16 because the operator tried to reconcile a new openshift.io/internal-registry-pull-secret-ref annotation for service accounts, causing a loop. With this update, the operator ignores this new annotation. (TRACING-4435)

Release notes for {OTELName} 3.2.1

The {OTELName} is provided through the {OTELOperator}.

CVEs

This release fixes the following CVEs:

New features and enhancements

This update introduces the following enhancement:

  • {OTELName} 3.2.1 is based on the open source OpenTelemetry release 0.102.1.

Release notes for {OTELName} 3.2

The {OTELName} is provided through the {OTELOperator}.

Technology Preview features

This update introduces the following Technology Preview features:

  • Host Metrics Receiver

  • OIDC Auth Extension

  • Kubernetes Cluster Receiver

  • Kubernetes Events Receiver

  • Kubernetes Objects Receiver

  • Load-Balancing Exporter

  • Kubelet Stats Receiver

  • Cumulative to Delta Processor

  • Forward Connector

  • Journald Receiver

  • Filelog Receiver

  • File Storage Extension

New features and enhancements

This update introduces the following enhancement:

  • {OTELName} 3.2 is based on the open source OpenTelemetry release 0.100.0.

Deprecated functionality

In {OTELName} 3.2, use of empty values and null keywords in the OpenTelemetry Collector custom resource is deprecated and planned to be unsupported in a future release. Red Hat will provide bug fixes and support for this syntax during the current release lifecycle, but this syntax will become unsupported. As an alternative to empty values and null keywords, you can update the OpenTelemetry Collector custom resource to contain empty JSON objects as open-closed braces {} instead.

Bug fixes

This update introduces the following bug fix:

  • Before this update, the checkbox to enable Operator monitoring was not available in the web console when installing the {OTELOperator}. As a result, a ServiceMonitor resource was not created in the openshift-opentelemetry-operator namespace. With this update, the checkbox appears for the {OTELOperator} in the web console so that Operator monitoring can be enabled during installation. (TRACING-3761)

Release notes for {OTELName} 3.1.1

The {OTELName} is provided through the {OTELOperator}.

CVEs

This release fixes CVE-2023-39326.

Release notes for {OTELName} 3.1

The {OTELName} is provided through the {OTELOperator}.

Technology Preview features

This update introduces the following Technology Preview feature:

  • The target allocator is an optional component of the OpenTelemetry Operator that shards Prometheus receiver scrape targets across the deployed fleet of OpenTelemetry Collector instances. The target allocator provides integration with the Prometheus PodMonitor and ServiceMonitor custom resources.

New features and enhancements

This update introduces the following enhancement:

  • {OTELName} 3.1 is based on the open source OpenTelemetry release 0.93.0.

Release notes for {OTELName} 3.0

New features and enhancements

This update introduces the following enhancements:

  • {OTELName} 3.0 is based on the open source OpenTelemetry release 0.89.0.

  • The OpenShift distributed tracing data collection Operator is renamed as the {OTELOperator}.

  • Support for the ARM architecture.

  • Support for the Prometheus receiver for metrics collection.

  • Support for the Kafka receiver and exporter for sending traces and metrics to Kafka.

  • Support for cluster-wide proxy environments.

  • The {OTELOperator} creates the Prometheus ServiceMonitor custom resource if the Prometheus exporter is enabled.

  • The Operator enables the Instrumentation custom resource that allows injecting upstream OpenTelemetry auto-instrumentation libraries.

Removal notice

In {OTELName} 3.0, the Jaeger exporter has been removed. Bug fixes and support are provided only through the end of the 2.9 lifecycle. As an alternative to the Jaeger exporter for sending data to the Jaeger collector, you can use the OTLP exporter instead.

Bug fixes

This update introduces the following bug fixes:

  • Fixed support for disconnected environments when using the oc adm catalog mirror CLI command.

Known issues

There is currently a known issue:

  • Currently, the cluster monitoring of the {OTELOperator} is disabled due to a bug (TRACING-3761). The bug is preventing the cluster monitoring from scraping metrics from the {OTELOperator} due to a missing label openshift.io/cluster-monitoring=true that is required for the cluster monitoring and service monitor object.

    Workaround

    You can enable the cluster monitoring as follows:

    1. Add the following label in the Operator namespace: oc label namespace openshift-opentelemetry-operator openshift.io/cluster-monitoring=true

    2. Create a service monitor, role, and role binding:

      apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
  name: opentelemetry-operator-controller-manager-metrics-service
  namespace: openshift-opentelemetry-operator
spec:
  endpoints:
  - bearerTokenFile: /var/run/secrets/kubernetes.io/serviceaccount/token
    path: /metrics
    port: https
    scheme: https
    tlsConfig:
      insecureSkipVerify: true
  selector:
    matchLabels:
      app.kubernetes.io/name: opentelemetry-operator
      control-plane: controller-manager
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
  name: otel-operator-prometheus
  namespace: openshift-opentelemetry-operator
  annotations:
    include.release.openshift.io/self-managed-high-availability: "true"
    include.release.openshift.io/single-node-developer: "true"
rules:
- apiGroups:
  - ""
  resources:
  - services
  - endpoints
  - pods
  verbs:
  - get
  - list
  - watch
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  name: otel-operator-prometheus
  namespace: openshift-opentelemetry-operator
  annotations:
    include.release.openshift.io/self-managed-high-availability: "true"
    include.release.openshift.io/single-node-developer: "true"
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: Role
  name: otel-operator-prometheus
subjects:
- kind: ServiceAccount
  name: prometheus-k8s
  namespace: openshift-monitoring

Release notes for {OTELName} 2.9.2

{OTELName} 2.9.2 is based on the open source OpenTelemetry release 0.81.0.

CVEs

Known issues

There is currently a known issue:

Release notes for {OTELName} 2.9.1

{OTELName} 2.9.1 is based on the open source OpenTelemetry release 0.81.0.

CVEs

Known issues

There is currently a known issue:

Release notes for {OTELName} 2.9

{OTELName} 2.9 is based on the open source OpenTelemetry release 0.81.0.

New features and enhancements

This release introduces the following enhancements for the {OTELShortName}:

  • Support OTLP metrics ingestion. The metrics can be forwarded and stored in the user-workload-monitoring via the Prometheus exporter.

  • Support the Operator maturity Level IV, Deep Insights, which enables upgrading and monitoring of OpenTelemetry Collector instances and the {OTELOperator}.

  • Report traces and metrics from remote clusters using OTLP or HTTP and HTTPS.

  • Collect {product-title} resource attributes via the resourcedetection processor.

  • Support the managed and unmanaged states in the OpenTelemetryCollector custom resouce.

Known issues

There is currently a known issue:

Release notes for {OTELName} 2.8

{OTELName} 2.8 is based on the open source OpenTelemetry release 0.74.0.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.7

{OTELName} 2.7 is based on the open source OpenTelemetry release 0.63.1.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.6

{OTELName} 2.6 is based on the open source OpenTelemetry release 0.60.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.5

{OTELName} 2.5 is based on the open source OpenTelemetry release 0.56.

New features and enhancements

This update introduces the following enhancement:

  • Support for collecting Kubernetes resource attributes to the {OTELName} Operator.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.4

{OTELName} 2.4 is based on the open source OpenTelemetry release 0.49.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.3

{OTELName} 2.3.1 is based on the open source OpenTelemetry release 0.44.1.

{OTELName} 2.3.0 is based on the open source OpenTelemetry release 0.44.0.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.2

{OTELName} 2.2 is based on the open source OpenTelemetry release 0.42.0.

Technology Preview features

The unsupported OpenTelemetry Collector components included in the 2.1 release are removed.

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.1

{OTELName} 2.1 is based on the open source OpenTelemetry release 0.41.1.

Technology Preview features

This release introduces a breaking change to how to configure certificates in the OpenTelemetry custom resource file. With this update, the ca_file moves under tls in the custom resource, as shown in the following examples.

CA file configuration for OpenTelemetry version 0.33
spec:
  mode: deployment
  config: |
    exporters:
      jaeger:
        endpoint: jaeger-production-collector-headless.tracing-system.svc:14250
        ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"
CA file configuration for OpenTelemetry version 0.41.1
spec:
  mode: deployment
  config: |
    exporters:
      jaeger:
        endpoint: jaeger-production-collector-headless.tracing-system.svc:14250
        tls:
          ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"

Bug fixes

This release addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

Release notes for {OTELName} 2.0

{OTELName} 2.0 is based on the open source OpenTelemetry release 0.33.0.

This release adds the {OTELName} as a Technology Preview, which you install using the {OTELName} Operator. {OTELName} is based on the OpenTelemetry APIs and instrumentation. The {OTELName} includes the OpenTelemetry Operator and Collector. You can use the Collector to receive traces in the OpenTelemetry or Jaeger protocol and send the trace data to the {OTELName}. Other capabilities of the Collector are not supported at this time. The OpenTelemetry Collector allows developers to instrument their code with vendor agnostic APIs, avoiding vendor lock-in and enabling a growing ecosystem of observability tooling.