[otel container]: Create otel container for HFT by Janetxxx · Pull Request #23666 · sonic-net/sonic-buildimage

Janetxxx · 2025-08-11T12:36:41Z

Why I did it

This PR adds OpenTelemetry (OTEL) collector support to the system by introducing a new docker-sonic-otel container. The OTEL collector enables telemetry data collection and export for High Frequency Telemetry (HFT) support.

Work item tracking

Microsoft ADO (number only):

How I did it

Introduces new docker-sonic-otel container with configuration and build files
Updates service health checker to handle OTEL container conditionally based on image availability
Adds build system variables and configuration for conditional OTEL

How to verify it

Run sudo config feature state otel enabled to enable the otel collector feature, and tested it on KVM T0 testbed (ceos neighbor deployed).

Checked otel container:

admin@vlab-01:~$ docker ps -a | grep otel
400fca26a6c4   docker-sonic-otel:latest             "/usr/local/bin/supe…"   21 hours ago   Up 21 hours             otel

root@vlab-01:/# supervisorctl status
dependent-startup                EXITED    Dec 04 03:07 AM
otel                             RUNNING   pid 219, uptime 0:02:31
rsyslogd                         RUNNING   pid 17, uptime 1:42:34
start                            EXITED    Dec 04 03:05 AM
supervisor-proc-exit-listener    RUNNING   pid 8, uptime 1:42:35

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

mssonicbld · 2025-08-11T12:36:48Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-08-11T12:37:00Z

Azure Pipelines successfully started running 1 pipeline(s).

dockers/docker-sonic-otel/Dockerfile.j2

mssonicbld · 2025-09-15T04:58:14Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-15T04:58:26Z

Azure Pipelines successfully started running 1 pipeline(s).

linux-foundation-easycla · 2025-11-03T06:29:55Z

The committers listed above are authorized under a signed CLA.

✅ login: kperumalbfn / name: Kumaresh Perumal (ad2e202)

mssonicbld · 2025-11-03T06:29:57Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-03T06:30:09Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-04T00:19:59Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-04T00:20:11Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR adds OpenTelemetry (OTEL) collector support to the system by introducing a new docker-sonic-otel container. The OTEL collector enables telemetry data collection and export for High Fidelity Telemetry (HFT) support.

Introduces new docker-sonic-otel container with configuration and build files
Updates service health checker to handle OTEL container conditionally based on image availability
Adds build system variables and configuration for conditional OTEL inclusion

Reviewed Changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/system-health/health_checker/service_checker.py	Adds conditional check to skip OTEL container health check when image is not present
slave.mk	Adds OTEL build variables and removes trailing whitespace
rules/docker-otel.mk	Defines build rules and configuration for the OTEL docker container
rules/docker-otel.dep	Defines build dependencies for the OTEL docker container
rules/config	Enables OTEL by default with INCLUDE_SYSTEM_OTEL=y
files/build_templates/init_cfg.json.j2	Registers OTEL as a feature in initial config
dockers/docker-sonic-otel/supervisord.conf	Configures supervisord for OTEL container processes
dockers/docker-sonic-otel/start.sh	Container startup script
dockers/docker-sonic-otel/otel_vars.j2	OTEL collector configuration template
dockers/docker-sonic-otel/otel.sh	Script to generate config and start OTEL collector
dockers/docker-sonic-otel/critical_processes	Defines critical processes for OTEL container
dockers/docker-sonic-otel/base_image_files/monit_otel	Monit configuration for OTEL container memory monitoring
dockers/docker-sonic-otel/Dockerfile.j2	Dockerfile template for building OTEL container image
Makefile.work	Adds OTEL build variable to build instruction

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Makefile.work

rules/config

dockers/docker-sonic-otel/otel_vars.j2

dockers/docker-sonic-otel/Dockerfile.j2

dockers/docker-sonic-otel/supervisord.conf

mssonicbld · 2025-11-12T06:33:48Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-12T06:34:01Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-11-12T23:19:10Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-11-12T23:19:24Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dockers/docker-sonic-otel/otel.sh

dockers/docker-sonic-otel/Dockerfile.j2

Makefile.work

mssonicbld · 2026-01-08T00:19:15Z

/AzurePipelines run Azure.sonic-buildimage

azure-pipelines · 2026-01-08T00:19:27Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-08T01:32:25Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-08T01:32:38Z

Azure Pipelines successfully started running 1 pipeline(s).

kperumalbfn · 2026-01-08T15:53:20Z

@Janetxxx could you check the copilot comments and resolve them.

mssonicbld · 2026-01-08T15:54:12Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-08T15:54:25Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mssonicbld · 2026-01-09T09:57:03Z

/azp run Azure.sonic-buildimage

Janetxxx · 2026-01-09T09:57:05Z

@kperumalbfn I've checked Copilot's comments and marked them as resolved. Thanks.

azure-pipelines · 2026-01-09T09:57:16Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-09T16:45:03Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-09T16:45:16Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 8 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

dockers/docker-sonic-otel/otel.sh

rules/docker-otel.mk

rules/docker-otel.dep

