@twilio-labs/docusaurus-plugin-for-datadog-rum

docusaurus-plugin-for-datadog-rum

Integrates Datadog RUM with your Docusaurus site.

Installation

npm install --save @twilio-labs/docusaurus-plugin-for-datadog-rum

Or, if you prefer Yarn:

yarn add @twilio-labs/docusaurus-plugin-for-datadog-rum

Configuration

Accepted fields:

Name	Type	Default	Description
clientToken	string	Required	The client token for your Datadog RUM application
applicationId	string	Required	The application ID for your Datadog RUM application
service	string	"docusaurus"	The name your service will show within the Datadog UI
env	string	process.env.NODE_ENV ?? "dev"	The environment of your deployed application

To create your application:

• Login to Datadog
• Choose UX Monitoring > RUM Applications
• Click New Application
• Choose JS (JavaScript) for the Application type
• Enter an Application name
• Click Create New RUM Application
• Under Instrument your application, choose the NPM type and find your clientToken and applicationId in the code sample that you can copy into your docusaurus.config.js.

If you already have an existing application created, instead of steps 3-6, click the Edit Application button next to your application and continue at step 7.

Example configuration

docusaurus.config.js

  plugins: [
    [
      "@twilio-labs/docusaurus-plugin-for-datadog-rum",
      {
        clientToken: "3EBOWfRPv8qwertyZXCvbnMAsD2f1g0Hf96",
        applicationId: "01234567-89ab-cdef-0123-456789abcdef",
        service: "my-docusaurus-site"
      },
    ],
  ],