adonis-newrelic's Introduction

Registering provider

Setup

Add new relic provider in the top of providers list.

// app/start.js

const providers = [
  `@frubana/adonis-newrelic/providers/Provider`
  // ...
];

In the main directory add newrelic.js and copy

/** @type {import('@adonisjs/framework/src/Env')} */
const Env = use("Env");

/**
 * New Relic agent configuration.
 *
 * See lib/config/default.js in the agent distribution for a more complete
 * description of configuration variables and their potential values.
 */
exports.config = {
  /**
   * Array of application names.
   */
  app_name: [Env.get("APP_NAME")],
  /**
   * Your New Relic license key.
   */
  license_key: Env.get("NEW_RELIC"),

  logging: {
    /**
     * Level at which to log. 'trace' is most useful to New Relic when diagnosing
     * issues with the agent, 'info' and higher will impose the least overhead on
     * production applications.
     */
    level: "info"
  },
  /**
   * When true, all request headers except for those listed in attributes.exclude
   * will be captured for all traces, unless otherwise specified in a destination's
   * attributes include/exclude lists.
   */
  allow_all_headers: true,

  attributes: {
    /**
     * Prefix of attributes to exclude from all destinations. Allows * as wildcard
     * at end.
     *
     * NOTE: If excluding headers, they must be in camelCase form to be filtered.
     *
     * @env NEW_RELIC_ATTRIBUTES_EXCLUDE
     */
    exclude: [
      "request.headers.cookie",
      "request.headers.authorization",
      "request.headers.proxyAuthorization",
      "request.headers.setCookie*",
      "request.headers.x*",
      "response.headers.cookie",
      "response.headers.authorization",
      "response.headers.proxyAuthorization",
      "response.headers.setCookie*",
      "response.headers.x*"
    ]
  }
};

In your .env file add this variable and paste your new relic key

NEW_RELIC=

adonis-newrelic's People

Contributors

Stargazers

Watchers

adonis-newrelic's Issues

Memory leak

Greetings!

I've been using your package in a production environment and I've detected a memory leak coming from this module that I'm now investigating.

By using the chrome dev tools I was able to detect that somehow the following lines are the ones that cause the memory leak, can you help me out find why is that so?

this.Route.match = shim.recordMiddleware(this.Route.match, {
   type: shim.ROUTER,
   route: request.url(),
   req() {
       return req;
   },
   res() {
       return res;
    },
});

Testing methodology:

I cloned the code in the master branch to my Providers folder and linked it to the start/app.js providers.
I started commenting out parts of the code and after commenting that piece of code, the memory leak disappeared

Proof: