restapi-sidecar support critical process crash to exit supervisord, and some bugfixes #25303

qiluo-msft · 2026-02-02T08:01:20Z

Why I did it

(merge after #25230)
Enhance docker-restapi-sidecar:

support critical process crash to exit supervisord
missing sonic_py_common dependency issue
fix supervisor-proc-exit-listener-rs args
Fix: docker-restapi-sidecar support rsyslog relay from inside container to host
Fix: supervisor-proc-exit-listener-rs: listen on right events

Work item tracking

Microsoft ADO (number only):

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)

This reverts commit 18d1dbd.

… issue

to host Fix: supervisor-proc-exit-listener-rs: listen on right events

mssonicbld · 2026-02-02T08:01:28Z

/azp run Azure.sonic-buildimage

azure-pipelines · 2026-02-02T08:01:40Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull request overview

This PR enhances the docker-restapi-sidecar container with several critical improvements and bugfixes. The main focus is on supporting critical process crash detection to exit supervisord, adding missing sonic_py_common dependency, and implementing per-branch file synchronization to support multiple SONiC release branches (202311, 202405, 202411, 202505, 202511).

Changes:

Added critical process monitoring with supervisor-proc-exit-listener-rs to exit supervisord when systemd_stub crashes
Implemented runtime branch detection from SONiC version to select appropriate per-branch files
Fixed missing SONIC_PY_COMMON_PY3 dependency in build rules
Added rsyslog configuration to relay logs from container to host

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 26 comments.

Show a summary per file

File	Description
rules/docker-restapi-sidecar.mk	Added SONIC_PY_COMMON_PY3 wheel dependency
dockers/docker-restapi-sidecar/systemd_stub.py	Added _get_branch_name() function for runtime branch detection and per-branch file selection
dockers/docker-restapi-sidecar/systemd_scripts/v1/restapi.sh_*	Five branch-specific startup scripts with per-branch differences
dockers/docker-restapi-sidecar/systemd_scripts/restapi.service_*	Five branch-specific systemd service files
dockers/docker-restapi-sidecar/systemd_scripts/container_checker_*	Five branch-specific container checker scripts
dockers/docker-restapi-sidecar/supervisord.conf	Changed systemd_stub autorestart to false, added supervisor-proc-exit-listener
dockers/docker-restapi-sidecar/critical_processes	New file marking systemd_stub as critical
dockers/docker-restapi-sidecar/etc/rsyslog.conf	New rsyslog configuration for log relay to host
dockers/docker-restapi-sidecar/etc/rsyslog.d/supervisor.conf	New rsyslog configuration for supervisor logs
dockers/docker-restapi-sidecar/Dockerfile.j2	Updated to install dependencies and copy rsyslog configs
dockers/docker-restapi-sidecar/cli-plugin-tests/test_systemd_stub.py	Added comprehensive tests for branch detection

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

Copilot · 2026-02-02T08:08:16Z

dockers/docker-restapi-sidecar/systemd_scripts/v1/restapi.sh_202505

+        --net=$NET \
+        -e RUNTIME_OWNER=local \
+        --uts=host \
+	--tmpfs /var/log/supervisor:rw \


The line starting with --tmpfs /var/log/supervisor:rw \ uses a tab character for indentation instead of spaces. This is inconsistent with the rest of the file which uses spaces for indentation. For consistency and to avoid potential issues with shell scripts, spaces should be used instead of tabs.

Suggested change

--tmpfs /var/log/supervisor:rw \

--tmpfs /var/log/supervisor:rw \

Copilot · 2026-02-02T08:08:16Z

dockers/docker-restapi-sidecar/systemd_scripts/v1/restapi.sh_202411

+        --net=$NET \
+        -e RUNTIME_OWNER=local \
+        --uts=host \
+	--tmpfs /var/log/supervisor:rw \


The line starting with --tmpfs /var/log/supervisor:rw \ uses a tab character for indentation instead of spaces. This is inconsistent with the rest of the file which uses spaces for indentation. For consistency and to avoid potential issues with shell scripts, spaces should be used instead of tabs.

Suggested change

--tmpfs /var/log/supervisor:rw \

--tmpfs /var/log/supervisor:rw \

Copilot · 2026-02-02T08:08:16Z

dockers/docker-restapi-sidecar/supervisord.conf

+[eventlistener:supervisor-proc-exit-listener]
+command=/usr/bin/supervisor-proc-exit-listener-rs --container-name restapi
+events=PROCESS_STATE_EXITED,PROCESS_STATE_RUNNING
+autostart=true
+autorestart=unexpected
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0


The supervisor-proc-exit-listener eventlistener is missing the buffer_size=1024 configuration parameter. All other containers in the codebase that use supervisor-proc-exit-listener-rs include this parameter (e.g., dockers/docker-nat/supervisord.conf:20, dockers/docker-sonic-restapi/supervisord.conf:20). This parameter should be added for consistency with the rest of the codebase.

Copilot · 2026-02-02T08:08:17Z

dockers/docker-restapi-sidecar/Dockerfile.j2

 FROM $BASE

-{{ rsync_from_builder_stage() }}
+RUN --mount=type=bind,from=base,target=/changes-to-image rsync -axAX --no-D --exclude=/sys --exclude=/proc --exclude=/dev --exclude=resolv.conf /changes-to-image/ /


The rsync command is missing the --omit-dir-times flag that is present in the rsync_from_builder_stage() macro (dockers/dockerfile-macros.j2:49). While this may not cause functional issues, it's inconsistent with the macro pattern used elsewhere in the codebase. Consider using the macro or adding the flag for consistency.

Copilot · 2026-02-02T08:08:17Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202505

+def main():
+    """
+    @summary: This function will compare the difference between the current running containers
+              and the containers which were expected to run. If containers which were exepcted


Spelling error: "exepcted" should be "expected".

Suggested change

and the containers which were expected to run. If containers which were exepcted

and the containers which were expected to run. If containers which were expected

Copilot · 2026-02-02T08:08:21Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202505

+        pass
+    except docker.errors.DockerException as err:
+        print(f"Docker client error: '{err}'")
+        pass


Unnecessary 'pass' statement.

Suggested change

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

Copilot · 2026-02-02T08:08:22Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202505

+        pass
+    except docker.errors.DockerException as err:
+        print(f"Docker client error: '{err}'")
+        pass


Unnecessary 'pass' statement.

Suggested change

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

Copilot · 2026-02-02T08:08:22Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202511

+                running_containers.add(name)
+        except (docker.errors.NotFound, docker.errors.APIError) as err:
+            print("Failed to get container '{}'. Error: '{}'".format(name, err))
+            pass


Unnecessary 'pass' statement.

Copilot · 2026-02-02T08:08:22Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202511

+        pass
+    except docker.errors.DockerException as err:
+        print(f"Docker client error: '{err}'")
+        pass


Unnecessary 'pass' statement.

Suggested change

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

Copilot · 2026-02-02T08:08:22Z

dockers/docker-restapi-sidecar/systemd_scripts/container_checker_202511

+        pass
+    except docker.errors.DockerException as err:
+        print(f"Docker client error: '{err}'")
+        pass


Unnecessary 'pass' statement.

Suggested change

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

pass

except docker.errors.DockerException as err:

print(f"Docker client error: '{err}'")

qiluo-msft added 11 commits January 28, 2026 19:59

restapi-sidecar SyncItem source files should be per-branch

9fb808d

Fix unit test

5fe533a

fix ENV

18d1dbd

Remove unused import

0a9af3f

Revert "fix ENV"

e9360d5

This reverts commit 18d1dbd.

Fix env for restapi-sidecar

5af7b25

Add missing SyncItem

1f37c1e

restapi-sidecar: support critical process crash to exit supervisord

dc71060

[build] Fix docker-restapi-sidecar missing sonic_py_common dependency…

eb04eb9

… issue

fix supervisor-proc-exit-listener-rs args

c215127

Fix: docker-restapi-sidecar support rsyslog relay from inside container

a02548c

to host Fix: supervisor-proc-exit-listener-rs: listen on right events

qiluo-msft requested review from lguohan and xumia as code owners February 2, 2026 08:01

Copilot AI review requested due to automatic review settings February 2, 2026 08:01

Copilot started reviewing on behalf of qiluo-msft February 2, 2026 08:01 View session

Copilot AI reviewed Feb 2, 2026

View reviewed changes

	--tmpfs /var/log/supervisor:rw \
	--tmpfs /var/log/supervisor:rw \

	and the containers which were expected to run. If containers which were exepcted
	and the containers which were expected to run. If containers which were expected

restapi-sidecar support critical process crash to exit supervisord, and some bugfixes #25303

Are you sure you want to change the base?

restapi-sidecar support critical process crash to exit supervisord, and some bugfixes #25303

Uh oh!

Conversation

qiluo-msft commented Feb 2, 2026

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 Feb 2, 2026

Uh oh!

azure-pipelines bot commented Feb 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants