feat: Added support for gRPC error reporting (#233)

Author: sumitsuthar

lib/instrumentation-security/hooks/grpc-js/nr-grpc.js

@@ -16,6 +16,7 @@ const grpcutils = require('../../core/grpc-utils');
 const routeManager = require('../../core/route-manager');
 let serverAddress;
 const ExceptionReporting = require('../../../nr-security-agent/lib/core/ExceptionReporting');
+const responseErrorSet = new Set([2, 12, 13, 14, 15])
 
 
 
@@ -58,6 +59,33 @@ module.exports.wrapStartCall = function wrappedClient(shim, callStream) {
   shim.wrap(callStream.Http2CallStream.prototype, 'start', wrapStart)
 }
 
+/**
+ * Wrapper for error collection
+ * @param {*} shim 
+ * @param {*} call 
+ */
+module.exports.wrapCall = function wrappedCall(shim, call) {
+  shim.wrap(call, 'callErrorFromStatus', function wrapCallErrorFromStatus(shim, fn) {
+    if (!shim.isFunction(fn)) {
+      return fn
+    }
+    return function wrappedCallErrorFromStatus() {
+      const errRes = fn.apply(this, arguments);
+      try {
+        let error = new Error(errRes.message);
+        error.stack = errRes.stack;
+        const request = requestManager.getRequest(shim);
+        if (request) {
+          ExceptionReporting.generate5xxReportingEvent(error, request);
+        }
+      } catch (error) {
+      }
+
+      return errRes;
+    }
+  })
+}
+
 module.exports.wrapServer = function wrappedServer(shim, server) {
   const grpcVersion = shim.require('./package.json').version
   logger.info("Instrumenting @grpc/grpc-js", grpcVersion)
@@ -109,6 +137,7 @@ function wrapStart(shim, original) {
       "path": method,
       "protocol": protocol,
     }
+
     if (request) {
       const traceObject = secUtils.getTraceObject(shim);
       const secMetadata = securityMetaData.getSecurityMetaData(request, urlObj, traceObject, secUtils.getExecutionId(), EVENT_TYPE.HTTP_REQUEST, EVENT_CATEGORY.HTTP)
@@ -256,11 +285,11 @@ function wrapCallback(shim, mod, method) {
           if (arguments[0].details && request) {
             ExceptionReporting.generateExceptionReportingEvent(arguments[0].details, request);
           }
-          //TODO GRPC response errors reporting 
-          // if (arguments[0].code && arguments[0].code > 0 && request) {
-          //   let responseCode = arguments[0].code
-          //   ExceptionReporting.generate5xxReportingEvent(null, request, responseCode);
-          // }
+
+          if (arguments[0].code && responseErrorSet.has(arguments[0].code) && request) {
+            let responseCode = arguments[0].code
+            ExceptionReporting.generate5xxReportingEvent(null, request, responseCode);
+          }
         }
       } catch (error) {
 
@@ -282,7 +311,7 @@ function wrapCallback(shim, mod, method) {
 function addRequestData(shim, type, path, args) {
   const data = Object.assign({});
   try {
-    const transaction = shim.tracer.getTransaction(); 
+    const transaction = shim.tracer.getTransaction();
     if (transaction) {
       data.method = path;
       data.url = path;

lib/instrumentation-security/index.js

@@ -235,6 +235,15 @@ newrelic.instrument({
   }
 })
 
+newrelic.instrument({
+  moduleName: '@grpc/grpc-js/build/src/call',
+  isEsm: true,
+  onRequire: require('./hooks/grpc-js/nr-grpc').wrapCall,
+  onError: function intrumentErrorHandler(err) {
+    logger.error(err.message, err.stack)
+  }
+})
+
 newrelic.instrument({
   moduleName: 'graphql/execution/execute',
   isEsm: true,