@envelop/newrelic 3.2.0 → 3.2.1

package/README.md

@@ -44,6 +44,7 @@ const getEnveloped = envelop({
       trackResolvers: true, // default `false`. When set to `true`, track resolvers as segments to monitor their performance
       includeResolverArgs: false, // default `false`. When set to `true`, includes all the arguments passed to resolvers with their values
       rootFieldsNaming: true, // default `false`. When set to `true` append the names of operation root fields to the transaction name
+      skipError: error => { ... return true; }, // a function that allows you to skip reporting a given error to NewRelic. By default custom `EnvelopError`s will be skipped
       operationNameProperty: 'id', // default empty. When passed will check for the property name passed, within the document object. Will eventually use its value as operation name. Useful for custom document properties (e.g. queryId/hash)
     }),
   ],
@@ -62,9 +63,9 @@ Below is a quick example of how you can use RegEx to set up white/black listing
 
 ```ts
 useNewRelic({
-  includeExecuteVariables: /^(client.*|application.*)$.*$/i, // whitelist, track only variables whose name starts with client or application (e.g. clientName, applicationId)
+  includeExecuteVariables: /client|application/i, // whitelist, track only variables whose name contains "client" or "application" (e.g. clientName, applicationId, xApplicationId)
   trackResolvers: true, // track resolvers, since we also want to track resolvers' arguments
-  includeResolverArgs: /^(?!(name|email|password)$).*$/, // blacklist, track all arguments whose name does not match 'name', 'email' nor 'password'
+  includeResolverArgs: /^(?!name|email|password).*/i, // blacklist, track all arguments whose name does not match 'name', 'email' nor 'password'
 }),
 ```
 

package/index.d.ts

@@ -1,4 +1,5 @@
 import { Plugin } from '@envelop/core';
+import { GraphQLError } from 'graphql';
 export declare type UseNewRelicOptions = {
     includeOperationDocument?: boolean;
     includeExecuteVariables?: boolean | RegExp;
@@ -8,10 +9,10 @@ export declare type UseNewRelicOptions = {
     rootFieldsNaming?: boolean;
     operationNameProperty?: string;
     /**
-     * Indicates whether or not to skip Sentry exception reporting for a given error.
-     * By default, this plugin skips all `EnvelopError` errors and does not report it to Sentry.
+     * Indicates whether or not to skip reporting a given error to NewRelic.
+     * By default, this plugin skips all `EnvelopError` errors and does not report them to NewRelic.
      */
-    skipError?: (args: Error) => boolean;
+    skipError?: (error: GraphQLError) => boolean;
 };
-export declare function defaultSkipError(error: Error): boolean;
+export declare function defaultSkipError(error: GraphQLError): boolean;
 export declare const useNewRelic: (rawOptions?: UseNewRelicOptions | undefined) => Plugin;

package/index.js

@@ -50,7 +50,7 @@ const DEFAULT_OPTIONS = {
     skipError: defaultSkipError,
 };
 function defaultSkipError(error) {
-    return error instanceof core.EnvelopError;
+    return error.originalError instanceof core.EnvelopError;
 }
 const useNewRelic = (rawOptions) => {
     const options = {
@@ -128,14 +128,9 @@ const useNewRelic = (rawOptions) => {
                         resolverSegment.addAttribute(AttributeName.RESOLVER_ARGS, JSON.stringify(resolverArgsToTrack));
                     }
                     return ({ result }) => {
-                        var _a;
                         if (options.includeRawResult) {
                             resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT, JSON.stringify(result));
                         }
-                        if (result instanceof Error && !((_a = options.skipError) === null || _a === void 0 ? void 0 : _a.call(options, result))) {
-                            const transaction = instrumentationApi.tracer.getTransaction();
-                            instrumentationApi.agent.errors.add(transaction, JSON.stringify(result));
-                        }
                         resolverSegment.end();
                     };
                 }
@@ -144,6 +139,7 @@ const useNewRelic = (rawOptions) => {
                 onResolverCalled,
                 onExecuteDone({ result }) {
                     const sendResult = (singularResult) => {
+                        var _a;
                         if (singularResult.data && options.includeRawResult) {
                             spanContext.addCustomAttribute(AttributeName.EXECUTION_RESULT, JSON.stringify(singularResult));
                         }
@@ -151,6 +147,8 @@ const useNewRelic = (rawOptions) => {
                             const agent = instrumentationApi.agent;
                             const transaction = instrumentationApi.tracer.getTransaction();
                             for (const error of singularResult.errors) {
+                                if ((_a = options.skipError) === null || _a === void 0 ? void 0 : _a.call(options, error))
+                                    continue;
                                 agent.errors.add(transaction, JSON.stringify(error));
                             }
                         }

package/index.mjs

@@ -27,7 +27,7 @@ const DEFAULT_OPTIONS = {
     skipError: defaultSkipError,
 };
 function defaultSkipError(error) {
-    return error instanceof EnvelopError;
+    return error.originalError instanceof EnvelopError;
 }
 const useNewRelic = (rawOptions) => {
     const options = {
@@ -105,14 +105,9 @@ const useNewRelic = (rawOptions) => {
                         resolverSegment.addAttribute(AttributeName.RESOLVER_ARGS, JSON.stringify(resolverArgsToTrack));
                     }
                     return ({ result }) => {
-                        var _a;
                         if (options.includeRawResult) {
                             resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT, JSON.stringify(result));
                         }
-                        if (result instanceof Error && !((_a = options.skipError) === null || _a === void 0 ? void 0 : _a.call(options, result))) {
-                            const transaction = instrumentationApi.tracer.getTransaction();
-                            instrumentationApi.agent.errors.add(transaction, JSON.stringify(result));
-                        }
                         resolverSegment.end();
                     };
                 }
@@ -121,6 +116,7 @@ const useNewRelic = (rawOptions) => {
                 onResolverCalled,
                 onExecuteDone({ result }) {
                     const sendResult = (singularResult) => {
+                        var _a;
                         if (singularResult.data && options.includeRawResult) {
                             spanContext.addCustomAttribute(AttributeName.EXECUTION_RESULT, JSON.stringify(singularResult));
                         }
@@ -128,6 +124,8 @@ const useNewRelic = (rawOptions) => {
                             const agent = instrumentationApi.agent;
                             const transaction = instrumentationApi.tracer.getTransaction();
                             for (const error of singularResult.errors) {
+                                if ((_a = options.skipError) === null || _a === void 0 ? void 0 : _a.call(options, error))
+                                    continue;
                                 agent.errors.add(transaction, JSON.stringify(error));
                             }
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/newrelic",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^2.1.0",