0.2.0 • Published 3 years ago

storybook-addon-datadog-rum v0.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Datadog RUM / Storybook Add-on

MIT License

A storybook add-on for using Datadog instrumentation to collect data about how your visitors are using your Storybook component documentation. Use this to find out which documentation pages are popular, and which pages have bugs.

Demo

  • Insert link to a public Datadog Storybook using this addon
  • Insert link to GIF showing storybook data inside of a Datadog dash

Installation

Install plugin-name with NPM

  yarn add @hydrosquall/storybook-datadog-rum

Environment Variables

To run this project, you will need to add the following environment variables to your .env file. (See typings.d.ts for the most up-to-date list.)

{
    STORYBOOK_DATADOG_APPLICATION_ID: string;
    STORYBOOK_DATADOG_CLIENT_TOKEN: string;
    STORYBOOK_DATADOG_SITE: string;

    // The variables below are optional
    // Read about what they do here:
    STORYBOOK_DATADOG_SERVICE?: string;
    STORYBOOK_DATADOG_SAMPLE_RATE?: number;
    STORYBOOK_DATADOG_TRACK_INTERACTIONS?: boolean;
}

Full initialization parameters documentation

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Acknowledgements

Authors

Appendix

  • Disable data collection when running locally
  • Enable logging custom events