Copy as Markdown[Open in ChatGPT](https://chatgpt.com/?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Frum%2Fsdk-installation%2Fjavascript%2Fbundler-plugins%2Fesbuild.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)[Open in Claude](https://claude.ai/new?q=Read%20https%3A%2F%2Fcoralogix.com%2Fdocs%2Fuser-guides%2Frum%2Fsdk-installation%2Fjavascript%2Fbundler-plugins%2Fesbuild.md%20and%20help%20me%20with%20my%20question%20about%20this%20Coralogix%20documentation%20page.)

# Coralogix Esbuild Plugin

[![npm version](https://img.shields.io/npm/v/@coralogix/esbuild-plugin)](https://www.npmjs.com/package/@coralogix/esbuild-plugin) [![npm dm](https://img.shields.io/npm/dm/@coralogix/esbuild-plugin)](https://www.npmjs.com/package/@coralogix/esbuild-plugin) [![npm dt](https://img.shields.io/npm/dt/@coralogix/esbuild-plugin)](https://www.npmjs.com/package/@coralogix/esbuild-plugin)

> An Esbuild plugin that creates metadata asset for support micro frontend in Coralogix.

## Installation[​](#installation "Direct link to Installation")

```
npm i -D @coralogix/esbuild-plugin
```

## Example[​](#example "Direct link to Example")

```
// esbuild.config.js

const esbuild = require('esbuild');

const { coralogixEsbuildPlugin } = require("@coralogix/esbuild-plugin");



await esbuild.build({

  entryPoints: ['app.js'],

  bundle: true,

  outfile: 'out.js',

  plugins: [

    coralogixEsbuildPlugin({

        app:'test-app',

        version:'1.0.0'

      })

  ],

})
```

## Options[​](#options "Direct link to Options")

| Option      | Type   | Description                                                                                                                             |
| ----------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `app`       | string | Name of the micro frontend. Coralogix labels errors from this bundle with it.                                                           |
| `version`   | string | Version of the micro frontend, labelled alongside `app`.                                                                                |
| `outputDir` | string | Optional. Directory to write `cx-metadata.json` into, relative to the build output directory. Defaults to the root of the build output. |

Set `outputDir` when the bundle is served from somewhere other than the root of the output directory, so the RUM SDK finds the metadata next to the assets it describes.