Nominally Patriotic Meathead

    storybook-addon-datadog-rum
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.0 • Public • Published

    Datadog RUM / Storybook Addon

    MIT License npm version

    A StorybookJS Addon for using Datadog's RUM tool to collect data about how your visitors are using your Storybook component documentation. Use RUM to find out which documentation pages are popular or have errors before your users notice.

    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 storybook-addon-datadog-rum with NPM or yarn

      npm install storybook-addon-datadog-rum
      yarn add storybook-addon-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

    Install

    npm i storybook-addon-datadog-rum

    DownloadsWeekly Downloads

    5

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    14.1 kB

    Total Files

    18

    Last publish

    Collaborators

    • hydrosquall