feat: implemented span stack trace configuration

packages/collector/test/tracing/databases/couchbase/test.js

@@ -45,7 +45,7 @@ const verifyCouchbaseSpan = (controls, entrySpan, options = {}) => [
   span => expect(span.data.couchbase.sql).to.contain(options.sql || 'GET'),
   span =>
     options.error
-      ? expect(span.data.couchbase.error).to.equal(options.error)
+      ? expect(span.data.couchbase.error).to.contain(options.error)
       : expect(span.data.couchbase.error).to.not.exist
 ];
 

packages/collector/test/tracing/databases/mysql/app.js

@@ -200,6 +200,14 @@ app.post('/valuesAndCall', (req, res) => {
   }
 });
 
+app.post('/error', (req, res) => {
+  if (driver === 'mysql2/promise') {
+    triggerErrorWithPromises(req, res);
+  } else {
+    triggerError(req, res);
+  }
+});
+
 app.listen(port, () => {
   log(
     `Listening on port: ${process.env.APP_PORT} (driver: ${driver}, access: ${accessFunction}, cluster: ${useCluster})`
@@ -305,6 +313,49 @@ function insertValuesWithPromisesAndCall(req, res) {
     });
 }
 
+function triggerError(req, res) {
+  pool.getConnection((err, connection) => {
+    if (err) {
+      log('Failed to get connection', err);
+      res.sendStatus(500);
+      return;
+    }
+
+    connection[accessFunction]('SELECT * FROM non_existent_table', queryError => {
+      connection.release();
+
+      if (queryError) {
+        log('Expected error occurred', queryError);
+        res.sendStatus(500);
+        return;
+      }
+
+      res.sendStatus(200);
+    });
+  });
+}
+
+function triggerErrorWithPromises(req, res) {
+  pool
+    .getConnection()
+    .then(connection => {
+      wrapAccess(connection, 'SELECT * FROM non_existent_table', null, queryError => {
+        connection.release();
+
+        if (queryError) {
+          log('Expected error occurred', queryError);
+          res.sendStatus(500);
+        } else {
+          res.sendStatus(200);
+        }
+      });
+    })
+    .catch(err => {
+      log('Failed to get connection', err);
+      res.sendStatus(500);
+    });
+}
+
 function log() {
   const args = Array.prototype.slice.call(arguments);
   args[0] = logPrefix + args[0];

packages/collector/test/tracing/databases/mysql/test.js

@@ -320,4 +320,36 @@ function test(env, agentControls) {
           })
         );
       }));
+
+  it('must replace stack trace with error stack when query fails', () =>
+    controls
+      .sendRequest({
+        method: 'POST',
+        path: '/error'
+      })
+      .then(() =>
+        testUtils.retry(() =>
+          agentControls.getSpans().then(spans => {
+            expect(spans.length).to.equal(2);
+            const entrySpan = testUtils.expectAtLeastOneMatching(spans, [
+              span => expect(span.n).to.equal('node.http.server'),
+              span => expect(span.f.e).to.equal(String(controls.getPid())),
+              span => expect(span.f.h).to.equal('agent-stub-uuid')
+            ]);
+
+            const mysqlSpan = testUtils.expectAtLeastOneMatching(spans, [
+              span => expect(span.t).to.equal(entrySpan.t),
+              span => expect(span.p).to.equal(entrySpan.s),
+              span => expect(span.n).to.equal('mysql'),
+              span => expect(span.k).to.equal(constants.EXIT),
+              span => expect(span.f.e).to.equal(String(controls.getPid())),
+              span => expect(span.f.h).to.equal('agent-stub-uuid'),
+              span => expect(span.ec).to.equal(1),
+              span => expect(span.data.mysql.error).to.exist
+            ]);
+
+            expect(mysqlSpan.stack).to.exist;
+          })
+        )
+      ));
 }

packages/collector/test/tracing/databases/pg_native/test.js

