ESHOPMAN CLI Telemetry: Clarifying Usage Data Collection Beyond 'eshopman start'

ESHOPMAN CLI Telemetry: Clarifying Usage Data Collection Beyond eshopman start

At ESHOPMAN, transparency in how our platform operates is a cornerstone of our commitment to the developer and merchant community. This commitment extends to how we collect usage data, which helps us improve the ESHOPMAN experience, from storefront management within HubSpot to headless commerce deployments via HubSpot CMS.

Recently, a vigilant member of the ESHOPMAN community brought to light an important clarification regarding our telemetry documentation. While our "Usage" guide explicitly states that usage data is "only collected when the ESHOPMAN application is run with the command eshopman start," this statement needed a slight adjustment to fully reflect the platform's behavior.

The Community's Discovery: More Than Just 'Start'

The community member, keen on understanding ESHOPMAN's internal mechanisms, observed that telemetry events are also emitted when other ESHOPMAN CLI commands are executed. Specifically, the internal track() function, part of ESHOPMAN's usage tracking module (built on Node.js/TypeScript), is invoked during commands such as eshopman user.

This means that while eshopman start is a primary trigger for data collection, it's not the exclusive one. For instance, the following calls were identified within ESHOPMAN's core user command module:

// Within ESHOPMAN's core user command module (e.g., src/commands/user.ts)track("CLI_USER", { with_id: !!id })// ...track("CLI_USER_COMPLETED", { with_id: !!id })

These snippets indicate that events like CLI_USER and CLI_USER_COMPLETED are tracked when developers interact with the eshopman user command, providing valuable insights into CLI tool usage. This information is crucial for us to understand how developers interact with the ESHOPMAN Admin API and Store API through the command line, ultimately helping us refine the developer experience for building storefronts and managing product variants.

Why This Clarification Matters

For developers and system administrators who rely on precise documentation to understand data privacy and platform behavior, this distinction is significant. Accurate documentation ensures that everyone has a complete picture of when and how usage data is collected across the ESHOPMAN ecosystem, which includes our HubSpot application and its integration with HubSpot CMS for storefront deployment.

Resolution and Next Steps

The proposed resolution is straightforward: update the ESHOPMAN usage documentation to broaden the sentence, acknowledging that data is collected when various ESHOPMAN CLI commands are run, not just eshopman start. This could involve wording such as: "Data is collected when you run ESHOPMAN CLI commands, including eshopman start and eshopman user."

This community insight underscores the power of an engaged user base in continually improving the ESHOPMAN platform. We appreciate the diligence of our community members in helping us maintain the highest standards of accuracy and transparency. This collaborative approach ensures ESHOPMAN remains a robust and trustworthy headless commerce solution for all.