.. include:: /../getting_started/vars.rst

Release Notes
*************

.. important:: 

   *Observability Framework* is an experimental product that includes example 
   configuration files for use with several third-party components (Prometheus,
   Grafana Loki, and Grafana). This release is an evaluation distribution; 
   use it to explore the new observability features that support |Connext| 
   applications. 

   Do not deploy any *Observability Framework* components in production.

Supported Platforms
===================

The components of *RTI Connext Observability Framework* are supported on 
the following platforms: 

* *RTI Observability Collector Service* is supported as a Docker image on
  linux/amd64 (x64Linux).

* *RTI Observability Library* is supported on all supported platforms in
  this release. See :link_connext_dds_pro_rn:`Supported Platforms<#release_notes/PAMtable.htm>`
  in the *RTI Connext Core Libraries Release Notes*.

.. _section-docker-compose-env:

Supported Docker Compose Environments
=====================================

The *Observability Framework* package enables you to deploy and run 
*Observability Collector Service* and third-party components Prometheus, 
Grafana Loki, and Grafana, using Docker Compose in a single Linux host. 
The host can run on a Virtual Machine (VM); in this release, we have tested 
the following combinations:

.. list-table:: Tested VM/OS Combinations
    :name: Tested VMs
    :widths: 60 60 60
    :header-rows: 1

    * - Host Arch/OS
      - VM Arch/OS
      - VM
    * - x86 Windows
      - x86 Ubuntu
      - VirtualBox
    * - x86 Mac
      - x86 Ubuntu
      - Parallels
    * - x86 Ubuntu
      - None
      - None

.. important::
    The Docker Compose distribution uses “host” networking that only works 
    on Linux hosts; it is not supported on Docker Desktop for Mac, Docker 
    Desktop for Windows, or Docker EE for Windows Server. 
    
    Windows virtualization technologies such as WSL, WSL2, and Hyper-V also do
    not support “host” networking. Running *Observability Framework* using  
    Docker Compose in these environments will not work.

Compatibility
=============

*Connext Observability Framework* is a new, optional product for use 
with *RTI Connext* 7.1.0 and higher.

What's New in 7.1.0
===================

*Connext Observability Framework* uses telemetry data to help identify and 
resolve potential issues in |Connext| applications. This product is not
installed as part of a |Connext| package; it must be downloaded and
installed separately, as described in :ref:`section-installation`.

Third-Party Software
====================

The following third-party software is used in *Observability Collector Service*.

.. list-table:: Third-Party Software (Observability Collector Service)
    :name: ThirdParty
    :widths: 40 40 
    :header-rows: 1

    * - Third-Party Software
      - Version
    * - CivetWeb
      - 1.15
    * - Prometheus-cpp
      - 1.0.1
    * - nlohmann-json
      - 3.11.2

In addition, the Docker containers created by *Observability Framework*
include the following third-party software.

.. list-table:: Third-Party Software (Docker Containers)
    :name: ThirdPartyDocker
    :widths: 50 50
    :header-rows: 1

    * - Third-Party Software
      - Version
    * - Prometheus
      - 2.37.5
    * - Grafana
      - 9.2.1
    * - Grafana Loki
      - 2.7.0

.. warning::
   All third-party software is subject to third-party license terms and
   conditions. IT IS YOUR RESPONSIBILITY TO ENSURE THAT YOUR USE OF THIRD-PARTY
   SOFTWARE COMPLIES WITH THE CORRESPONDING THIRD-PARTY LICENSE TERMS AND
   CONDITIONS.