@@ -290,6 +290,7 @@ mochaSuiteFn('tracing/pg-native', function () {
     return expectAtLeastOneMatching(spans, span => {
       verifyPgExitBase(span, parent, statement);
       expect(span.error).to.not.exist;
+      expect(span.stack).to.exist;
       expect(span.ec).to.equal(1);
       expect(span.data.pg.error).to.contain(errorMessage);
     });

packages/collector/test/tracing/messaging/node-rdkafka/test_definition.js

@@ -272,10 +272,10 @@ module.exports.run = function ({
       span => expect(span.ec).to.equal(!withError ? 0 : 1),
       span => (!withError ? expect(span.data.kafka.error).to.not.exist : ''),
       span =>
-        withError === 'deliveryErrorSender' ? expect(span.data.kafka.error).to.equal('delivery fake error') : '',
+        withError === 'deliveryErrorSender' ? expect(span.data.kafka.error).to.contain('delivery fake error') : '',
       span =>
         withError === 'bufferErrorSender'
-          ? expect(span.data.kafka.error).to.equal('Message must be a buffer or null')
+          ? expect(span.data.kafka.error).to.contain('Message must be a buffer or null')
           : ''
     ]);
   }

packages/collector/test/tracing/misc/stack_trace/test.js

@@ -130,6 +130,7 @@ const mochaSuiteFn = supportedVersion(process.versions.node) ? describe : descri
                 testUtils.expectAtLeastOneMatching(spans, [
                   span => expect(span.n).to.equal('node.http.client'),
                   span => expect(span.k).to.equal(constants.EXIT),
+                  span => expect(span.data.http.status).to.equal(201),
                   span => expect(span.stack[2].m).to.equal('fetch'),
                   span => expect(span.stack[2].c).to.contains('node-fetch')
                 ]);

packages/collector/test/tracing/protocols/http/client/test.js

@@ -633,7 +633,8 @@ function registerTests(appUsesHttps) {
                 expect(span.data.http.error).to.match(/Invalid URL/);
               },
               span => expect(span.t).to.equal(entrySpan.t),
-              span => expect(span.p).to.equal(entrySpan.s)
+              span => expect(span.p).to.equal(entrySpan.s),
+              span => expect(span.stack).to.be.a('string')
             ]);
             expectExactlyOneMatching(spans, span => {
               expect(span.n).to.equal('node.http.client');

packages/collector/test/tracing/protocols/http/native_fetch/test.js

@@ -853,12 +853,11 @@ function verifyHttpExit({
       expectedClientError = `Failed to parse URL from http:127.0.0.1:${serverControls.port}malformed-url`;
     }
     expectations.push(span => expect(span.data.http.status).to.not.exist);
-    expectations.push(span => expect(span.data.http.error).to.equal(expectedClientError));
+    expectations.push(span => expect(span.data.http.error).to.contain(expectedClientError));
   } else if (withTimeout) {
     expectations.push(span => expect(span.data.http.status).to.not.exist);
     // Early v18.x Node.js versions had "The operation was aborted", the message later changed to
-    // "The operation was aborted due to timeout".
-    expectations.push(span => expect(span.data.http.error).to.match(/^The operation was aborted(?: due to timeout)?/));
+    expectations.push(span => expect(span.data.http.error).to.contain('The operation was aborted due to timeout'));
   } else {
     expectations.push(span => expect(span.data.http.status).to.equal(status));
     expectations.push(span => expect(span.data.http.error).to.not.exist);

packages/core/src/tracing/instrumentation/cloud/aws-sdk/v2/sqs.js

@@ -392,7 +392,7 @@ function finishSpan(err, data, span) {
 function addErrorToSpan(err, span) {
   if (err) {
     span.ec = 1;
-    span.data.sqs.error = err.message || err.code || JSON.stringify(err);
+    tracingUtil.setErrorDetails(span, err, 'sqs');
   }
 }
 

packages/core/src/tracing/instrumentation/cloud/aws-sdk/v3/instana_aws_product.js

@@ -48,9 +48,8 @@ class InstanaAWSProduct {
   addErrorToSpan(err, span) {
     if (err) {
       span.ec = 1;
-      const spanData = span.data && span.data[this.spanName];
-      if (spanData) {
-        spanData.error = err.message || err.code || JSON.stringify(err);
+      if (span.data?.[this.spanName]) {
+        span.data[this.spanName].error = err.message || err.code || JSON.stringify(err);
       }
     }
   }

packages/core/src/tracing/instrumentation/cloud/aws-sdk/v3/sqs-consumer.js

@@ -7,6 +7,7 @@
 const shimmer = require('../../../../shimmer');
 const hook = require('../../../../../util/hook');
 const cls = require('../../../../cls');
+const tracingUtil = require('../../../../tracingUtil');
 
 function init() {
   hook.onModuleLoad('sqs-consumer', instrument);
@@ -30,7 +31,7 @@ function instrument(SQSConsumer) {
             })
             .catch(err => {
               span.ec = 1;
-              span.data.sqs.error = err.message || err.code || JSON.stringify(err);
+              tracingUtil.setErrorDetails(span, err, 'sqs');
               span.d = Date.now() - span.ts;
               span.transmitManual();
             });
@@ -62,7 +63,7 @@ function instrument(SQSConsumer) {
             })
             .catch(err => {
               span.ec = 1;
-              span.data.sqs.error = err.message || err.code || JSON.stringify(err);
+              tracingUtil.setErrorDetails(span, err, 'sqs');
               span.d = Date.now() - span.ts;
               span.transmitManual();
             });

packages/core/src/tracing/instrumentation/cloud/azure/blob.js

@@ -105,7 +105,7 @@ function instrumentingOperation({
 function finishSpan(error, span) {
   if (error) {
     span.ec = 1;
-    span.data.azstorage.error = tracingUtil.getErrorDetails(error);
+    tracingUtil.setErrorDetails(span, error, 'azstorage');
   }
   span.d = Date.now() - span.ts;
   span.transmit();

packages/core/src/tracing/instrumentation/cloud/gcp/pubsub.js

@@ -254,11 +254,7 @@ function finishSpan(err, messageId, span) {
 function addErrorToSpan(err, span) {
   if (err) {
     span.ec = 1;
-    if (err.message) {
-      span.data.gcps.error = err.message;
-    } else if (typeof err === 'string') {
-      span.data.gcps.error = err;
-    }
+    tracingUtil.setErrorDetails(span, err, 'gcps');
   }
 }
 

packages/core/src/tracing/instrumentation/cloud/gcp/storage.js

@@ -458,7 +458,7 @@ function instrumentedCreateStream(operation, bindEvent, finalEvent, ctx, origina
 function finishSpan(error, result, span, extractorPost) {
   if (error) {
     span.ec = 1;
-    span.data.gcs.error = tracingUtil.getErrorDetails(error);
+    tracingUtil.setErrorDetails(span, error, 'gcs');
   }
 
   if (extractorPost) {

packages/core/src/tracing/instrumentation/databases/couchbase.js

@@ -430,7 +430,7 @@ function instrumentTransactions(cluster, connectionStr) {
                     result
                       .catch(err => {
                         span.ec = 1;
-                        span.data.couchbase.error = tracingUtil.getErrorDetails(err);
+                        tracingUtil.setErrorDetails(span, err, 'couchbase');
                       })
                       .finally(() => {
                         span.d = Date.now() - span.ts;
@@ -497,7 +497,7 @@ function instrumentOperation({ connectionStr, bucketName, getBucketTypeFn, sql,
             })
             .catch(err => {
               span.ec = 1;
-              span.data.couchbase.error = tracingUtil.getErrorDetails(err);
+              tracingUtil.setErrorDetails(span, err, 'couchbase');
             })
             .finally(() => {
               span.d = Date.now() - span.ts;
@@ -510,7 +510,7 @@ function instrumentOperation({ connectionStr, bucketName, getBucketTypeFn, sql,
         originalArgs[callbackIndex] = cls.ns.bind(function instanaCallback(err, result) {
           if (err) {
             span.ec = 1;
-            span.data.couchbase.error = tracingUtil.getErrorDetails(err);
+            tracingUtil.setErrorDetails(span, err, 'couchbase');
           }
 
           if (resultHandler) {