Détail du package

@nuxt/telemetry

nuxt3.3mMIT2.6.6

Nuxt collects anonymous telemetry data about general usage. This helps us to accurately gauge Nuxt feature usage and customization across all our users.

readme

Nuxt Telemetry Module

Nuxt collects anonymous telemetry data about general usage. This helps us to accurately gauge Nuxt feature usage and customization across all our users.

This program is optional. You will be asked on first time to get permission and you can always opt-out if you'd not like to share any information.

Why collecting Telemetry?

Nuxt has grown a lot from its initial release (7 Nov 2016) and we keep listening to community feedback to improve it.

However, this manual process only collects feedback from a subset of users that take the time to fill the issue template and it may have different needs or use-case than you.

Nuxt Telemetry collects anonymous telemetry data about general usage. This helps us to accurately gauge feature usage and customization across all our users. This data will let us better understand how Nuxt is used globally, measuring improvements made (DX and performances) and their relevance.

Events

We collect multiple events:

  • Command invoked (nuxt dev, nuxt build, etc)
  • Versions of Nuxt and Node.js
  • General machine information (MacOS/Linux/Windows and if the command is run within CI, ci name)
  • Duration of the Webpack build and average size of the application, as well as the generation stats (when using nuxt generate or nuxt export)
  • Your project's public dependencies (Nuxt modules)

You can see the list of events in lib/events.

Example of an event:

{
   "name": "NUXT_PROJECT",
   "payload": {
    "type": "GIT",
    "isSSR": true,
    "target": "server",
    "isTypescriptBuild": false,
    "isTypescriptRuntime": false,
    "isProgrammatic": false,
    "packageManager": "npm"
   }
}

To display the exact data that will be sent, you can use NUXT_TELEMETRY_DEBUG=1.

Sensitive data

We take your privacy and our security very seriously.

We do not collect any metrics which may contain sensitive data.

This includes, but is not limited to: environment variables, file paths, contents of files, logs, or serialized JavaScript errors.

The data we collect is completely anonymous, not traceable to the source (using hash+seed), and only meaningful in aggregate form. No data we collect is personally identifiable or trackable.

Opting-out

You can disable Nuxt Telemetry for your project in several ways:

  1. Setting telemetry: false in your nuxt.config:
export default {
  telemetry: false
}
  1. Using an environment variable:
NUXT_TELEMETRY_DISABLED=1
  1. Using npx @nuxt/telemetry disable
npx @nuxt/telemetry [status|enable|disable] [-g,--global] [dir]

Skip Prompt

If you encounter problems with the consent prompt and want to participate without being asked this question, you can set telemetry: true from nuxt.config:

export default {
  telemetry: true
}

Thank you

We want to thank you for participating in this telemetry program to help us better understand how you use Nuxt to keep improving it 💚

Development

  • Run yarn dev:prepare to generate type stubs.
  • Use yarn dev to start playground in development mode.

License

MIT License

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

v2.6.6

compare changes

