Document Embedded Cluster telemetry sources in instance data docs#4178
Conversation
The instance data page only described KOTS and SDK as telemetry sources, with no mention of the EC daemon's lifecycle events or how EC v3 differs from v2 (no KOTS). Also adds a telemetry section to the EC v3 overview and clarifies the kURL caching limitation doesn't apply to EC. sc-136951 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| #### Embedded Cluster installations | ||
|
|
||
| For Embedded Cluster installations (v2 and v3), there is an additional source of telemetry beyond the SDK and KOTS: the Embedded Cluster daemon running on the host sends lifecycle event data directly to the Vendor Portal. This includes events for installations, upgrades, node joins, and node status changes. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| ### From the Embedded Cluster daemon | ||
|
|
||
| For Embedded Cluster installations (v2 and v3), the EC daemon sends lifecycle events to the Vendor Portal as they occur. Unlike the periodic reporting from the SDK and KOTS, these events are sent in real time when an installation, upgrade, or node join starts, succeeds, or fails. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| ### From the Embedded Cluster daemon | ||
|
|
||
| For Embedded Cluster installations (v2 and v3), the EC daemon sends lifecycle events to the Vendor Portal as they occur. Unlike the periodic reporting from the SDK and KOTS, these events are sent in real time when an installation, upgrade, or node join starts, succeeds, or fails. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are sent').
|
|
||
| Which components report telemetry depends on the Embedded Cluster version: | ||
|
|
||
| * **Embedded Cluster v2**: The SDK, KOTS, and the EC daemon all report data. The SDK and KOTS send periodic instance data (version, status, cluster info), while the daemon sends lifecycle events. |
There was a problem hiding this comment.
there is no daemon in EC V2. i guess you mean the EC operator?
sgalsaleh
left a comment
There was a problem hiding this comment.
LGTM. just the minor comment about the term "daemon" vs "operator". I believe we document it as "operator" in EC V2 docs.
Preview
Summary
Related: sc-136951
Test plan
/vendor/instance-insights-event-data) resolves correctly####subheading under "Online instances"🤖 Generated with Claude Code