From 40a92da06a47c4d7ae276a3ad0ee22e528066c1f Mon Sep 17 00:00:00 2001 From: Francine Lucca <40550942+francinelucca@users.noreply.github.com> Date: Mon, 29 Jan 2024 16:43:32 -0500 Subject: [PATCH] chore: onboard other charts flavors to IBM Telemetry (#1733) * chore: onboard other charts flavors to IBM Telemetry * chore: update postinstall script and files to ibm telemtry --- packages/angular/README.md | 9 +++++++++ packages/angular/ng-package.json | 2 +- packages/angular/package.json | 4 ++-- packages/angular/telemetry.yml | 7 +++++++ packages/core/README.md | 9 +++++++++ packages/core/package.json | 7 ++++--- packages/core/telemetry.yml | 7 +++++++ packages/core/vite.config.ts | 2 +- packages/react/.storybook/main.ts | 2 +- packages/svelte/README.md | 9 +++++++++ packages/svelte/package.json | 7 ++++--- packages/svelte/telemetry.yml | 7 +++++++ packages/vue/README.md | 9 +++++++++ packages/vue/package.json | 7 ++++--- packages/vue/telemetry.yml | 7 +++++++ yarn.lock | 12 ++++++------ 16 files changed, 87 insertions(+), 20 deletions(-) create mode 100644 packages/angular/telemetry.yml create mode 100644 packages/core/telemetry.yml create mode 100644 packages/svelte/telemetry.yml create mode 100644 packages/vue/telemetry.yml diff --git a/packages/angular/README.md b/packages/angular/README.md index 6ae9d14bc4..55579e0aef 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -40,3 +40,12 @@ For instructions on using the **tabular data format**, see Customizable options (specific to chart type) can be found [here](https://charts.carbondesignsystem.com/documentation/modules/interfaces.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect metrics data. By installing this +package as a dependency you are agreeing to telemetry collection. To opt out, +see +[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). +For more information on the data being collected, please see the +[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics). \ No newline at end of file diff --git a/packages/angular/ng-package.json b/packages/angular/ng-package.json index de74f360bc..87f4182068 100644 --- a/packages/angular/ng-package.json +++ b/packages/angular/ng-package.json @@ -6,6 +6,6 @@ }, "allowedNonPeerDependencies": [ "@carbon/charts", - "@carbon/telemetry" + "@ibm/telemetry-js" ] } \ No newline at end of file diff --git a/packages/angular/package.json b/packages/angular/package.json index c14f3efbd9..d836e1c1e1 100644 --- a/packages/angular/package.json +++ b/packages/angular/package.json @@ -10,7 +10,7 @@ "type": "module", "scripts": { "ng": "ng", - "postinstall": "carbon-telemetry collect --install", + "postinstall": "ibmtelemetry --config=telemetry.yml", "file:md": "cp *.md dist", "file:styles": "cp ../core/dist/styles.* dist", "disabled:file:downlevel:dts": "downlevel-dts dist dist", @@ -35,7 +35,7 @@ }, "dependencies": { "@carbon/charts": "workspace:*", - "@carbon/telemetry": "~0.1.0", + "@ibm/telemetry-js": "1.2.0", "tslib": "^2.6.2" }, "devDependencies": { diff --git a/packages/angular/telemetry.yml b/packages/angular/telemetry.yml new file mode 100644 index 0000000000..87cb5d7733 --- /dev/null +++ b/packages/angular/telemetry.yml @@ -0,0 +1,7 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json +version: 1 +projectId: 418a02f0-ef56-4acf-81ec-481d9078cbc9 +endpoint: "https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics" +collect: + npm: + dependencies: null \ No newline at end of file diff --git a/packages/core/README.md b/packages/core/README.md index 17040cb4e5..d9ec6ed199 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -44,3 +44,12 @@ For instructions on using the **tabular data format**, see Customizable options (specific to chart type) can be found [here](https://charts.carbondesignsystem.com/documentation/modules/interfaces.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect metrics data. By installing this +package as a dependency you are agreeing to telemetry collection. To opt out, +see +[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). +For more information on the data being collected, please see the +[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics). \ No newline at end of file diff --git a/packages/core/package.json b/packages/core/package.json index 8c5851565d..f79a05a664 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -50,10 +50,11 @@ "scss", "styles.css", "styles.min.css", - "CHANGELOG.md" + "CHANGELOG.md", + "telemetry.yml" ], "scripts": { - "postinstall": "carbon-telemetry collect --install", + "postinstall": "ibmtelemetry --config=telemetry.yml", "file:css:charts": "sass scss/index.scss dist/styles.css --load-path=./node_modules --load-path=../../node_modules", "file:css:min:charts": "sass scss/index.scss dist/styles.min.css --style=compressed --load-path=./node_modules --load-path=../../node_modules", "file:css:demo": "sass scss/demos.scss dist/demo/styles.css --load-path=./node_modules --load-path=../../node_modules", @@ -80,8 +81,8 @@ }, "dependencies": { "@carbon/colors": "^11.20.1", - "@carbon/telemetry": "~0.1.0", "@carbon/utils-position": "^1.1.4", + "@ibm/telemetry-js": "1.2.0", "carbon-components": "^10.58.13", "d3": "^7.8.5", "d3-cloud": "^1.2.7", diff --git a/packages/core/telemetry.yml b/packages/core/telemetry.yml new file mode 100644 index 0000000000..9e000ce56b --- /dev/null +++ b/packages/core/telemetry.yml @@ -0,0 +1,7 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json +version: 1 +projectId: 6e01c9a5-9f9d-4eb9-8b46-3b55fbeac6e0 +endpoint: "https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics" +collect: + npm: + dependencies: null \ No newline at end of file diff --git a/packages/core/vite.config.ts b/packages/core/vite.config.ts index 3e45fb9739..4cb4dda5b3 100644 --- a/packages/core/vite.config.ts +++ b/packages/core/vite.config.ts @@ -31,7 +31,7 @@ export default defineConfig({ }, optimizeDeps: { exclude: [ - '@carbon/telemetry' // prevent Storybook issue + '@ibm/telemetry-js' // prevent Storybook issue ] }, resolve: { diff --git a/packages/react/.storybook/main.ts b/packages/react/.storybook/main.ts index 95d53ecfe8..144058a85e 100644 --- a/packages/react/.storybook/main.ts +++ b/packages/react/.storybook/main.ts @@ -39,7 +39,7 @@ const config: StorybookConfig = { // } }, optimizeDeps: { - exclude: ['@carbon/telemetry'] + exclude: ['@ibm/telemetry-js'] } }) }, diff --git a/packages/svelte/README.md b/packages/svelte/README.md index 2af9c6da4e..ea8c818571 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -268,3 +268,12 @@ type ChartProps = ComponentProps // Indexed access type to access the type of the `chart` property let chart: ChartProps['chart'] = null ``` + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect metrics data. By installing this +package as a dependency you are agreeing to telemetry collection. To opt out, +see +[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). +For more information on the data being collected, please see the +[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics). \ No newline at end of file diff --git a/packages/svelte/package.json b/packages/svelte/package.json index 7a738b878c..55f8bc962b 100644 --- a/packages/svelte/package.json +++ b/packages/svelte/package.json @@ -3,7 +3,7 @@ "version": "1.13.24", "description": "Carbon Charts component library for Svelte", "scripts": { - "postinstall": "carbon-telemetry collect --install", + "postinstall": "ibmtelemetry --config=telemetry.yml", "file:styles": "cp ../core/dist/styles.* dist", "build:package": "svelte-kit sync && svelte-package && yarn file:styles", "demo:mdx:svelte": "cp ../core/src/stories/getting-started/svelte.stories.mdx src/stories", @@ -36,14 +36,15 @@ }, "files": [ "dist", - "CHANGELOG.md" + "CHANGELOG.md", + "telemetry.yml" ], "peerDependencies": { "svelte": "^3.31.0 || ^4.0.0" }, "dependencies": { "@carbon/charts": "workspace:*", - "@carbon/telemetry": "~0.1.0" + "@ibm/telemetry-js": "1.2.0" }, "devDependencies": { "@stackblitz/sdk": "^1.9.0", diff --git a/packages/svelte/telemetry.yml b/packages/svelte/telemetry.yml new file mode 100644 index 0000000000..c8eb0887a2 --- /dev/null +++ b/packages/svelte/telemetry.yml @@ -0,0 +1,7 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json +version: 1 +projectId: f4284ccd-bed3-420a-ab93-829c790246e7 +endpoint: "https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics" +collect: + npm: + dependencies: null \ No newline at end of file diff --git a/packages/vue/README.md b/packages/vue/README.md index 697a64e9b9..b9580489bd 100644 --- a/packages/vue/README.md +++ b/packages/vue/README.md @@ -46,3 +46,12 @@ For instructions on using the **tabular data format**, see Customizable options (specific to chart type) can be found [here](https://charts.carbondesignsystem.com/documentation/modules/interfaces.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect metrics data. By installing this +package as a dependency you are agreeing to telemetry collection. To opt out, +see +[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection). +For more information on the data being collected, please see the +[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics). \ No newline at end of file diff --git a/packages/vue/package.json b/packages/vue/package.json index 8621cb3801..2c9a919eb4 100644 --- a/packages/vue/package.json +++ b/packages/vue/package.json @@ -16,10 +16,11 @@ }, "files": [ "dist", - "CHANGELOG.md" + "CHANGELOG.md", + "telemetry.yml" ], "scripts": { - "postinstall": "carbon-telemetry collect --install", + "postinstall": "ibmtelemetry --config=telemetry.yml", "file:styles": "cp ../core/dist/styles.* dist", "build:package": "vite build && yarn file:styles", "demo:mdx:vue": "cp ../core/src/stories/getting-started/vue.stories.mdx src/stories", @@ -39,7 +40,7 @@ }, "dependencies": { "@carbon/charts": "workspace:*", - "@carbon/telemetry": "~0.1.0", + "@ibm/telemetry-js": "1.2.0", "vue": "^3.4.15" }, "devDependencies": { diff --git a/packages/vue/telemetry.yml b/packages/vue/telemetry.yml new file mode 100644 index 0000000000..0872af818c --- /dev/null +++ b/packages/vue/telemetry.yml @@ -0,0 +1,7 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json +version: 1 +projectId: f37fae0f-81da-434b-86ac-22cfac61fe62 +endpoint: "https://collector-prod.1am6wm210aow.us-south.codeengine.appdomain.cloud/v1/metrics" +collect: + npm: + dependencies: null \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 96ec5e176f..389169ec1e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2153,7 +2153,7 @@ __metadata: "@carbon/charts": "workspace:*" "@carbon/icon-helpers": "npm:^10.45.1" "@carbon/icons": "npm:^11.34.0" - "@carbon/telemetry": "npm:~0.1.0" + "@ibm/telemetry-js": "npm:1.2.0" "@stackblitz/sdk": "npm:^1.9.0" "@storybook/angular": "npm:^7.6.10" "@types/carbon__icon-helpers": "npm:^10.7.4" @@ -2256,7 +2256,7 @@ __metadata: resolution: "@carbon/charts-svelte@workspace:packages/svelte" dependencies: "@carbon/charts": "workspace:*" - "@carbon/telemetry": "npm:~0.1.0" + "@ibm/telemetry-js": "npm:1.2.0" "@stackblitz/sdk": "npm:^1.9.0" "@sveltejs/adapter-auto": "npm:^3.1.1" "@sveltejs/kit": "npm:^2.4.1" @@ -2284,7 +2284,7 @@ __metadata: resolution: "@carbon/charts-vue@workspace:packages/vue" dependencies: "@carbon/charts": "workspace:*" - "@carbon/telemetry": "npm:~0.1.0" + "@ibm/telemetry-js": "npm:1.2.0" "@stackblitz/sdk": "npm:^1.9.0" "@types/d3": "npm:^7.4.3" "@vitejs/plugin-vue": "npm:^5.0.3" @@ -2311,9 +2311,9 @@ __metadata: "@carbon/import-once": "npm:^10.7.0" "@carbon/layout": "npm:^11.20.1" "@carbon/styles": "npm:1.48.0" - "@carbon/telemetry": "npm:~0.1.0" "@carbon/themes": "npm:^11.29.0" "@carbon/utils-position": "npm:^1.1.4" + "@ibm/telemetry-js": "npm:1.2.0" "@rollup/plugin-replace": "npm:^5.0.5" "@stackblitz/sdk": "npm:^1.9.0" "@types/d3": "npm:^7.4.3" @@ -2447,7 +2447,7 @@ __metadata: languageName: node linkType: hard -"@carbon/telemetry@npm:0.1.0, @carbon/telemetry@npm:~0.1.0": +"@carbon/telemetry@npm:0.1.0": version: 0.1.0 resolution: "@carbon/telemetry@npm:0.1.0" bin: @@ -3205,7 +3205,7 @@ __metadata: languageName: node linkType: hard -"@ibm/telemetry-js@npm:^1.2.0": +"@ibm/telemetry-js@npm:1.2.0, @ibm/telemetry-js@npm:^1.2.0": version: 1.2.0 resolution: "@ibm/telemetry-js@npm:1.2.0" bin: