Skip to content

Document Embedded Cluster telemetry sources in instance data docs#4178

Merged
AmberAlston merged 1 commit into
mainfrom
ec-v3-telemetry-docs
Jun 15, 2026
Merged

Document Embedded Cluster telemetry sources in instance data docs#4178
AmberAlston merged 1 commit into
mainfrom
ec-v3-telemetry-docs

Conversation

@AmberAlston

@AmberAlston AmberAlston commented Jun 12, 2026

Copy link
Copy Markdown
Member

Preview

Summary

  • Instance data page: Added an "Embedded Cluster installations" subsection explaining the three telemetry sources (SDK, KOTS in v2, and the EC daemon) and how they differ between v2 and v3
  • Instance data page: Added a "From the Embedded Cluster daemon" frequency subsection explaining that daemon events are sent in real time (not periodically)
  • Instance data page: Clarified the kURL caching limitation doesn't apply to EC v2 or v3
  • EC v3 overview: Added a new "Instance telemetry" section with a cross-link to the instance data page

Related: sc-136951

Test plan

  • Verify the cross-link from EC overview (/vendor/instance-insights-event-data) resolves correctly
  • Confirm EC daemon event types (install, upgrade, node join) match current implementation
  • Verify page renders correctly with the new #### subheading under "Online instances"

🤖 Generated with Claude Code

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>
@AmberAlston AmberAlston requested a review from a team as a code owner June 12, 2026 22:28
@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 02d30e9
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/6a2c882909ae8e000815d3b6
😎 Deploy Preview https://deploy-preview-4178--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 02d30e9
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/6a2c88298b4b4a0008ad25b7
😎 Deploy Preview https://deploy-preview-4178--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Jun 12, 2026

#### 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are sent').

@AmberAlston AmberAlston requested a review from sgalsaleh June 12, 2026 22:35

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is no daemon in EC V2. i guess you mean the EC operator?

@sgalsaleh sgalsaleh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. just the minor comment about the term "daemon" vs "operator". I believe we document it as "operator" in EC V2 docs.

@AmberAlston AmberAlston merged commit 3f56201 into main Jun 15, 2026
6 checks passed
@AmberAlston AmberAlston deleted the ec-v3-telemetry-docs branch June 15, 2026 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants