https://github.com/erezrokah/netlify-plugin-epsagon

https://github.com/erezrokah/netlify-plugin-epsagon

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/erezrokah/netlify-plugin-epsagon
• Owner: erezrokah
• License: mit
• Created: 2021-01-26T16:07:59.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-13T00:56:22.000Z (8 months ago)
• Last Synced: 2024-10-05T04:12:57.887Z (3 months ago)
• Language: JavaScript
• Size: 20.2 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Netlify Epsagon Build Plugin - Instrument JavaScript functions with epsagon.

## Installation

There are two ways to install the plugin in your Netlify site: with the Netlify UI or with file-based installation.

**UI-based Installation**

You can install this from your team's [Plugins directory](https://app.netlify.com/plugins) in the Netlify UI.

Read more about [UI-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#ui-installation) in our docs.

**File-based Installation**

1. Create a `netlify.toml` in the root of your project. Your file should include the plugins section below:

    ```toml

    [build]

      (...)

    [[plugins]]

      package = "netlify-plugin-epsagon"

    ```

2. From your project's base directory, use `npm`, `yarn`, or any other Node.js package manager to add this plugin to `devDependencies` in `package.json`.

    ```

    npm install -D netlify-plugin-epsagon

    ```

    or

    ```

    yarn add -D netlify-plugin-epsagon

    ```

Read more about [file-based plugin installation](https://docs.netlify.com/configure-builds/build-plugins/#file-based-installation) in our docs.

## Configuration

In order for this plugin to work a [build environment variable](https://docs.netlify.com/configure-builds/environment-variables/)

`EPSAGON_TOKEN` needs to be provided.

The following [plugin `inputs`](https://docs.netlify.com/configure-builds/build-plugins/#configure-settings) are available for further configuration:

* `ignoredKeys`: List of sensitive properties and names to be filtered out from traces (defaults to `["token", "authorization"]`)