Add sonic-telemetry-sidecar container #23936

FengPan-Frank · 2025-09-09T11:51:06Z

Why I did it

Create sidecar container which will stub systemd script, so that telemetry container rollout-ed via k8s could be managed by systemd script with naming change, as well as container checker logic.

Work item tracking

Microsoft ADO (number only):

How I did it

Added systemd_stub service, which check sha256 for stub file regularly and overwrite
Stub into /usr/local/bin/telemetry.sh, so that systemd cmd could keep compatible, but the implementation changes into kubectl
Stub into monit container_checker, since container name will be changed when it's rollout-ed via k8s, but it will has label "raw_container_name=telemetry", thus update is in get_current_running_from_dockers
Added env IS_V1_ENABLED to control telemetry.sh operation,
IS_V1_ENABLED as true will recover system's original telemetry.sh which used as rollback case
IS_V1_ENABLED as false will used to stub k8s supported telemetry.sh and move on upgrade.

How to verify it

tested on kubesonic env as well.

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-09-09T11:51:14Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T11:51:26Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-09T12:37:51Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T12:38:04Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-09T12:45:15Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T12:45:27Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-09T12:53:29Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T12:53:42Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-09T13:03:38Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T13:03:50Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-09T14:26:45Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-09T14:26:57Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-12T07:46:09Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-12T07:46:21Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-16T14:43:22Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-16T14:43:37Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-09-18T06:09:26Z

/azp run Azure.sonic-buildimage

…sonic-buildimage into sidecar_container

mssonicbld · 2025-09-23T01:00:17Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-23T01:01:00Z

Azure Pipelines successfully started running 1 pipeline(s).

…sonic-buildimage into sidecar_container

mssonicbld · 2025-09-23T01:05:32Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-23T01:05:43Z

Azure Pipelines successfully started running 1 pipeline(s).

make1980 · 2025-09-23T01:15:40Z

dockers/docker-telemetry-sidecar/supervisord.conf

 stderr_syslog=true
 dependent_startup=true
 dependent_startup_wait_for=rsyslogd:running
+environment=IS_V1_ENABLED=%(ENV_IS_V1_ENABLED)s


do you have an extra 's' here?
#Closed

also is this really needed? I don't remember seeing this for the env var used by telemetry

without 's' Supervisor will not substitute the value, but treat it as a literal string, refer https://supervisord.org/configuration.html#environment-variables

do you mean IS_V1_ENABLED? it's used in systemd_stub.py

make1980 · 2025-09-23T01:16:15Z

dockers/docker-telemetry-sidecar/systemd_stub.py

 from sonic_py_common import logger as log
 logger = log.Logger()

+def env_bool(name: str, default: bool = False) -> bool:


env_bool -> get_bool_env_var #Closed

make1980 · 2025-09-23T01:19:10Z

rules/scripts.mk

 CONTAINER_CHECKER = container_checker
 $(CONTAINER_CHECKER)_PATH = files/image_config/monit

+TELEMETRY_SYSTEMD = telemetry_sydtemd


typo: telemetry_sydtemd #Closed

also what is telemetry_systemd?

make1980 · 2025-09-23T01:20:09Z

rules/scripts.mk

 $(CONTAINER_CHECKER)_PATH = files/image_config/monit

+TELEMETRY_SYSTEMD = telemetry_sydtemd
+$(TELEMETRY_SYSTEMD)_PATH = files/scripts


where is this variable used? #Closed

used in rules/docker-telemetry-sidecar.mk

…sonic-buildimage into sidecar_container

mssonicbld · 2025-09-23T01:34:36Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-23T01:34:47Z

Azure Pipelines successfully started running 1 pipeline(s).

…sonic-buildimage into sidecar_container

mssonicbld · 2025-09-23T01:49:56Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-23T01:50:08Z

Azure Pipelines successfully started running 1 pipeline(s).

…sonic-buildimage into sidecar_container

mssonicbld · 2025-09-23T01:56:30Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2025-09-23T01:56:42Z

Azure Pipelines successfully started running 1 pipeline(s).

make1980

mssonicbld · 2025-10-02T04:35:02Z

Cherry-pick PR to msft-202412: Azure/sonic-buildimage-msft#1686

FengPan-Frank requested a review from lguohan as a code owner September 9, 2025 11:51

