npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gasket/plugin-elastic-apm

v7.0.6

Published

Adds Elastic APM instrumentation to your application

Downloads

607

Readme

@gasket/plugin-elastic-apm

Adds Elastic APM instrumentation to your application

Installation

npm i @gasket/plugin-elastic-apm

Update your gasket file plugin configuration:

// gasket.js

+ import pluginElasticApm from '@gasket/plugin-elastic-apm';

export default makeGasket({
  plugins: [
+   pluginElasticApm
  ]
});

Add NODE_OPTIONS=--import=./setup.js to the package.json start script:

  "scripts": {
    "build": "next build",
-   "start": "next start",
+   "start": "NODE_OPTIONS=--import=./setup.js next start",
    "local": "next dev"
  }

Add a setup.js script to the root of your app

// setup.js
import dotenv from 'dotenv/config';
import apm from 'elastic-apm-node';

// Elastic APM setup
apm.start({
  serviceName: 'my-service-name',
  captureHeaders: false,
  secretToken: process.env.ELASTIC_APM_SECRET_TOKEN,
  serverUrl: process.env.ELASTIC_APM_SERVER_URL
  // additional configuration options
});

Configuration

The start recommendations for the APM agent are to require it as early as possible in your app. For Gasket apps, using --require ./setup.js will accomplish this. To configure the APM agent, set the environment variables described in the configuration options documentation.

In particular, the APM server URL (ELASTIC_APM_SERVER_URL) and secret token (ELASTIC_APM_SECRET_TOKEN) are both required configuration. If either of these are not present, the APM agent will be disabled.

Plugin Configurations

The Gasket plugin provides some additional setup helpers. These can be configured under elasticAPM in the gasket.js.

  • sensitiveCookies - (string[]) A list of sensitive cookies to filter

Filtering Sensitive Cookies

If your application’s users send session credentials or any other sensitive information in their cookies, you may wish to filter them out before they are stored in Elasticsearch. Specify a list of cookie names to redact in gasket.js:

export default makeGasket({
  elasticAPM: {
    sensitiveCookies: ['my_jwt', 'userFullName']
  }
});

Custom Filtering Sensitive Fields

If your application’s users send session credentials or any other sensitive information in their cookies, you may wish to filter them out before they are stored in Elasticsearch. Specify a list of cookie names to redact in setup.js using the sanitizeFieldNames configuration option:

// setup.js
require('dotenv').config();

require('elastic-apm-node').start({
  ...,
  sanitizeFieldNames: ['foo', 'bar', '*token*']
});

The sanitizeFieldNames config option can be used for:

  • request and response HTTP headers
  • HTTP request cookies
  • any form field captured during an application/x-www-form-urlencoded data request

To filter out other data, use the APM Add Filter API.

Custom Filters

According to the Elastic APM docs, the Elastic APM agent for Node.js is a singleton. This means that you can require and configure singleton in various hooks of your Gasket app, such as with the init or middleware lifecycles.

Actions

getApmTransaction

Use the getApmTransaction action to access and decorate the current APM transaction. This action is available in any lifecycle hook or server-side code.

// example-plugin.js

export default {
  name: 'example-plugin',
  hooks: {
    express(gasket, app) {
      app.use(async (req, res, next) => {
        const transaction = await gasket.actions.getApmTransaction(req);
        const locale = await gasket.actions.getIntlLocale(req);
        transaction.setLabel('locale', locale);
      });
    }
  }
}

In the above example, we are hooking the express lifecycle to add middleware to decorate the transaction. Calling getApmTransaction will also allow other plugins to decorate the transaction by hooking the apmTransaction lifecycle discussed next.

Lifecycles

apmTransaction

Enables customizing an APM transaction. Hooks receive the current APM Transaction and details about the request. Hooks may be asynchronous. The request details are as follows:

| Property | Description | |----------|-------------| | req | The HTTP request or framework-specific wrapper around it | | res | The HTTP response or framework-specific wrapper around it |

// example-plugin.js

export default {
  name: 'example-plugin',
  hooks: {
    apmTransaction(gasket, transaction, { req, res }) => {
      transaction.setLabel('language', req.headers['accept-language']);
    }
  }
}

How it works

This plugin hooks the Gasket [configure] lifecycle to set additional filtering, such as for sensitive cookies.

License

MIT