Sentry Babel Component Annotate Plugin (Beta)
![npm dt](https://img.shields.io/npm/dt/@sentry/babel-component-annotate-plugin.svg)
This plugin is currently in beta. Please help us improve by reporting any issues or giving us feedback.
A Babel plugin that automatically annotates your output DOM with their respective frontend component names.
This will unlock the capability to search for Replays in Sentry by component name, as well as see component names in breadcrumbs and performance monitoring.
Please note that your Sentry JavaScript SDK version must be at least 7.91.0
to take advantage of these features.
Currently, this plugin only works with React, and will exclusively parse .jsx
and .tsx
files.
Note
This plugin comes included in Sentry's bundler plugins, alongside many other features to improve your Sentry workflow.
It can be downloaded individually, but it is recommended that you install the bundler plugins for your respective bundler, and enable this feature through the config object.
Check out the supported bundler plugin packages for installation instructions:
Installation
Using npm:
npm install @sentry/babel-component-annotate-plugin --save-dev
Using yarn:
yarn add @sentry/babel-component-annotate-plugin --dev
Using pnpm:
pnpm install @sentry/babel-component-annotate-plugin --dev
Example
{
plugins: [
['@sentry/babel-component-annotate-plugin']
],
}
Or alternatively, configure the plugin by directly importing it:
import {componentNameAnnotatePlugin} from '@sentry/babel-component-annotate-plugin';
{
plugins: [
[componentNameAnnotatePlugin]
],
}
More information