Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grafana/faro-javascript-bundler-plugins
A collection of plugins for various JavaScript bundlers. Used in conjunction with the Faro Web SDK to unlock additional features in Grafana Cloud Frontend Observability.
https://github.com/grafana/faro-javascript-bundler-plugins
Last synced: 28 days ago
JSON representation
A collection of plugins for various JavaScript bundlers. Used in conjunction with the Faro Web SDK to unlock additional features in Grafana Cloud Frontend Observability.
- Host: GitHub
- URL: https://github.com/grafana/faro-javascript-bundler-plugins
- Owner: grafana
- License: apache-2.0
- Created: 2023-12-26T18:52:42.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-30T20:19:36.000Z (5 months ago)
- Last Synced: 2024-06-09T14:07:43.344Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 451 KB
- Stars: 2
- Watchers: 97
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Faro JavaScript bundler plugins
A collection of plugins for various JavaScript bundlers. Used in conjunction with the [Faro Web SDK](https://github.com/grafana/faro-web-sdk) to unlock additional features in [Grafana Cloud Frontend Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/).
## Get started
The Faro JavaScript bundler plugins work with the [Faro Web SDK](https://github.com/grafana/faro-web-sdk) and [Grafana Cloud Frontend Observability](https://grafana.com/products/cloud/frontend-observability-for-real-user-monitoring/). To use these bundler plugins, you must first have instrumented your JavaScript application with Faro and be sending your telemetry data to a Faro Collector endpoint in Grafana Cloud. Follow the Frontend Observability [quickstart guide](https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/quickstart/javascript/) to get started.
After you have an instrumented JavaScript application sending data to Grafana Cloud, you are ready to get started.
> [!NOTE]
> The Faro JavaScript bundler plugins work with client-side rendered applications. Server-side rendering isn't yet supported.
## Installation
To install the Faro JavaScript bundler plugins, use the package manager of your choice.
### Webpack
To install the Webpack plugin with `npm`, run:
```bash
npm install --save-dev @grafana/faro-webpack-plugin
```
To install the Webpack plugin with `yarn`, run:
```bash
yarn add --dev @grafana/faro-webpack-plugin
```
### Rollup/Vite
Rollup and Vite are both supported by the same plugin.
To install the Rollup/Vite plugin with `npm`, run:
```bash
npm install --save-dev @grafana/faro-rollup-plugin
```
To install the Rollup/Vite plugin with `yarn`, run:
```bash
yarn add --dev @grafana/faro-rollup-plugin
```
## Obtaining API key
In order to use the Faro JavaScript bundler plugins, you need to generate an API key with the necessary permissions to upload source maps to Grafana Cloud. To generate an API key, follow these steps:
1. Navigate to the [Grafana website](https://grafana.com/).
1. Sign in to your account and then click the **My Account** button in the top right corner.
1. In the sidebar under **Security**, click **Access Policies** and then click the **Create access policy** button.
1. After creating your access policy, click the **Add token** button in the card for your newly created policy.
1. Select the `sourcemaps:read`, `sourcemaps:delete`, and `sourcemaps:write` scopes from the drop-down list.
1. **Create** the token and be sure to copy the token value, as you aren't be able to see it again.
After you have generated an API key, you can use it in the Faro JavaScript bundler plugins to upload your source maps to Grafana Cloud. Use the generated API key as the `apiKey` value in the configuration options for the bundler plugins.
For best practices, store your API key in a secure location and don't expose it in your source code. Consider using environment variables or a secrets manager to securely store and access your API key.
## Usage
Details of how to use the plugins with your bundler reside in the Frontend Observability plugin under the "Settings" -> "Source Maps" tab after clicking into your instrumented app.
That tab includes the necessary configuration for the Faro JavaScript bundler plugins, including the `appName`, `appId`, and `endpoint` values that you need for the plugins to work with your app. The details provided below are general instructions for how to use the plugins with your bundler.
### Webpack
To use the Webpack plugin, add the following to your `webpack.config.js`:
```javascript
// other imports
import FaroSourceMapUploaderPlugin from "@grafana/faro-webpack-plugin";
module.exports = {
// other configs
plugins: [
// other plugins
new FaroSourceMapUploaderPlugin({
appName: "$your-app-name",
endpoint: "$your-faro-collector-url",
apiKey: "$your-api-key",
appId: "$your-app-id",
stackId: "$your-stack-id",
gzipContents: true,
}),
],
};
```
### Rollup/Vite
To use the Rollup/Vite plugin, add the following to your `rollup.config.js` or `vite.config.js`:
```javascript
// other imports
import faroUploader from '@grafana/faro-rollup-plugin';
export default defineConfig(({ mode }) => {
return {
// other configs
plugins: [
// other plugins
faroUploader({
appName: "$your-app-name",
endpoint: "$your-faro-collector-url",
apiKey: "$your-api-key",
appId: "$your-app-id",
stackId: "$your-stack-id",
gzipContents: true,
}),
],
};
```
### Configuration Options
The following options are available for the Faro JavaScript bundler plugins:
- `appName: string` *required*: The name of your application, it should match the `appName` value used in your Faro Web SDK configuration
- `endpoint: string` *required*: The URL of your Faro Collector endpoint, found in Frontend Observability under **Settings** and **Web SDK Config**
- `apiKey: string` *required*: The API key for your Faro Collector, you can generate a new scope on [grafana.com], refer to the [Obtaining API key](#obtaining-api-key) section
- `appId: string` *required*: The ID of your application, it should match the `appId` value used in your Faro Web SDK configuration
- `stackId: string` *required*: The ID of the stack, found in Frontend Observability under **Settings** and **Web SDK Config**
- `outputPath: string` *optional*: Folder where output files will be located
- `outputFiles: string[]` *optional*: An array of source map files to upload, by default Faro uploads all source maps
- `bundleId: string` *optional*: The ID of the bundle/build, by default auto-generated, or specify an ID to filter by bundle ID in Frontend Observability
- `keepSourcemaps: boolean` *optional*: Whether to keep the source maps in your generated bundle after uploading, default `false`
- `gzipContents: boolean` *optional*: Whether to archive and compress the source maps before uploading, default `true`
- `verbose: boolean` *optional*: Whether to log verbose output during the upload process, default `false`
After initial configuration, the Faro JavaScript bundler plugins automatically uploads your source maps to Grafana Cloud when you build your application. You can verify that the source maps upload successfully by in the "Settings" -> "Source Maps" tab in the Frontend Observability plugin. From there you are able to see the source maps that you have uploaded.
After you have completed all the required steps, you have finished - the Faro Collector begins processing your source maps and associating them with your telemetry data. The portions of your stack traces with source maps uploaded to the Faro Collector are automatically de-obfuscated and displayed in the Frontend Observability plugin when viewing your error data.