[Feat] Service status updates with polling & vito agent by RichardAnderson · Pull Request #1200 · vitodeploy/vito

RichardAnderson · 2026-07-14T20:26:11Z

Service status updates are a cheap addition (very minor overhead) that can be added to the metrics:get polling and vito-agent stats collection process. This PR ensures full backwards compatibility with the current vito agent.

Companion PR: vitodeploy/agent#4

You can test by updating app/Services/Monitoring/VitoAgent/VitoAgent.php with the following;

class VitoAgent extends AbstractService
{
    const string TAGS_URL = 'https://api.github.com/repos/RichardAnderson/vito-agent/tags';

    const string DOWNLOAD_URL = 'https://github.com/RichardAnderson/vito-agent/releases/download/%s';

Summary by CodeRabbit

Summary of changes

New Features
- Service statuses can now be synchronised from submitted service readings, using confirmed transitions to minimise restart flapping.
- Service status changes emit real-time updates to the event system and socket notifications.
- Vito Agent configuration is automatically updated after successful service installs and removals.
Bug Fixes
- Service secrets are redacted from API responses.
- SSH file updates now clean up temporary remote files.
Chores
- The scheduled metrics job is now prevented from overlapping runs.

coderabbitai · 2026-07-14T20:26:19Z

📝 Walkthrough

Walkthrough

Changes

The PR adds service-status synchronisation from agent metrics and systemd polling, cached transition confirmation, status events, and Vito Agent configuration updates after successful lifecycle operations. It also adds scheduling, API, SSH, and WebSocket safeguards.

Monitoring synchronisation

Layer / File(s)	Summary
Service status synchronisation `app/Actions/Service/`, `app/Actions/Monitoring/StoreAgentMetric.php`, `app/Events/`, `tests/Feature/API/AgentControllerTest.php`	Agent service reports are validated, synchronised with cached confirmation, persisted, and emitted through domain and socket events.
Systemd status polling `app/SSH/OS/Systemd.php`, `app/Actions/Service/CheckServiceStatuses.php`, `app/Console/Commands/GetMetricsCommand.php`, `app/Console/Kernel.php`, `tests/Unit/Actions/Service/CheckServiceStatusesTest.php`, `tests/Unit/Commands/GetMetricsCommandTest.php`	Metric collection polls managed units, validates output, synchronises states, logs failures, and prevents overlapping runs.
Vito Agent configuration lifecycle `app/Services/Monitoring/VitoAgent/VitoAgent.php`, `app/Jobs/Service/*`, `tests/Unit/Actions/Service/{Install,Uninstall}Test.php`, `tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php`, `app/Helpers/SSH.php`	Successful service lifecycle operations queue configuration updates, while Vito Agent writes managed units and restarts its systemd service.
API and WebSocket safeguards `app/Http/Controllers/API/AgentController.php`, `app/Http/Resources/ServiceResource.php`, `app/Models/Service.php`, `app/Http/Controllers/{Console,Events}Controller.php`, `tests/Feature/API/ServicesTest.php`	Handler-less requests are guarded, service secrets are omitted from resources, nullable metadata is documented, and configured WebSocket URLs take precedence over local overrides.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant MetricsCommand
  participant CheckServiceStatuses
  participant Systemd
  participant SyncServiceStatus
  participant ServiceDatabase
  MetricsCommand->>CheckServiceStatuses: check server services
  CheckServiceStatuses->>Systemd: request active states
  Systemd-->>CheckServiceStatuses: ordered unit states
  CheckServiceStatuses->>SyncServiceStatus: synchronise each service
  SyncServiceStatus->>ServiceDatabase: conditionally update status

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and clearly reflects the main change: service status updates added to polling and Vito agent flows.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

Copilot

Pull request overview

Adds end-to-end “service status” synchronization across both the periodic metrics:get polling path and the vito-agent metrics ingestion path, while keeping the existing agent payload format backwards-compatible and improving secret handling.

Changes:

Introduces service-status polling via systemctl is-active during metrics:get, plus status sync + event/broadcast plumbing.
Adds vito-agent config generation/update (including service unit list) and triggers config refresh after service install/uninstall.
Redacts type_data.secret from ServiceResource responses and hardens agent secret lookup when a service has no handler.

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php	Adds coverage for agent config updates and restart behavior.
tests/Unit/Commands/GetMetricsCommandTest.php	Adds coverage ensuring `metrics:get` checks and updates service statuses + dispatches events.
tests/Unit/Actions/Service/UninstallTest.php	Asserts uninstall dispatches (or does not dispatch) agent config update job appropriately.
tests/Unit/Actions/Service/InstallTest.php	Asserts install dispatch behavior and verifies agent config contents on agent install.
tests/Unit/Actions/Service/CheckServiceStatusesTest.php	Adds comprehensive coverage for polling-based status sync and flap/confirmation behavior.
tests/Feature/API/ServicesTest.php	Verifies API service listing redacts secrets from `type_data`.
tests/Feature/API/AgentControllerTest.php	Adds coverage for agent-reported service statuses and validation/ignore rules.
app/SSH/OS/Systemd.php	Adds batched `is-active` helper to fetch states for multiple units efficiently.
app/Services/Monitoring/VitoAgent/VitoAgent.php	Writes/updates agent config (with managed service units) and restarts agent.
app/Models/Service.php	Updates phpdoc to reflect nullable `type_data`.
app/Jobs/Service/UpdateVitoAgentConfigJob.php	New job to regenerate agent config when managed services change.
app/Jobs/Service/UninstallJob.php	Dispatches agent config update after successful uninstall.
app/Jobs/Service/InstallJob.php	Dispatches agent config update after successful install.
app/Http/Resources/ServiceResource.php	Redacts `secret` from `type_data` in API responses.
app/Http/Controllers/API/AgentController.php	Avoids calling handler when a service has no handler.
app/Helpers/SSH.php	Cleans up temporary upload file after successful remote write.
app/Events/ServiceStatusChanged.php	New event emitted when a service status changes.
app/Console/Kernel.php	Prevents overlapping `metrics:get` runs via scheduler lock.
app/Console/Commands/GetMetricsCommand.php	Invokes service-status polling as part of metrics collection.
app/Actions/Service/SyncServiceStatus.php	Centralizes “state -> status” mapping, confirmation logic, and broadcasting/event emission.
app/Actions/Service/CheckServiceStatuses.php	Polls checkable services and syncs status updates based on systemd states.
app/Actions/Monitoring/StoreAgentMetric.php	Accepts optional `services` payload from agent and syncs service statuses accordingly.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@app/Services/Monitoring/VitoAgent/VitoAgent.php`:
- Around line 112-132: Update json_encode in VitoAgent::updateConfig to include
JSON_THROW_ON_ERROR alongside the existing JSON_PRETTY_PRINT and
JSON_UNESCAPED_SLASHES flags, ensuring encoding failures throw before the
configuration file is written.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 0ac92c4c-422a-4039-b33d-a22b6fea5acc

📥 Commits

Reviewing files that changed from the base of the PR and between 252ac4c and 4f11bbc.

📒 Files selected for processing (22)

app/Actions/Monitoring/StoreAgentMetric.php
app/Actions/Service/CheckServiceStatuses.php
app/Actions/Service/SyncServiceStatus.php
app/Console/Commands/GetMetricsCommand.php
app/Console/Kernel.php
app/Events/ServiceStatusChanged.php
app/Helpers/SSH.php
app/Http/Controllers/API/AgentController.php
app/Http/Resources/ServiceResource.php
app/Jobs/Service/InstallJob.php
app/Jobs/Service/UninstallJob.php
app/Jobs/Service/UpdateVitoAgentConfigJob.php
app/Models/Service.php
app/SSH/OS/Systemd.php
app/Services/Monitoring/VitoAgent/VitoAgent.php
tests/Feature/API/AgentControllerTest.php
tests/Feature/API/ServicesTest.php
tests/Unit/Actions/Service/CheckServiceStatusesTest.php
tests/Unit/Actions/Service/InstallTest.php
tests/Unit/Actions/Service/UninstallTest.php
tests/Unit/Commands/GetMetricsCommandTest.php
tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@app/Jobs/Service/UpdateVitoAgentConfigJob.php`:
- Around line 25-45: Remove the try/catch and warning log from dispatchFor in
app/Jobs/Service/UpdateVitoAgentConfigJob.php around lines 25-45 so provider and
service Throwables bubble up unchanged; retain the existing guard checks and
dispatch behavior. Delete the exception-swallowing test in
tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php around lines 68-87 because it
asserts behavior that is no longer valid.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f49b9e94-559a-4154-8095-af37e998f28e

📥 Commits

Reviewing files that changed from the base of the PR and between 4f11bbc and 3b27221.

📒 Files selected for processing (5)

app/Actions/Monitoring/StoreAgentMetric.php
app/Jobs/Service/UpdateVitoAgentConfigJob.php
app/Services/Monitoring/VitoAgent/VitoAgent.php
tests/Feature/API/AgentControllerTest.php
tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

app/Services/Monitoring/VitoAgent/VitoAgent.php (1)
104-104: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Update the PHPDoc to reflect the newly thrown exception.

Since the $this->updateConfig() call here can throw a JsonException, consider updating the @throws annotation in the install() method's PHPDoc (around line 73) to include \JsonException. As per the path instructions, @throws annotations must accurately reflect reality to prevent hiding bugs.
    /**
     * `@throws` SSHError
     * `@throws` ServiceInstallationFailed
     * `@throws` ConnectionException
     * `@throws` JsonException
     */
    public function install(): void
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@app/Services/Monitoring/VitoAgent/VitoAgent.php` at line 104, Update the
PHPDoc for VitoAgent::install() to include \JsonException in its `@throws`
annotations, reflecting the exception propagated by updateConfig().
Source: Path instructions

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@app/Services/Monitoring/VitoAgent/VitoAgent.php`:
- Line 104: Update the PHPDoc for VitoAgent::install() to include \JsonException
in its `@throws` annotations, reflecting the exception propagated by
updateConfig().

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d865cec5-390a-429d-8430-0edf88ef8983

📥 Commits

Reviewing files that changed from the base of the PR and between 3b27221 and caace4b.

📒 Files selected for processing (6)

app/Actions/Service/CheckServiceStatuses.php
app/Http/Controllers/ConsoleController.php
app/Http/Controllers/EventsController.php
app/Services/Monitoring/VitoAgent/VitoAgent.php
tests/Unit/Actions/Service/CheckServiceStatusesTest.php
tests/Unit/Jobs/UpdateVitoAgentConfigJobTest.php

wip

5e88f8c

RichardAnderson added 3 commits July 14, 2026 22:41

vito-agent rework

5a4f5ed

fixes

bd46395

further fixes, including resolving a race condition on failure

4f11bbc

RichardAnderson requested a review from Copilot July 14, 2026 22:42

RichardAnderson mentioned this pull request Jul 14, 2026

[Feat] Service status on vito agent vitodeploy/agent#4

Open

Copilot started reviewing on behalf of RichardAnderson July 14, 2026 22:42 View session

Copilot AI reviewed Jul 14, 2026

View reviewed changes

Comment thread app/Actions/Monitoring/StoreAgentMetric.php Outdated

coderabbitai Bot reviewed Jul 14, 2026

View reviewed changes

Comment thread app/Services/Monitoring/VitoAgent/VitoAgent.php

code review fixes

3b27221

RichardAnderson marked this pull request as ready for review July 14, 2026 23:14

fixes

c31b8dc

coderabbitai Bot reviewed Jul 14, 2026

View reviewed changes

Comment thread app/Jobs/Service/UpdateVitoAgentConfigJob.php

fixes after manual testing

caace4b

coderabbitai Bot reviewed Jul 14, 2026

View reviewed changes

RichardAnderson requested a review from saeedvaziry July 14, 2026 23:52

saeedvaziry approved these changes Jul 14, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Feat] Service status updates with polling & vito agent#1200

[Feat] Service status updates with polling & vito agent#1200
RichardAnderson wants to merge 7 commits into
vitodeploy:4.xfrom
RichardAnderson:feat/service-status

RichardAnderson commented Jul 14, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 14, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

RichardAnderson commented Jul 14, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Summary of changes

Uh oh!

coderabbitai Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RichardAnderson commented Jul 14, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 14, 2026 •

edited

Loading