rticom/collector-service-lite repository overview

RTI® Observability Collector Service Lite is a component of the RTI Connext® Observability Framework, a solution that scalably collects and distributes telemetry data from RTI Connext applications. For metrics, logs, and security events, Collector Service Lite can forward telemetry data from RTI Connext applications to other Collector Service or Collector Service Lite instances. For additional information on how this service works in the RTI Connext Observability Framework, see the RTI documentation⁠.

Collector Service Lite also collects non-metric data (configuration and discovery data) that is currently consumed by Admin Console to support the remote debugging feature. For additional information on remote debugging with Admin Console see Remote Debugging⁠.

For complete documentation about Collector Service Lite, see Collector Service⁠ in the RTI Observability Framework User's Manual.

⁠Releases

The documentation on this page applies to the Collector Service Lite Docker image with the latest tag, which refers to the most recent image released by RTI. To confirm the Connext release that corresponds to the latest tag, or to review the other Connext releases that support the Collector Service Lite image, go to https://hub.docker.com/r/rticom/collector-service-lite/tags⁠.

For Collector Service Lite release notes, see the Observability Framework User's Manual⁠

⁠Collector Service Lite receivers and exporters

Collector Service Lite receives data by instantiating receiver endpoints, and it forwards data by instantiating exporter endpoints.

⁠Collector Service Lite receivers

Currently, the only supported receiver endpoint is a DDS receiver endpoint, which receives telemetry data from Monitoring Library 2.0 in a Connext application or from another Collector Service or Collector Service Lite instance when Collector Service Lite acts as a Forwarder.

⁠Collector Service Lite exporters

The following exporter endpoints are supported:

• websocket_exporter, which provides telemetry data to RTI Admin Console for remote debugging using a WebSocket API.
• dds_exporter, which forwards telemetry data to another Collector Service or Collector Service Lite instance.

⁠Using the Collector Service Lite container image

Running Collector Service Lite on Docker is as simple as running the docker run command:

docker run -dt \
        --network host \
        -v $PWD/rti_license.dat:/opt/rti.com/rti_connext_dds-7.7.0/rti_license.dat \
        -e CFG_NAME="NonSecureForwarderLANtoLAN" \
        --name=collector_service_lite \
        rticom/collector-service-lite:latest

The above command starts Collector Service Lite with the NonSecureForwarderLANtoLAN configuration. which forwards the metrics and logs emitted by Connext applications using Connext Monitoring Library 2.0⁠ on domain ID 101 to another Collector Service or Collector Service Lite instance.

An RTI license file is always required to run Collector Service Lite in a Docker container. Bind-mount your license from the host by using the following command-line parameter:

-v /path/to/your_license.dat:/opt/rti.com/rti_connext_dds-7.7.0/rti_license.dat

The Collector Service Lite container image uses the following user and group:

• User: rtiuser (1010)
• Group: rtigroup (1010)

The Collector Service Lite container image uses the following working directory:

• /home/rtiuser/rti_workspace/7.7.0/user_config/collector_service

The following table indicates the RTI licenses required based on your answers to the questions in the first two columns.

⁠Builtin configuration

Use the following command to retrieve the Collector Service Lite builtin configuration file:

docker cp collector_service:/opt/rti.com/rti_connext_dds-7.7.0/resource/xml/RTI_COLLECTOR_SERVICE.xml .

Collector Service Lite is compatible with the following builtin configuration profiles:

In LWSecure profiles, Collector Service Lite uses RTI® Lightweight Builtin Security Plugins.

In Secure profiles, Collector Service Lite uses RTI® Security Plugins.

In LAN profiles, Collector Service Lite uses UDPv4 and SHMEM transports to receive telemetry data from Connext applications and runs on the same LAN where the applications run.

NOTE: The Collector Service Lite Docker container supports multicast. Monitoring Library 2.0 only supports connecting to a single Collector Service Lite instance. Because the default initial peers include a multicast address, more than one Collector Service Lite instance on the network may be discovered. If that happens, Monitoring Library 2.0 will print a warning: Multiple active Collector Services detected. To avoid this situation, set collector_initial_peers to the unicast address of the specific Collector Service or Collector Service Lite instance you want to connect to.

In WAN profiles, Collector Service Lite uses RTI Real-Time WAN Transport to receive telemetry data from Connext applications and runs on a WAN. For example, Collector Service Lite may run in an AWS instance while the Connext applications may run on-premise.

The default profile is NonSecureRemoteDebuggingLAN. To select a different profile, set the environment variable CFG_NAME to the name of the profile you want to use. For example, to run the Collector Service Lite SecureRemoteDebuggingLAN profile, set the environment variable CFG_NAME to "SecureRemoteDebuggingLAN".

docker run -dt \
        --network host \
        -v $PWD/rti_license.dat:/opt/rti.com/rti_connext_dds-7.7.0/rti_license.dat \
        -e CFG_NAME="SecureRemoteDebuggingLAN" \
        --name=collector_service_lite \
        rticom/collector-service-lite:latest

⁠Release Notes

Release notes for RTI Connext products are available on the RTI Community Portal at https://community.rti.com/documentation⁠. For patch release notes, contact our support team at [email protected]⁠ to request the relevant Release Notes Supplement. For Docker image release notes, check RTI’s Github containers repository at https://github.com/rticommunity/rticonnextdds-containers⁠.

⁠License

RTI® Collector Service Lite is licensed under the following supplemental license terms and the Software License Agreement accompanying RTI Connext® Professional (https://www.rti.com/free-trial/terms⁠).

This image uses Ubuntu as the base image, and your usage must comply with the applicable license terms found here⁠.

You can find the Software Bill of Materials (SBOM) third-party information in SPDX format in the /user/local/share/sbom/ directory.

Additional third party information can be found at https://community.rti.com/documentation#doc_third_party⁠.

Use the following command to retrieve the RTI_License_Agreement_LM.pdf builtin file:

docker cp collector_service:/opt/rti.com/rti_connext_dds-7.7.0/RTI_License_Agreement_LM.pdf .

⁠How to get a license file

An RTI license file is always required to run Collector Service Lite in a Docker container.

⁠Existing customers

If you are an RTI customer, and you need an RTI Connext license file, contact RTI support⁠.

⁠Evaluators

If you are not an RTI customer, visit https://evaluation.rti.com⁠ to get an RTI Connext free trial for release 7.7.0 or higher. With the free trial you will receive a limited time license file that contains an activation key for RTI Connext Professional, RTI Security Plugins, RTI Real-Time WAN Transport, and RTI Cloud Discovery Service.

To get a free trial license for earlier releases, contact [email protected]⁠.

⁠RTI Supplemental License

This RTI Supplemental License ("Supplemental License") is for the accompanying RTI container image ("Container Image"). Real-Time Innovations, Inc. ("RTI") licenses the Container Image to you only if you agree to comply with all of the terms and conditions of this Supplemental License.

The Container Image may only be used with a validly licensed copy of RTI Connext software (the "Host Software") licensed from RTI (the agreement pursuant to which you licensed the Host Software is the "Host License Agreement").

You may not use the Container Image if you do not have a current Host License Agreement. Certain restrictions and additional terms may apply, which are described herein. If any terms or conditions in this Supplemental License conflict with the Host License Agreement, then this Supplemental License shall govern solely with respect to the Container Image. BY ACCEPTING THIS SUPPLEMENTAL LICENSE OR USING THE CONTAINER IMAGE, YOU AGREE TO ALL OF THE TERMS AND CONDITIONS IN THIS SUPPLEMENTAL LICENSE ON BEHALF OF YOURSELF AND THE ENTITY THAT LICENSED THE HOST SOFTWARE UNDER THE HOST LICENSE AGREEMENT. IF YOU DO NOT AGREE WITH THE TERMS AND CONDITIONS OF THIS SUPPLEMENTAL LICENSE, OR YOU DO NOT HAVE THE AUTHORITY TO BIND THE ENTITY THAT LICENSED THE HOST SOFTWARE UNDER THE HOST LICENSE AGREEMENT TO THIS SUPPLEMENTAL LICENSE, YOU MAY NOT USE THE CONTAINER IMAGE.

Host License Agreement. The Host License Agreement applies to your use of the Container Image and any application you create using, or in which you incorporate, the Container Image.

Use Rights. The Container Image may be used only in connection with configuring, testing, and using the Host Software. Notwithstanding RTI’s provision, and your use, of the Container Image, you are solely responsible for, and bear the entire risk of: (a) configuring the Host Software for your application, and (b) the performance or non-performance of your application. Updates to the Host Software may not update the Container Image. RTI is not obligated to provide any updates or support for the Container Image.

Restrictions. You may not remove this Supplemental License document file from the Container Image. You may not reverse engineer, decompile, or disassemble the Container Image, or attempt to do so, except and only to the extent required by third party licensing terms governing the use of certain open-source components that may be included with the software. Additional restrictions in the Host License Agreement may apply.

Disclaimer of Warranties. The Container Image is provided to you on an "AS IS" basis, and RTI disclaims, to the maximum extent permitted by applicable law, all express and implied representations, warranties and guarantees, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, satisfactory quality, and non-infringement of third party rights.

Feedback. Any suggestions or ideas you provide to RTI regarding the Container Image (collectively, "Feedback"), may be used and exploited in any and every way by RTI (including without limitation, by granting sublicenses), on a non-exclusive, perpetual, irrevocable, transferable, and worldwide basis, without any compensation, without any obligation to report on such use, and without any other restriction or obligation to you.

Limitation of Liability. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL RTI BE LIABLE TO YOU FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, EXEMPLARY OR PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR FOR LOST PROFITS, LOST DATA, LOST REPUTATION, OR COST OF COVER, REGARDLESS OF THE FORM OF ACTION WHETHER IN CONTRACT, TORT (INCLUDING WITHOUT LIMITATION, NEGLIGENCE), STRICT PRODUCT LIABILITY OR OTHERWISE, WHETHER ARISING OUT OF OR RELATING TO THE USE OR INABILITY TO USE THE CONTAINER IMAGE, EVEN IF RTI HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

OSS. Certain items of independent, third-party code may be included within the software in the Container Image that are subject to the GNU General Public License ("GPL") or other open source licenses (such third-party code collectively, "Open Source Software" or "OSS"). Such Open Source Software is licensed under the terms and conditions of the license that accompanies such Open Source Software (the "OSS Terms"). Nothing herein or in the Host License Agreement limits your rights under, or grants you rights that supersede, the OSS Terms applicable to the corresponding Open Source Software. In particular, nothing herein restricts your right to copy, modify, and distribute such Open Source Software that is subject to the terms of the GPL. The OSS Terms and OSS required notices are provided in the License⁠ section of this document. By accepting the Supplemental License, you are also accepting the OSS Terms for the corresponding Open Source Software. If you do not agree to any provision of the OSS Terms for the corresponding Open Source Software, you should not download or use this Container Image.

General. This Supplemental License constitutes the entire agreement between the parties pertaining to the subject matter hereof, and supersedes any and all written or oral agreements previously existing between the parties with respect to the subject matter hereof. Any additional or different terms in any purchase order from You are deemed material and expressly rejected by RTI. You agree that this Agreement will not be construed against RTI by virtue of having drafted them.