react-datadog
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

React Datadog

CI/CD version downloads

react-datadog is a React hook for instantiating Datadog RUM in your React application.

Install

  • npm install react-datadog or
  • yarn add react-datadog

Use

import useDatadog from 'react-datadog';

export default function App() {
  useDatadog({
    applicationId: 'a0b1c2d3-e4f5-a6b7-c8d9-e0f1a2b3c4d5',
    clientToken: 'puba0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5',
    service: 'my-service',
    sessionReplayRecording: true,
  });

  return <>Hello world!</>;
}

Exports

useDatadog

import useDatadog from 'react-datadog';'

In addition to the RUM init configuration, the useDatadog hooks also accepts additional props:

enabled

Type: boolean (default: true)

Unless explicitly set to false, the useDatadog hook will automatically initialize on mount.

sessionReplayRecording

Type: boolean (default: true)

Unless explicitly set to false, the useDatadog hook will automatically start session replay recording on mount (and stop session replay recording on unmount).

useDatadogRum

import { useDatadogRum } from 'react-datadog';

Not to be confused with the useDatadog default export, the useDatadogRum hook returns the Datadog RUM object. While this is currently equivalent to import { datadogRum } from '@datadog/browser-rum';, this hook allows future extensibility with React context.

Readme

Keywords

none

Package Sidebar

Install

npm i react-datadog

Weekly Downloads

1,318

Version

2.0.1

License

MIT

Unpacked Size

19.7 kB

Total Files

35

Last publish

Collaborators

  • charlesstover