chore: onboard @carbon/vue to IBM Telemetry 🚀

carbon-design-system / carbon-components-vue

Vue implementation of the Carbon Design System

http://vue.carbondesignsystem.com

Apache License 2.0

608 stars 180 forks source link

chore: onboard @carbon/vue to IBM Telemetry 🚀 #1572

Closed francinelucca closed 9 months ago

francinelucca commented 9 months ago

Description

Adds config file and dependency necessary to start tracking telemetry data via IBM Telemetry

Changelog

New

Adds @ibm/telemetry-js dependency
Adds telemetry.yml config file
- This file was generated using IBM Telemetry automated config generator
Adds readme telemetry disclosure
Include telemetry.yml in package.json files config

Changed

Updates postinstall script to use IBM telemetry command

Review

Please look through package.json config file and ensure all necessary modifications have been made so that the "telemetry.yml" config file is included in the release version of this package.

PLEASE NOTE: In order for IBM Telemetry to start collecting data for this project, a new build must be published including these changes.

davidnixon commented 9 months ago

@francinelucca Can you add some note here about other IBM packages that are including this? I assume this a initiative from the Carbon team? So maybe you can a add a link here to the an internal/external statement about this initiative. Also would be great to know how (or if) the data gets shared back to this team.

mattrosno commented 9 months ago

@francinelucca Can you add some note here about other IBM packages that are including this? I assume this a initiative from the Carbon team? So maybe you can a add a link here to the an internal/external statement about this initiative. Also would be great to know how (or if) the data gets shared back to this team.

Hi @davidnixon - correct that IBM Telemetry is being built by the Carbon team. It's part of a Project MaX initiative and as such, will get used for non-Carbon inner- and open- source packages as well.

All Carbon npm packages are getting instrumented. We're currently working on the reporting solution so at minimum, IBM employees maintaining the instrumented packages will be able to see the usage metrics. Happy to chat if talking offline would help!

francinelucca commented 9 months ago

@davidnixon let us know if further info is needed here, otherwise we should be good for re-review!