Event hub doc #335
Merged
Event hub doc #335
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
boring-cyborg
bot
added
documentation
sai-kumar-peddireddy
force-pushed
the
event-hub-doc
branch
2 times, most recently
from
461bf64 to
bc63daa
Compare
sai-kumar-peddireddy
force-pushed
the
event-hub-doc
branch
3 times, most recently
from
c370a20 to
18a0144
Compare
sai-kumar-peddireddy
requested review from
alevlasu,
bineesh-n and
cjlapao
as code owners
…adcasting for connection and disconnection
Introduces a new documentation section for the Events Hub WebSocket service in `docs/docs/devops/events-hub/`. - Add `overview.md`: Covers WebSocket protocol details, authentication (Bearer/API Key), connection limits, and available channels (`global`, `pdfm`, `orchestrator`, `health`). - Add "How-to" guides: - `how-to-monitor-VM-events.md`: Subscribing to VM lifecycle events with JSON payload examples. - `how-to-monitor-orchestrator-events.md`: Monitoring cluster-level events like host health and VM state changes. - `how-to-send-heartbeat.md`: Implementing ping/pong logic to keep connections alive. - `how-to-send-unsubscribe-requests.md` & `how-to-know-my-client-id.md`: Managing subscriptions and client identity. - Visualizations: Integrate Mermaid.js todocs: add Events Hub user guides and reference documentation
sai-kumar-peddireddy
force-pushed
the
event-hub-doc
branch
from
18a0144 to
9a579d3
Compare
cjlapao
approved these changes
Dec 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
docs: add Events Hub user guides and reference documentation
Introduces a new documentation section for the Events Hub WebSocket service in
docs/docs/devops/events-hub/.overview.md: Covers WebSocket protocol details, authentication (Bearer/API Key), connection limits, and available channels (global,pdfm,orchestrator,health).how-to-monitor-VM-events.md: Subscribing to VM lifecycle events with JSON payload examples.how-to-monitor-orchestrator-events.md: Monitoring cluster-level events like host health and VM state changes.how-to-send-heartbeat.md: Implementing ping/pong logic to keep connections alive.how-to-send-unsubscribe-requests.md&how-to-know-my-client-id.md: Managing subscriptions and client identity.Closes #332
Type of change
Checklist