Merge branch 'master' into nodejs-doc-restructure

Author: bmorelli25

.ci/downstreamTests.groovy

@@ -11,7 +11,7 @@ it is need as field to store the results of the tests.
 @Field def nodeTasksGen
 
 pipeline {
-  agent any
+  agent { label 'linux && immutable' }
   environment {
     REPO = 'apm-agent-nodejs'
     BASE_DIR="src/github.com/elastic/${REPO}"
@@ -40,7 +40,6 @@ pipeline {
     Checkout the code and stash it, to use it on other stages.
     */
     stage('Checkout') {
-      agent { label 'immutable' }
       options { skipDefaultCheckout() }
       steps {
         deleteDir()
@@ -57,7 +56,6 @@ pipeline {
       Run TAV tests.
     */
     stage('TAV Test') {
-      agent { label 'docker && immutable' }
       options { skipDefaultCheckout() }
       environment {
         HOME = "${env.WORKSPACE}"

.ci/linting.groovy

@@ -2,7 +2,7 @@
 @Library('apm@current') _
 
 pipeline {
-  agent { label 'docker && immutable' }
+  agent { label 'linux && immutable' }
   environment {
     HOME = "${env.WORKSPACE}"
   }

.tav.yml

@@ -55,6 +55,9 @@ pg:
 mongodb-core:
   versions: '>=1.2.19 <4'
   commands: node test/instrumentation/modules/mongodb-core.js
+mongodb:
+  versions: '>=3.3'
+  commands: node test/instrumentation/modules/mongodb.js
 bluebird:
   versions: '>=2 <4'
   commands:

Jenkinsfile

@@ -2,7 +2,7 @@
 @Library('apm@current') _
 
 pipeline {
-  agent any
+  agent { label 'linux && immutable' }
   environment {
     REPO = 'apm-agent-nodejs'
     BASE_DIR = "src/github.com/elastic/${env.REPO}"
@@ -38,7 +38,6 @@ pipeline {
     Checkout the code and stash it, to use it on other stages.
     */
     stage('Checkout') {
-      agent { label 'immutable' }
       options { skipDefaultCheckout() }
       steps {
         deleteDir()
@@ -59,7 +58,6 @@ pipeline {
       Run tests.
     */
     stage('Test') {
-      agent { label 'docker && immutable' }
       options { skipDefaultCheckout() }
       environment {
         HOME = "${env.WORKSPACE}"
@@ -98,7 +96,6 @@ pipeline {
       Run TAV tests.
     */
     stage('TAV Test') {
-      agent { label 'docker && immutable' }
       options { skipDefaultCheckout() }
       environment {
         HOME = "${env.WORKSPACE}"
@@ -157,7 +154,7 @@ pipeline {
       }
       parallel {
         stage('Nightly Test') {
-          agent { label 'docker && immutable' }
+          agent { label 'linux && immutable' }
           environment {
             NVM_NODEJS_ORG_MIRROR = "https://nodejs.org/download/nightly/"
           }
@@ -179,7 +176,7 @@ pipeline {
           }
         }
         stage('Nightly Test - No async hooks') {
-          agent { label 'docker && immutable' }
+          agent { label 'linux && immutable' }
           environment {
             NVM_NODEJS_ORG_MIRROR = "https://nodejs.org/download/nightly/"
           }
@@ -201,7 +198,7 @@ pipeline {
           }
         }
         stage('RC Test') {
-          agent { label 'docker && immutable' }
+          agent { label 'linux && immutablee' }
           environment {
             NVM_NODEJS_ORG_MIRROR = "https://nodejs.org/download/rc/"
           }
@@ -223,7 +220,7 @@ pipeline {
           }
         }
         stage('RC Test - No async hooks') {
-          agent { label 'docker && immutable' }
+          agent { label 'linux && immutable' }
           environment {
             NVM_NODEJS_ORG_MIRROR = "https://nodejs.org/download/rc/"
           }
@@ -328,7 +325,7 @@ def generateStep(Map params = [:]){
   def edge = params.containsKey('edge') ? params.edge : false
   def disableAsyncHooks = params.get('disableAsyncHooks', false)
   return {
-    node('docker && linux && immutable'){
+    node('linux && immutable'){
       try {
         env.HOME = "${WORKSPACE}"
         if (disableAsyncHooks) {
@@ -405,7 +402,7 @@ def getSmartTAVContext() {
 
  def linting(){
    return {
-    node('docker && linux && immutable') {
+    node('linux && immutable') {
       catchError(stageResult: 'UNSTABLE', message: 'Linting failures') {
         withGithubNotify(context: 'Linting') {
           deleteDir()

docs/configuration.asciidoc

@@ -385,6 +385,16 @@ Note that if a custom logger is provided, the `logLevel` option will be ignored.
 
 Whether or not the agent should monitor for uncaught exceptions and send them to the APM Server automatically.
 
+[[log-uncaught-exceptions]]
+==== `logUncaughtExceptions`
+
+* *Type:* Boolean
+* *Default:* `true`
+* *Env:* `ELASTIC_APM_LOG_UNCAUGHT_EXCEPTIONS`
+
+By default the stack trace of uncaught exceptions is written to STDERR.
+Set this config option to `false` to turn this behaviour off.
+
 [[capture-error-log-stack-traces]]
 ==== `captureErrorLogStackTraces`
 

docs/supported-technologies.asciidoc

@@ -84,6 +84,7 @@ The Node.js agent will automatically instrument the following modules to give yo
 A lot of higher level MongoDB modules use mongodb-core,
 so those should be supported as well
 |https://www.npmjs.com/package/mongodb[mongodb] |>=2.0.0 <3.3.0 |Supported via mongodb-core
+|https://www.npmjs.com/package/mongodb[mongodb] |^3.3.0 |Will instrument all queries
 |https://www.npmjs.com/package/mongojs[mongojs] |>=1.0.0 <2.7.0 |Supported via mongodb-core
 |https://www.npmjs.com/package/mongoose[mongoose] |>=4.0.0 <5.7.0 |Supported via mongodb-core
 |https://www.npmjs.com/package/mysql[mysql] |^2.0.0 |Will instrument all queries

lib/agent.js

@@ -337,9 +337,9 @@ Agent.prototype.captureError = function (err, opts, cb) {
     if (captureLocation) {
       // prepare to add a stack trace pointing to where captureError was called
       // from. This can make it easier to debug async stack traces.
-      stackman.callsites(captureLocation, function (_err, callsites) {
-        if (_err) {
-          agent.logger.debug('error while getting capture location callsites: %s', _err.message)
+      stackman.callsites(captureLocation, function (err, callsites) {
+        if (err) {
+          agent.logger.debug('error while getting capture location callsites: %s', err.message)
         }
 
         var next = afterAll(function (_, frames) {
@@ -405,7 +405,13 @@ Agent.prototype.handleUncaughtExceptions = function (cb) {
   }
 
   this._uncaughtExceptionListener = function (err) {
+    // The stack trace of uncaught exceptions are normally written to STDERR.
+    // The `uncaughtException` listener inhibits this behavor, and it's
+    // therefore necessary to manually do this to not break expectations.
+    if (agent._conf.logUncaughtExceptions === true) console.error(err)
+
     agent.logger.debug('Elastic APM caught unhandled exception: %s', err.message)
+
     agent.captureError(err, { handled: false }, function () {
       cb ? cb(err) : process.exit(1)
     })

lib/config.js

@@ -45,6 +45,7 @@ var DEFAULTS = {
   captureExceptions: true,
   captureHeaders: true,
   captureSpanStackTraces: true,
+  centralConfig: true,
   containerId: undefined,
   disableInstrumentations: [],
   environment: process.env.NODE_ENV || 'development',
@@ -53,15 +54,15 @@ var DEFAULTS = {
   filterHttpHeaders: true,
   globalLabels: undefined,
   instrument: true,
+  instrumentIncomingHTTPRequests: true,
   kubernetesNamespace: undefined,
   kubernetesNodeName: undefined,
   kubernetesPodName: undefined,
   kubernetesPodUID: undefined,
   logLevel: 'info',
+  logUncaughtExceptions: true,
   metricsInterval: '30s',
   metricsLimit: 1000,
-  instrumentIncomingHTTPRequests: true,
-  centralConfig: true,
   serverTimeout: '30s',
   sourceLinesErrorAppFrames: 5,
   sourceLinesErrorLibraryFrames: 5,
@@ -87,6 +88,7 @@ var ENV_TABLE = {
   captureExceptions: 'ELASTIC_APM_CAPTURE_EXCEPTIONS',
   captureHeaders: 'ELASTIC_APM_CAPTURE_HEADERS',
   captureSpanStackTraces: 'ELASTIC_APM_CAPTURE_SPAN_STACK_TRACES',
+  centralConfig: 'ELASTIC_APM_CENTRAL_CONFIG',
   containerId: 'ELASTIC_APM_CONTAINER_ID',
   disableInstrumentations: 'ELASTIC_APM_DISABLE_INSTRUMENTATIONS',
   environment: 'ELASTIC_APM_ENVIRONMENT',
@@ -104,10 +106,10 @@ var ENV_TABLE = {
   kubernetesPodName: ['ELASTIC_APM_KUBERNETES_POD_NAME', 'KUBERNETES_POD_NAME'],
   kubernetesPodUID: ['ELASTIC_APM_KUBERNETES_POD_UID', 'KUBERNETES_POD_UID'],
   logLevel: 'ELASTIC_APM_LOG_LEVEL',
+  logUncaughtExceptions: 'ELASTIC_APM_LOG_UNCAUGHT_EXCEPTIONS',
   metricsInterval: 'ELASTIC_APM_METRICS_INTERVAL',
   metricsLimit: 'ELASTIC_APM_METRICS_LIMIT',
   payloadLogFile: 'ELASTIC_APM_PAYLOAD_LOG_FILE',
-  centralConfig: 'ELASTIC_APM_CENTRAL_CONFIG',
   secretToken: 'ELASTIC_APM_SECRET_TOKEN',
   serverTimeout: 'ELASTIC_APM_SERVER_TIMEOUT',
   serverUrl: 'ELASTIC_APM_SERVER_URL',
@@ -144,6 +146,7 @@ var BOOL_OPTS = [
   'filterHttpHeaders',
   'instrument',
   'instrumentIncomingHTTPRequests',
+  'logUncaughtExceptions',
   'usePathAsTransactionName',
   'verifyServerCert'
 ]

lib/instrumentation/index.js

@@ -35,6 +35,7 @@ var MODULES = [
   'memcached',
   'mimic-response',
   'mongodb-core',
+  'mongodb',
   'mysql',
   'mysql2',
   'pg',

lib/instrumentation/modules/mongodb.js

@@ -0,0 +1,45 @@
+'use strict'
+
+const semver = require('semver')
+
+module.exports = (mongodb, agent, { version, enabled }) => {
+  if (!enabled) return mongodb
+  if (!semver.satisfies(version, '>=3.3')) {
+    agent.logger.debug('mongodb version %s not supported - aborting...', version)
+    return mongodb
+  }
+
+  const listener = mongodb.instrument()
+  const activeSpans = new Map()
+
+  listener.on('started', onStart)
+  listener.on('succeeded', onEnd)
+  listener.on('failed', onEnd)
+
+  return mongodb
+
+  function onStart (event) {
+    const name = [
+      event.databaseName,
+      collectionFor(event),
+      event.commandName
+    ].join('.')
+
+    const span = agent.startSpan(name, 'db', 'mongodb', 'query')
+    if (span) {
+      activeSpans.set(event.requestId, span)
+    }
+  }
+
+  function onEnd (event) {
+    if (!activeSpans.has(event.requestId)) return
+    const span = activeSpans.get(event.requestId)
+    activeSpans.delete(event.requestId)
+    span.end((span._timer.start / 1000) + event.duration)
+  }
+
+  function collectionFor (event) {
+    const collection = event.command[event.commandName]
+    return typeof collection === 'string' ? collection : '$cmd'
+  }
+}

package.json

@@ -150,6 +150,7 @@
     "memcached": "^2.2.2",
     "mimic-response": "^2.0.0",
     "mkdirp": "^0.5.1",
+    "mongodb": "^3.3.2",
     "mongodb-core": "^3.2.7",
     "mysql": "^2.17.1",
     "mysql2": "^1.7.0",

test/_mock_http_client_states.js

@@ -0,0 +1,40 @@
+'use strict'
+
+module.exports = function (expectations = [], done) {
+  return {
+    _write (obj, cb) {
+      cb = cb || (() => {})
+
+      const type = Object.keys(obj)[0]
+
+      for (let i = 0; i < expectations.length; i++) {
+        const { find, test } = expectations[i]
+        if (find(type, obj[type])) {
+          expectations.splice(i, 1)
+          if (!expectations.length) {
+            done()
+          }
+          test(obj[type])
+          break
+        }
+      }
+
+      process.nextTick(cb)
+    },
+    sendSpan (span, cb) {
+      this._write({ span }, cb)
+    },
+    sendTransaction (transaction, cb) {
+      this._write({ transaction }, cb)
+    },
+    sendError (error, cb) {
+      this._write({ error }, cb)
+    },
+    sendMetricSet (metricset, cb) {
+      this._write({ metricset }, cb)
+    },
+    flush (cb) {
+      if (cb) process.nextTick(cb)
+    }
+  }
+}

test/config.js

@@ -53,6 +53,7 @@ var optionFixtures = [
   ['kubernetesPodName', 'KUBERNETES_POD_NAME'],
   ['kubernetesPodUID', 'KUBERNETES_POD_UID'],
   ['logLevel', 'LOG_LEVEL', 'info'],
+  ['logUncaughtExceptions', 'LOG_UNCAUGHT_EXCEPTIONS', true],
   ['metricsInterval', 'METRICS_INTERVAL', 30],
   ['metricsLimit', 'METRICS_LIMIT', 1000],
   ['secretToken', 'SECRET_TOKEN'],