files/image_config/rsyslog/rsyslog.d/00-sonic.conf.j2

dockers/docker-sonic-otel/Dockerfile.j2

dockers/docker-sonic-otel/critical_processes

files/image_config/otel/otel_config.yml

dockers/docker-sonic-otel/supervisord.conf

mssonicbld · 2026-01-09T22:28:08Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-01-09T22:28:20Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2026-01-22T05:44:33Z

Cherry-pick PR to 202511: #25155

r12f · 2026-01-26T03:40:10Z

Pick to 202412: Azure/sonic-buildimage-msft#1930

mssonicbld · 2026-01-26T22:14:04Z

@Janetxxx cherry pick PR didn't pass PR checker. Please check!!!
#25155

mssonicbld · 2026-01-26T23:12:43Z

@Janetxxx cherry pick PR didn't pass PR checker. Please check!!!
#25155

mssonicbld · 2026-01-27T23:12:57Z

@Janetxxx cherry pick PR didn't pass PR checker. Please check!!!
#25155

Janetxxx requested review from lguohan, qiluo-msft and xumia as code owners August 11, 2025 12:36

Janetxxx marked this pull request as draft August 11, 2025 12:38

r12f reviewed Aug 14, 2025

View reviewed changes

dockers/docker-sonic-otel/Dockerfile.j2 Show resolved Hide resolved

Janetxxx removed request for lguohan, qiluo-msft and xumia August 14, 2025 02:10

Janetxxx force-pushed the dev/jc/otel-container branch from 6bef7de to e991299 Compare November 4, 2025 00:19

Janetxxx marked this pull request as ready for review November 4, 2025 00:22

Copilot AI review requested due to automatic review settings November 4, 2025 00:22

Copilot AI reviewed Nov 4, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings November 12, 2025 23:19

Janetxxx force-pushed the dev/jc/otel-container branch from 1d47ea8 to e991299 Compare November 12, 2025 23:19

Copilot started reviewing on behalf of Janetxxx November 12, 2025 23:19 View session

Copilot finished reviewing on behalf of Janetxxx November 12, 2025 23:21

Copilot AI reviewed Nov 12, 2025

View reviewed changes

dockers/docker-sonic-otel/otel.sh Outdated Show resolved Hide resolved

dockers/docker-sonic-otel/Dockerfile.j2 Outdated Show resolved Hide resolved

Makefile.work Outdated Show resolved Hide resolved

Merge branch 'master' into dev/jc/otel-container

7215a1b

r12f approved these changes Jan 8, 2026

View reviewed changes

Merge branch 'master' into dev/jc/otel-container

33d3d74

Copilot AI reviewed Jan 8, 2026

View reviewed changes

Merge branch 'master' into dev/jc/otel-container

37d35d9

Merge branch 'master' into dev/jc/otel-container

b705491

Copilot AI reviewed Jan 9, 2026

View reviewed changes

kperumalbfn approved these changes Jan 9, 2026

View reviewed changes

Merge branch 'master' into dev/jc/otel-container

ad2e202

Janetxxx mentioned this pull request Jan 13, 2026

[otel container]: Create otel container for HFT (#23666) Azure/sonic-buildimage-msft#1930

Merged

9 tasks

mssonicbld mentioned this pull request Jan 22, 2026

[action] [PR:23666] [otel container]: Create otel container for HFT #25155

Merged

9 tasks

Conversation

Janetxxx commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why I did it

Work item tracking

How I did it

How to verify it

Which release branch to backport (provide reason below if selected)

Tested branch (Please provide the tested image version)

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Uh oh!

mssonicbld commented Aug 11, 2025

Uh oh!

azure-pipelines bot commented Aug 11, 2025

Uh oh!

Uh oh!

mssonicbld commented Sep 15, 2025

Uh oh!

azure-pipelines bot commented Sep 15, 2025

Uh oh!

linux-foundation-easycla bot commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mssonicbld commented Nov 3, 2025

Uh oh!

azure-pipelines bot commented Nov 3, 2025

Uh oh!

mssonicbld commented Nov 4, 2025

Uh oh!

azure-pipelines bot commented Nov 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Nov 12, 2025

Uh oh!

azure-pipelines bot commented Nov 12, 2025

Uh oh!

mssonicbld commented Nov 12, 2025

Uh oh!

azure-pipelines bot commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Jan 8, 2026

Uh oh!

azure-pipelines bot commented Jan 8, 2026

Uh oh!

mssonicbld commented Jan 8, 2026

Uh oh!

azure-pipelines bot commented Jan 8, 2026

Uh oh!

kperumalbfn commented Jan 8, 2026

Uh oh!

mssonicbld commented Jan 8, 2026

Uh oh!

azure-pipelines bot commented Jan 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

mssonicbld commented Jan 9, 2026

Uh oh!

Janetxxx commented Jan 9, 2026

Uh oh!

Janetxxx commented Aug 11, 2025 •

edited

Loading

linux-foundation-easycla bot commented Nov 3, 2025 •

edited

Loading