diff --git a/packages/angular/README.md b/packages/angular/README.md index 16091b5527..4924c29b64 100644 --- a/packages/angular/README.md +++ b/packages/angular/README.md @@ -38,3 +38,11 @@ For instructions on using the **tabular data format**, see [here](https://carbon There are also additional options available depending on the chart type being used, [see our demo examples here](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/core/demo/data). Customizable options (specific to chart type) can be found [here](https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_charts_.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect de-identified and anonymized 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/package.json b/packages/angular/package.json index 5b7a385125..3fb789bb1f 100644 --- a/packages/angular/package.json +++ b/packages/angular/package.json @@ -8,7 +8,8 @@ "storybook": "start-storybook -p 9005 -c .storybook -s ./.storybook/assets", "demo:build": "build-storybook -o demo/bundle --quiet -s ./.storybook/assets", "clean": "rm -rf dist demo/bundle", - "start": "yarn storybook" + "start": "yarn storybook", + "postinstall": "ibmtelemetry --config=telemetry.yml" }, "repository": { "type": "git", @@ -42,7 +43,7 @@ ], "dependencies": { "@carbon/charts": "^0.58.1", - "@carbon/telemetry": "0.1.0" + "@ibm/telemetry-js": "^1.6.0" }, "peerDependencies": { "@angular/common": "^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0", diff --git a/packages/angular/telemetry.yml b/packages/angular/telemetry.yml new file mode 100644 index 0000000000..191a8c8383 --- /dev/null +++ b/packages/angular/telemetry.yml @@ -0,0 +1,10 @@ +# 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://www-api.ibm.com/ibm-telemetry/v1/metrics' +collect: + npm: + dependencies: null + js: + functions: {} + tokens: \ No newline at end of file diff --git a/packages/core/README.md b/packages/core/README.md index c2ea1cad57..b3b97d8c5f 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -50,3 +50,11 @@ used, Customizable options (specific to chart type) can be found [here](https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_charts_.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect de-identified and anonymized 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 47b49694b8..696ec0daf8 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -16,7 +16,7 @@ "format": "prettier . --write \"**/*.{scss,css,js,ts,md}\"", "start": "yarn run storybook", "storybook": "start-storybook -p 9006 -c .storybook -s ./.storybook/assets", - "postinstall": "bash build-vendor.sh" + "postinstall": "bash build-vendor.sh && ibmtelemetry --config=telemetry.yml" }, "repository": { "type": "git", @@ -49,8 +49,8 @@ "license": "Apache-2.0", "dependencies": { "@carbon/colors": "10.29.0", - "@carbon/telemetry": "0.1.0", "@carbon/utils-position": "1.1.1", + "@ibm/telemetry-js": "^1.6.0", "carbon-components": "10.56.0", "d3-cloud": "1.2.5", "d3-sankey": "0.12.3", diff --git a/packages/core/telemetry.yml b/packages/core/telemetry.yml new file mode 100644 index 0000000000..5260ec4515 --- /dev/null +++ b/packages/core/telemetry.yml @@ -0,0 +1,10 @@ +# 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://www-api.ibm.com/ibm-telemetry/v1/metrics' +collect: + npm: + dependencies: null + js: + functions: {} + tokens: null \ No newline at end of file diff --git a/packages/react/README.md b/packages/react/README.md index 9401c276db..c112287dfb 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -54,3 +54,11 @@ used, Customizable options (specific to chart type) can be found [here](https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_charts_.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect de-identified and anonymized 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/react/package.json b/packages/react/package.json index f45362dabc..ad1537ae77 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -11,7 +11,8 @@ "format": "prettier . --write \"**/*.{scss,css,js,ts,tsx,md}\"", "storybook": "start-storybook -p 9006 -c .storybook -s ./.storybook/assets", "demo:build": "yarn build && build-storybook -o demo/bundle --quiet -s ./.storybook/assets", - "clean": "rm -rf dist demo/bundle" + "clean": "rm -rf dist demo/bundle", + "postinstall": "ibmtelemetry --config=telemetry.yml" }, "repository": { "type": "git", @@ -50,7 +51,7 @@ "dependencies": { "@carbon/charts": "^0.58.1", "@carbon/icons-react": "^10.49.0", - "@carbon/telemetry": "0.1.0" + "@ibm/telemetry-js": "^1.6.0" }, "peerDependencies": { "react": "^16.0.0 || ^17.0.0 || ^18.0.0", diff --git a/packages/react/telemetry.yml b/packages/react/telemetry.yml new file mode 100644 index 0000000000..89620ba857 --- /dev/null +++ b/packages/react/telemetry.yml @@ -0,0 +1,19 @@ +# yaml-language-server: $schema=https://unpkg.com/@ibm/telemetry-config-schema@v1/dist/config.schema.json +version: 1 +projectId: 5784a186-6343-49d8-8e9a-1e591596f962 +endpoint: 'https://www-api.ibm.com/ibm-telemetry/v1/metrics' +collect: + npm: + dependencies: null + jsx: + elements: + allowedAttributeNames: + # General + - options + - data + # React + - key + - ref + js: + functions: {} + tokens: null \ No newline at end of file diff --git a/packages/svelte/README.md b/packages/svelte/README.md index 249a71edb9..0aa68ec9de 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -396,3 +396,12 @@ Customizable options (specific to chart type) can be found Svelte version 3.31 or greater is required to use this library with TypeScript. TypeScript definitions are located in the [types folder](types/). + + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect de-identified and anonymized 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 df0d5253f3..af1bf07784 100644 --- a/packages/svelte/package.json +++ b/packages/svelte/package.json @@ -7,6 +7,7 @@ "svelte": "./src/index.js", "types": "./types/index.d.ts", "scripts": { + "postinstall": "ibmtelemetry --config=telemetry.yml", "start": "yarn run storybook", "build": "bash build.sh", "storybook": "start-storybook -p 9006 -c .storybook -s ./.storybook/assets", @@ -50,7 +51,7 @@ "homepage": "https://github.com/carbon-design-system/carbon-charts#readme", "dependencies": { "@carbon/charts": "^0.58.1", - "@carbon/telemetry": "0.1.0" + "@ibm/telemetry-js": "^1.6.0" }, "peerDependencies": { "svelte": "^3.31.x" diff --git a/packages/svelte/telemetry.yml b/packages/svelte/telemetry.yml new file mode 100644 index 0000000000..d332c10297 --- /dev/null +++ b/packages/svelte/telemetry.yml @@ -0,0 +1,10 @@ +# 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://www-api.ibm.com/ibm-telemetry/v1/metrics' +collect: + npm: + dependencies: null + js: + functions: {} + tokens: null \ No newline at end of file diff --git a/packages/vue/README.md b/packages/vue/README.md index bffec8f9a7..6fde9e69a8 100644 --- a/packages/vue/README.md +++ b/packages/vue/README.md @@ -44,3 +44,11 @@ For instructions on using the **tabular data format**, see [here](https://carbon There are also additional options available depending on the chart type being used, [see our demo examples here](https://github.com/carbon-design-system/carbon-charts/tree/master/packages/core/demo/data). Customizable options (specific to chart type) can be found [here](https://carbon-design-system.github.io/carbon-charts/documentation/modules/_interfaces_charts_.html) + +## IBM Telemetry IBM Telemetry + +This package uses IBM Telemetry to collect de-identified and anonymized 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 7f25e6b23e..6418fda166 100644 --- a/packages/vue/package.json +++ b/packages/vue/package.json @@ -12,11 +12,12 @@ "ci-check": "yarn format:diff", "format": "prettier --write \"**/*.{scss,css,js,md,vue}\"", "format:diff": "prettier --list-different \"**/*.{scss,css,js,md,vue}\"", - "clean": "rm -rf dist demo/bundle" + "clean": "rm -rf dist demo/bundle", + "postinstall": "ibmtelemetry --config=telemetry.yml" }, "dependencies": { "@carbon/charts": "^0.58.1", - "@carbon/telemetry": "0.1.0", + "@ibm/telemetry-js": "^1.6.0", "vue": "2.5.21" }, "devDependencies": { diff --git a/packages/vue/telemetry.yml b/packages/vue/telemetry.yml new file mode 100644 index 0000000000..aa0cce0f19 --- /dev/null +++ b/packages/vue/telemetry.yml @@ -0,0 +1,10 @@ +# 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://www-api.ibm.com/ibm-telemetry/v1/metrics' +collect: + npm: + dependencies: null + js: + functions: {} + tokens: null \ No newline at end of file