FengPan-Frank force-pushed the sidecar_container branch from 5063bfa to 1b2e9b2 Compare September 9, 2025 12:37

FengPan-Frank force-pushed the sidecar_container branch from 1b2e9b2 to 6b2bdb8 Compare September 9, 2025 12:45

FengPan-Frank requested review from qiluo-msft and xumia as code owners September 9, 2025 12:45

FengPan-Frank force-pushed the sidecar_container branch from 6b2bdb8 to 9031478 Compare September 9, 2025 12:53

FengPan-Frank force-pushed the sidecar_container branch from 9031478 to 2cb43df Compare September 9, 2025 13:03

FengPan-Frank force-pushed the sidecar_container branch from 2cb43df to 42b6c11 Compare September 9, 2025 14:26

FengPan-Frank requested review from make1980 and lixiaoyuner September 11, 2025 12:17

FengPan-Frank force-pushed the sidecar_container branch from 42b6c11 to 1e1d408 Compare September 12, 2025 07:46

FengPan-Frank force-pushed the sidecar_container branch from 1e1d408 to d94ea36 Compare September 16, 2025 14:43

FengPan-Frank force-pushed the sidecar_container branch from d94ea36 to 1541439 Compare September 18, 2025 06:09

FengPan-Frank added 2 commits September 23, 2025 00:59

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

5ad59e2

…sonic-buildimage into sidecar_container

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

d105d4f

…sonic-buildimage into sidecar_container

FengPan-Frank added 2 commits September 23, 2025 01:04

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

866a6b8

…sonic-buildimage into sidecar_container

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

8daf769

…sonic-buildimage into sidecar_container

make1980 suggested changes Sep 23, 2025

View reviewed changes

FengPan-Frank added 2 commits September 23, 2025 01:34

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

8435dff

…sonic-buildimage into sidecar_container

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

f32b359

…sonic-buildimage into sidecar_container

FengPan-Frank requested a review from make1980 September 23, 2025 01:36

FengPan-Frank added 2 commits September 23, 2025 01:49

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

104aa15

…sonic-buildimage into sidecar_container

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

4b17c9e

…sonic-buildimage into sidecar_container

FengPan-Frank added 2 commits September 23, 2025 01:55

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

e386b82

…sonic-buildimage into sidecar_container

Merge branch 'sidecar_container' of https://github.com/FengPan-Frank/…

580277b

…sonic-buildimage into sidecar_container

qiluo-msft approved these changes Sep 24, 2025

View reviewed changes

make1980 approved these changes Sep 25, 2025

View reviewed changes

qiluo-msft merged commit 894df38 into sonic-net:master Sep 25, 2025
20 checks passed

FengPan-Frank added the Request for msft-202412 Branch label Oct 2, 2025

r12f added the Approved for msft-202412 Branch label Oct 2, 2025

mssonicbld mentioned this pull request Oct 2, 2025

[action] [PR:23936] Add sonic-telemetry-sidecar container Azure/sonic-buildimage-msft#1686

Open

9 tasks

mssonicbld added the Created PR to msft-202412 Branch label Oct 2, 2025

Add sonic-telemetry-sidecar container #23936

Add sonic-telemetry-sidecar container #23936

Uh oh!

Conversation

FengPan-Frank commented Sep 9, 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 Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 9, 2025

Uh oh!

azure-pipelines bot commented Sep 9, 2025

Uh oh!

mssonicbld commented Sep 12, 2025

Uh oh!

azure-pipelines bot commented Sep 12, 2025

Uh oh!

mssonicbld commented Sep 16, 2025

Uh oh!

azure-pipelines bot commented Sep 16, 2025

Uh oh!

mssonicbld commented Sep 18, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

mssonicbld commented Sep 23, 2025

Uh oh!

azure-pipelines bot commented Sep 23, 2025

Uh oh!

make1980 Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

make1980 Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

FengPan-Frank Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

FengPan-Frank Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

make1980 Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FengPan-Frank Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

make1980 Sep 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

FengPan-Frank commented Sep 9, 2025 •

edited

Loading

make1980 Sep 23, 2025 •

edited

Loading

make1980 Sep 23, 2025 •

edited

Loading

make1980 Sep 23, 2025 •

edited

Loading

make1980 Sep 23, 2025 •

edited

Loading