🩹 Fixes

  • Remove dependency on parse-git-config (#250)

❤️ Contributors

v2.6.5

compare changes

🩹 Fixes

  • Expand allowed engines.node (7d0726c)

📦 Build

  • Update to latest module-builder (8565242)

🏡 Chore

🤖 CI

❤️ Contributors

v2.6.4

compare changes

🩹 Fixes

  • cli: Use @nuxt/kit to load nuxt config (#205)

🤖 CI

  • Do not run coverage on windows (d34b669)

❤️ Contributors

v2.6.3

compare changes

🩹 Fixes

  • cli: Expose main and run it from bin (0e80f9e)

❤️ Contributors

v2.6.2

compare changes

💅 Refactors

  • Move cli to citty (#197)

❤️ Contributors

v2.6.1

compare changes

🔥 Performance

  • Remove unused dependencies (#195)

🤖 CI

  • Run test suite on windows (#165)

❤️ Contributors

v2.6.0

compare changes

🚀 Enhancements

  • Use package-manager-detector (a6b67a3)

📖 Documentation

  • Update command for disabling telemetry (5f79cad)
  • Update telemetry disable command (#142)

🏡 Chore

❤️ Contributors

v2.5.4

compare changes

🩹 Fixes

  • Respect nightly suffix (de51475)
  • Regenerate seed if it has been cast to a number (2a2a650)

📖 Documentation

  • Update grammar (#126)

🏡 Chore

🤖 CI

❤️ Contributors

v2.5.3

compare changes

🏡 Chore

❤️ Contributors

v2.5.2

compare changes

🩹 Fixes

  • Do not chain consola colors (#116)

✅ Tests

  • Add type test and improve type-safety (#117)

❤️ Contributors

v2.5.1

compare changes

🔥 Performance

  • Remove unnecessary dependencies (#114)

🏡 Chore

  • Adopt new module-builder prepare mode (#115)

❤️ Contributors

v2.5.0

compare changes

🚀 Enhancements

  • Expose hooks for extensibility (#111)

🏡 Chore

❤️ Contributors

2.4.1 (2023-08-10)

Bug Fixes

  • resolve app.config path from srcDir (w/ exts) (aa8749f)

2.4.0 (2023-08-10)

Features

2.3.3 (2023-08-10)

2.3.2 (2023-07-22)

2.3.1 (2023-07-06)

Bug Fixes

  • module: correct timing values (6591101)

2.3.0 (2023-07-05)

Features

  • better consent prompt, module event and fix logged command (#103) (5e34507)

2.2.0 (2023-04-11)

2.1.10 (2023-02-17)

2.1.9 (2023-01-20)

Bug Fixes

2.1.8 (2022-11-16)

2.1.7 (2022-11-16)

2.1.6 (2022-10-10)

Bug Fixes

2.1.5 (2022-09-03)

Bug Fixes

2.1.4 (2022-08-07)

2.1.3 (2022-04-26)

2.1.2 (2022-04-20)

Bug Fixes

2.1.1 (2022-04-20)

Bug Fixes

2.1.0 (2022-04-20)

Features

  • add nuxtMajorVersion to the context (47a7ea6)

2.0.0 (2022-04-20)

⚠ BREAKING CHANGES

  • initial refactor for nuxt 3 support

Features

  • initial refactor for nuxt 3 support (584b7fe)

Bug Fixes

  • workaround to hide debug logs (19a545d)

1.3.6 (2021-05-21)

1.3.5 (2021-05-17)

1.3.4 (2021-05-17)

Bug Fixes

  • esm compatibility with require.main (resolves #49) (5d8024f)

1.3.3 (2021-01-21)

Bug Fixes

  • consent: update grammar in msg and question (#42) (31f527e)

1.3.2 (2021-01-13)

Bug Fixes

1.3.1 (2021-01-13)

1.3.0 (2020-11-25)

Features

  • disable auto consent and add nuxt telemetry consent (#35) (f1a5d95)

1.2.5 (2020-11-22)

Bug Fixes

  • pkg: point to src/index (2046b1c)

1.2.4 (2020-11-22)

Bug Fixes

  • add missing chalk dependency (80d4961)

1.2.3 (2020-07-31)

Bug Fixes

1.2.2 (2020-07-10)

Bug Fixes

1.2.1 (2020-06-28)

1.2.0 (2020-06-26)

Features

  • module: support telemetry: true (4010c07)

1.1.1 (2020-06-26)

Bug Fixes

  • module: handle entry errors (f8051d0)

1.1.0 (2020-06-19)

Features

  • cli: support dotenv and nuxt.config (7cebe56)

Bug Fixes

  • cli: set consent for enable/disable (9b03c4f)
  • consent: use stdEnv for ci detection (7a4d2f6)

1.0.1 (2020-06-18)

1.0.0 (2020-06-18)

0.0.14 (2020-06-17)

Bug Fixes

  • cli: set default _dir to . (142bc74)

0.0.13 (2020-06-17)

0.0.12 (2020-06-17)

0.0.11 (2020-06-16)

0.0.10 (2020-06-16)

0.0.9 (2020-06-12)

Bug Fixes

  • fix codesandbox sse env (e5d2406)

0.0.8 (2020-06-12)

Bug Fixes

  • hide telemetry logs when debug is off (6587377)

0.0.7 (2020-06-11)

Bug Fixes

  • utils: avoid error on deps[type] (#7) (ff2c9be)

0.0.6 (2020-06-08)

Bug Fixes

0.0.5 (2020-06-08)

Features

  • user consent prompt and random seed instead of machine-id (#4) (4910922)

0.0.4 (2020-05-22)

0.0.3 (2020-05-22)

Features

  • support NUXT_TELEMETRY_DEBUG and NUXT_TELEMETRY_ENDPOINT (f57526f)

0.0.2 (2020-05-22)

Bug Fixes

0.0.1 (2020-05-22)

Features

  • better debugging and options handling (1e21367)
  • improvements (c4889e6)
  • prepare for validation (a9799d3)

Bug Fixes

  • disable telemetry with config or env var (cf64c4e)
  • don't relay on classProperties for Node 10 (7a957dc)
  • options.telemetry (1592144)
  • updates from Pooya pair coding (880ff9a)