newrelic 8.5.1 → 8.7.1

package/NEWS.md

@@ -1,3 +1,83 @@
+### v8.7.1 (2022-01-18)
+
+* Bumped @newrelic/aws-sdk to ^4.1.1.
+
+* Upgraded `@newrelic/test-utilities` to ^6.3.0.
+
+  Includes `helpers.getShim` so sub packages properly execute.
+
+* Resolved dependabot and certain npm audit warnings.
+
+* Automation and CI improvements:
+  * Added a script to be used by agent developers to add a PR to `docs-website` after the release of agent.
+  * Changed the trigger for post release jobs.
+  * Updated the `create-release-tag` script to pass in workflows to check before creating tag.
+    * Fixed `create-release-tag` to properly filter out all async workflow run checks
+    * Updated agent release to pass in a different list of workflows vs the default
+  * Fixed release creation reusable workflow by passing in repo to `bin/create-release-tag.js` and `bin/create-github-release.js`.
+  * Added `workflow_dispatch` to Agent Post Release workflow for manual testing.
+  * Added a reusable workflow to create a release tag, publish to NPM and publish a GitHub release.
+    * Updated agent release workflow to reference reusable workflow.
+    * Added a new workflow to update RPM and publish API docs on a published release event type.
+
+
+### v8.7.0 (2022-01-04)
+
+* Updated `onResolved` instrumentation hook to only be called the first time we see a specific module filepath resolved.
+
+* Removed `tracer.segment` in place of direct usage of context manager.
+
+* Fixed an issue where multiple calls to `instrumentLoadedModule` resulted in re-instrumenting the same module.
+
+* Fixed issue where `instrumentLoadedModule` would return `true` even if the instrumentation handler indicated it did not apply instrumentation.
+
+* Added support metrics for tracking when instrumentation was applied per module.
+
+  * `Supportability/Features/Instrumentation/OnResolved/<module-name>`
+  * `Supportability/Features/Instrumentation/OnResolved/<module-name>/Version/<major version>`
+  * `Supportability/Features/Instrumentation/OnRequire/<module-name>`
+  * `Supportability/Features/Instrumentation/OnRequire/<module-name>/Version/<major version>`
+
+* Fixed issue where expected status code ranges would not be parsed until ignored status codes were also defined.
+
+* Added an input `changelog_file` to pass in name of changelog.  This defaults to `NEWS.md` but some repos use `CHANGELOG.md`
+
+* Abstracted `bin/prepare-release.js` to work against other repositories.
+
+* Added reusable prepare-release workflow that can be referenced in all other newrelic Node.js repositories.
+
+* Updated pending PRs workflow to check all repos the team owns.
+
+* Changed the event type from `pull_request` to `pull_request_target` to allow for auto assign of PRs to the Node.js Engineering Board
+
+* Fixed add to board workflow to properly pass repository secrets into reusable board workflow.
+
+* Changes token used to post issues to org level project board
+
+* Runs versioned tests for external modules against tests defined in the external repository instead of tests published in npm modules.
+
+* Added a reusable workflow to automatically add issues to the Node.js Engineering Board when created.
+
+* Added CI job to update system configurations with new agent version on release.
+
+* Moved `methods.js` under bluebird versioned test folder.
+
+### v8.6.0 (2021-11-17)
+
+* Added `onResolved` instrumentation hook to apply instrumentation prior to module load.
+
+  This hook fires after the module filepath has been resolved just prior to the module being loaded by the CommonJS module loader.
+
+* Fixed issue where `recordConsume` was not binding consumer if it was a promise
+
+* Pinned mongo versioned tests to `<4.2.0` until we can address https://github.com/newrelic/node-newrelic/issues/982
+
+* Introduced a context management API to be used in place of manually calling tracer.segment get/set.
+
+### v8.5.2 (2021-11-09)
+
+* Fixed issue where unhandled promise rejections were not getting logged as errors in a lambda execution
+
 ### v8.5.1 (2021-11-03)
 
 * Fixed bug where failure to retrieve CPU/Memory details for certain Linux distros could result in a crash.

package/THIRD_PARTY_NOTICES.md

@@ -504,7 +504,7 @@ This product includes source derived from [@grpc/proto-loader](https://github.co
 
 ### @newrelic/aws-sdk
 
-This product includes source derived from [@newrelic/aws-sdk](https://github.com/newrelic/node-newrelic-aws-sdk) ([v4.0.1](https://github.com/newrelic/node-newrelic-aws-sdk/tree/v4.0.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-aws-sdk/blob/v4.0.1/LICENSE):
+This product includes source derived from [@newrelic/aws-sdk](https://github.com/newrelic/node-newrelic-aws-sdk) ([v4.1.1](https://github.com/newrelic/node-newrelic-aws-sdk/tree/v4.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-newrelic-aws-sdk/blob/v4.1.1/LICENSE):
 
 ```
                                  Apache License
@@ -1770,7 +1770,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ### @newrelic/test-utilities
 
-This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.1.1](https://github.com/newrelic/node-test-utilities/tree/v6.1.1)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.1.1/LICENSE):
+This product includes source derived from [@newrelic/test-utilities](https://github.com/newrelic/node-test-utilities) ([v6.3.0](https://github.com/newrelic/node-test-utilities/tree/v6.3.0)), distributed under the [Apache-2.0 License](https://github.com/newrelic/node-test-utilities/blob/v6.3.0/LICENSE):
 
 ```
                                  Apache License
@@ -3292,7 +3292,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ### tap
 
-This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v15.0.10](https://github.com/tapjs/node-tap/tree/v15.0.10)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v15.0.10/LICENSE):
+This product includes source derived from [tap](https://github.com/tapjs/node-tap) ([v15.1.6](https://github.com/tapjs/node-tap/tree/v15.1.6)), distributed under the [ISC License](https://github.com/tapjs/node-tap/blob/v15.1.6/LICENSE):
 
 ```
 The ISC License

package/api.js

@@ -14,7 +14,6 @@ const hashes = require('./lib/util/hashes')
 const properties = require('./lib/util/properties')
 const stringify = require('json-stringify-safe')
 const shimmer = require('./lib/shimmer')
-const shims = require('./lib/shim')
 const isValidType = require('./lib/util/attribute-types')
 const TransactionShim = require('./lib/shim/transaction-shim')
 const TransactionHandle = require('./lib/transaction/handle')
@@ -55,7 +54,8 @@ const CUSTOM_EVENT_TYPE_REGEX = /^[a-zA-Z0-9:_ ]+$/
  * You do not need to directly instantiate this class, as an instance of this is
  * the return from `require('newrelic')`.
  *
- * @constructor
+ * @param agent
+ * @class
  */
 function API(agent) {
   this.agent = agent
@@ -139,6 +139,7 @@ API.prototype.getTransaction = function getTransaction() {
  *   utilization.full_hostname. If utilization.full_hostname is null or empty,
  *   this will be the hostname specified in the connect request as host.
  *
+ * @param omitSupportability
  * @returns {LinkingMetadata} The linking object with the data above
  */
 API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportability) {
@@ -186,7 +187,6 @@ API.prototype.getLinkingMetadata = function getLinkingMetadata(omitSupportabilit
  *
  * @param {string} name The string you would like to report to New Relic
  *                      as the dispatcher.
- *
  * @param {string} [version] The dispatcher version you would like to
  *                           report to New Relic
  */
@@ -414,7 +414,6 @@ API.prototype.addCustomSpanAttribute = function addCustomSpanAttribute(key, valu
  *
  * @param {Error} error
  *  The error to be traced.
- *
  * @param {object} [customAttributes]
  *  Optional. Any custom attributes to be displayed in the New Relic UI.
  */
@@ -526,7 +525,7 @@ API.prototype.addIgnoringRule = function addIgnoringRule(pattern) {
  * Do *not* reuse the headers between users, or even between requests.
  *
  * @param {string} [options.nonce] - Nonce to inject into `<script>` header.
- *
+ * @param options
  * @returns {string} The `<script>` header to be injected.
  */
 API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options) {
@@ -545,7 +544,7 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
    *
    * @param {number} num          - Error code from `RUM_ISSUES`.
    * @param {bool} [quite=false]  - Be quiet about this failure.
-   *
+   * @param quiet
    * @see RUM_ISSUES
    */
   function _gracefail(num, quiet) {
@@ -687,9 +686,9 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
 
 /**
  * @callback startSegmentCallback
- * @param {function} cb
+ * @param {Function} cb
  *   The function to time with the created segment.
- * @return {Promise=} Returns a promise if cb returns a promise.
+ * @returns {Promise=} Returns a promise if cb returns a promise.
  */
 
 /**
@@ -701,23 +700,18 @@ API.prototype.getBrowserTimingHeader = function getBrowserTimingHeader(options)
  *    // The returned promise here will signify the end of the segment.
  *    return myAsyncTask().then(myNextTask)
  *  })
- *
  * @param {string} name
  *  The name to give the new segment. This will also be the name of the metric.
- *
  * @param {bool} record
  *  Indicates if the segment should be recorded as a metric. Metrics will show
  *  up on the transaction breakdown table and server breakdown graph. Segments
  *  just show up in transaction traces.
- *
  * @param {startSegmentCallback} handler
  *  The function to track as a segment.
- *
- * @param {function} [callback]
+ * @param {Function} [callback]
  *  An optional callback for the handler. This will indicate the end of the
  *  timing if provided.
- *
- * @return {*} Returns the result of calling `handler`.
+ * @returns {*} Returns the result of calling `handler`.
  */
 API.prototype.startSegment = function startSegment(name, record, handler, callback) {
   this.agent.metrics
@@ -775,11 +769,9 @@ API.prototype.startSegment = function startSegment(name, record, handler, callba
  *     transaction.end()
  *   }, 100)
  * })
- *
  * @param {string} url
  *  The URL of the transaction.  It is used to name and group related transactions in APM,
  *  so it should be a generic name and not iclude any variable parameters.
- *
  * @param {Function}  handle
  *  Function that represents the transaction work.
  */
@@ -862,20 +854,16 @@ API.prototype.startBackgroundTransaction = startBackgroundTransaction
  *     transaction.end()
  *   }, 100)
  * })
- *
  * @param {string} name
  *  The name of the transaction. It is used to name and group related
  *  transactions in APM, so it should be a generic name and not iclude any
  *  variable parameters.
- *
  * @param {string} [group]
  *  Optional, used for grouping background transactions in APM. For more
  *  information see:
  *  https://docs.newrelic.com/docs/apm/applications-menu/monitoring/transactions-page#txn-type-dropdown
- *
  * @param {Function} handle
  *  Function that represents the background work.
- *
  * @memberOf API#
  */
 function startBackgroundTransaction(name, group, handle) {
@@ -972,9 +960,9 @@ API.prototype.endTransaction = function endTransaction() {
  * Record a custom metric, usually associated with a particular duration.
  * The `name` must be a string following standard metric naming rules. The `value` will
  * usually be a number, but it can also be an object.
- *   * When `value` is a numeric value, it should represent the magnitude of a measurement
+ *   When `value` is a numeric value, it should represent the magnitude of a measurement
  *     associated with an event; for example, the duration for a particular method call.
- *   * When `value` is an object, it must contain count, total, min, max, and sumOfSquares
+ *   When `value` is an object, it must contain count, total, min, max, and sumOfSquares
  *     keys, all with number values. This form is useful to aggregate metrics on your own
  *     and report them periodically; for example, from a setInterval. These values will
  *     be aggregated with any previously collected values for the same metric. The names
@@ -1151,18 +1139,15 @@ API.prototype.recordCustomEvent = function recordCustomEvent(eventType, attribut
  *  - `newrelic.instrument(moduleName, onRequire [,onError])`
  *  - `newrelic.instrument(options)`
  *
- * @param {object} options
- *  The options for this custom instrumentation.
- *
- * @param {string} options.moduleName
- *  The module name given to require to load the module
- *
- * @param {function}  options.onRequire
- *  The function to call when the module is required
- *
- * @param {function} [options.onError]
- *  If provided, should `onRequire` throw an error, the error will be passed to
+ * @param {object} options The options for this custom instrumentation.
+ * @param {string} options.moduleName The module name given to require to load the module
+ * @param {Function}  options.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {Function}  options.onRequire The function to call when the module has been loaded
+ * @param {Function} [options.onError] If provided, should `onRequire` throw an error, the error will be passed to
  *  this function.
+ * @param moduleName
+ * @param onRequire
+ * @param onError
  */
 API.prototype.instrument = function instrument(moduleName, onRequire, onError) {
   const metric = this.agent.metrics.getOrCreateMetric(NAMES.SUPPORTABILITY.API + '/instrument')
@@ -1187,18 +1172,15 @@ API.prototype.instrument = function instrument(moduleName, onRequire, onError) {
  * - `newrelic.instrumentConglomerate(moduleName, onRequire [, onError])`
  * - `newrelic.isntrumentConglomerate(options)`
  *
- * @param {object} options
- *  The options for this custom instrumentation.
- *
- * @param {string} options.moduleName
- *  The module name given to require to load the module
- *
- * @param {function} options.onRequire
- *  The function to call when the module is required
- *
- * @param {function} [options.onError]
- *  If provided, should `onRequire` throw an error, the error will be passed to
+ * @param {object} options The options for this custom instrumentation.
+ * @param {string} options.moduleName The module name given to require to load the module
+ * @param {Function}  options.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {Function}  options.onRequire The function to call when the module has been loaded
+ * @param {Function} [options.onError] If provided, should `onRequire` throw an error, the error will be passed to
  *  this function.
+ * @param moduleName
+ * @param onRequire
+ * @param onError
  */
 API.prototype.instrumentConglomerate = function instrumentConglomerate(
   moduleName,
@@ -1224,18 +1206,15 @@ API.prototype.instrumentConglomerate = function instrumentConglomerate(
  *  - `newrelic.instrumentDatastore(moduleName, onRequire [,onError])`
  *  - `newrelic.instrumentDatastore(options)`
  *
- * @param {object} options
- *  The options for this custom instrumentation.
- *
- * @param {string} options.moduleName
- *  The module name given to require to load the module
- *
- * @param {function} options.onRequire
- *  The function to call when the module is required
- *
- * @param {function} [options.onError]
- *  If provided, should `onRequire` throw an error, the error will be passed to
+ * @param {object} options The options for this custom instrumentation.
+ * @param {string} options.moduleName The module name given to require to load the module
+ * @param {Function}  options.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {Function}  options.onRequire The function to call when the module has been loaded
+ * @param {Function} [options.onError] If provided, should `onRequire` throw an error, the error will be passed to
  *  this function.
+ * @param moduleName
+ * @param onRequire
+ * @param onError
  */
 API.prototype.instrumentDatastore = function instrumentDatastore(moduleName, onRequire, onError) {
   const metric = this.agent.metrics.getOrCreateMetric(
@@ -1256,77 +1235,21 @@ API.prototype.instrumentDatastore = function instrumentDatastore(moduleName, onR
   shimmer.registerInstrumentation(opts)
 }
 
-/**
- * Applies an instrumentation to an already loaded module.
- *
- *    // oh no, express was loaded before newrelic
- *    const express   = require('express')
- *    const newrelic  = require('newrelic')
- *
- *    // phew, we can use instrumentLoadedModule to make
- *    // sure express is still instrumented
- *    newrelic.instrumentLoadedModule('express', express)
- *
- * @param {string} moduleName
- *  The module's name/identifier.  Will be normalized
- *  into an instrumentation key.
- *
- * @param {object} module
- *  The actual module object or function we're instrumenting
- */
-API.prototype.instrumentLoadedModule = function instrumentLoadedModule(moduleName, module) {
-  const metric = this.agent.metrics.getOrCreateMetric(
-    NAMES.SUPPORTABILITY.API + '/instrumentLoadedModule'
-  )
-  metric.incrementCallCount()
-  try {
-    const instrumentationName = shimmer.getInstrumentationNameFromModuleName(moduleName)
-    if (!shimmer.registeredInstrumentations[instrumentationName]) {
-      logger.warn("No instrumentation registered for '%s'.", instrumentationName)
-      return false
-    }
-
-    const instrumentation = shimmer.registeredInstrumentations[instrumentationName]
-    if (!instrumentation.onRequire) {
-      logger.warn("No onRequire function registered for '%s'.", instrumentationName)
-      return false
-    }
-
-    const resolvedName = require.resolve(moduleName)
-
-    const shim = shims.createShimFromType(
-      instrumentation.type,
-      this.agent,
-      moduleName,
-      resolvedName
-    )
-
-    instrumentation.onRequire(shim, module, moduleName)
-
-    return true
-  } catch (error) {
-    logger.error('instrumentLoadedModule encountered an error, module not instrumentend: %s', error)
-  }
-}
-
 /**
  * Registers an instrumentation function.
  *
  *  - `newrelic.instrumentWebframework(moduleName, onRequire [,onError])`
  *  - `newrelic.instrumentWebframework(options)`
  *
- * @param {object} options
- *  The options for this custom instrumentation.
- *
- * @param {string} options.moduleName
- *  The module name given to require to load the module
- *
- * @param {function}  options.onRequire
- *  The function to call when the module is required
- *
- * @param {function} [options.onError]
- *  If provided, should `onRequire` throw an error, the error will be passed to
+ * @param {object} options The options for this custom instrumentation.
+ * @param {string} options.moduleName The module name given to require to load the module
+ * @param {Function}  options.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {Function}  options.onRequire The function to call when the module has been loaded
+ * @param {Function} [options.onError] If provided, should `onRequire` throw an error, the error will be passed to
  *  this function.
+ * @param moduleName
+ * @param onRequire
+ * @param onError
  */
 API.prototype.instrumentWebframework = function instrumentWebframework(
   moduleName,
@@ -1357,18 +1280,15 @@ API.prototype.instrumentWebframework = function instrumentWebframework(
  *  - `newrelic.instrumentMessages(moduleName, onRequire [,onError])`
  *  - `newrelic.instrumentMessages(options)`
  *
- * @param {object} options
- *  The options for this custom instrumentation.
- *
- * @param {string} options.moduleName
- *  The module name given to require to load the module
- *
- * @param {function}  options.onRequire
- *  The function to call when the module is required
- *
- * @param {function} [options.onError]
- *  If provided, should `onRequire` throw an error, the error will be passed to
+ * @param {object} options The options for this custom instrumentation.
+ * @param {string} options.moduleName The module name given to require to load the module
+ * @param {Function}  options.onResolved The function to call prior to module load after the filepath has been resolved
+ * @param {Function}  options.onRequire The function to call when the module has been loaded
+ * @param {Function} [options.onError] If provided, should `onRequire` throw an error, the error will be passed to
  *  this function.
+ * @param moduleName
+ * @param onRequire
+ * @param onError
  */
 API.prototype.instrumentMessages = function instrumentMessages(moduleName, onRequire, onError) {
   const metric = this.agent.metrics.getOrCreateMetric(
@@ -1389,6 +1309,40 @@ API.prototype.instrumentMessages = function instrumentMessages(moduleName, onReq
   shimmer.registerInstrumentation(opts)
 }
 
+/**
+ * Applies an instrumentation to an already loaded module.
+ *
+ *    // oh no, express was loaded before newrelic
+ *    const express   = require('express')
+ *    const newrelic  = require('newrelic')
+ *
+ *    // phew, we can use instrumentLoadedModule to make
+ *    // sure express is still instrumented
+ *    newrelic.instrumentLoadedModule('express', express)
+ *
+ * @param {string} moduleName
+ *  The module's name/identifier.  Will be normalized
+ *  into an instrumentation key.
+ * @param {object} module
+ *  The actual module object or function we're instrumenting
+ */
+API.prototype.instrumentLoadedModule = function instrumentLoadedModule(moduleName, module) {
+  const metric = this.agent.metrics.getOrCreateMetric(
+    NAMES.SUPPORTABILITY.API + '/instrumentLoadedModule'
+  )
+  metric.incrementCallCount()
+
+  try {
+    const resolvedName = require.resolve(moduleName)
+
+    return shimmer.instrumentPostLoad(this.agent, module, moduleName, resolvedName)
+  } catch (error) {
+    logger.error('instrumentLoadedModule encountered an error, module not instrumented: %s', error)
+  }
+
+  return false
+}
+
 /**
  * Returns the current trace and span id.
  *
@@ -1424,19 +1378,16 @@ API.prototype.getTraceMetadata = function getTraceMetadata() {
  *
  * @param {object} [options]
  *  Object with shut down options.
- *
  * @param {boolean} [options.collectPendingData=false]
  *  If true, the agent will send any pending data to the collector before
  *  shutting down.
- *
  * @param {number} [options.timeout=0]
  *  Time in milliseconds to wait before shutting down.
- *
  * @param {boolean} [options.waitForIdle=false]
  *  If true, the agent will not shut down until there are no active transactions.
- *
- * @param {function} [callback]
+ * @param {Function} [callback]
  *  Callback function that runs when agent stops.
+ * @param cb
  */
 API.prototype.shutdown = function shutdown(options, cb) {
   this.agent.metrics.getOrCreateMetric(`${NAMES.SUPPORTABILITY.API}/shutdown`).incrementCallCount()
@@ -1458,6 +1409,11 @@ API.prototype.shutdown = function shutdown(options, cb) {
   _doShutdown(this, options, callback)
 }
 
+/**
+ * @param api
+ * @param options
+ * @param callback
+ */
 function _doShutdown(api, options, callback) {
   const agent = api.agent
 
@@ -1473,6 +1429,9 @@ function _doShutdown(api, options, callback) {
     return
   }
 
+  /**
+   * @param error
+   */
   function afterHarvest(error) {
     if (error) {
       logger.error(error, 'An error occurred while running last harvest before shutdown.')
@@ -1506,6 +1465,10 @@ function _doShutdown(api, options, callback) {
   }
 }
 
+/**
+ * @param object
+ * @param maxLength
+ */
 function _checkKeyLength(object, maxLength) {
   const keys = Object.keys(object)
   let badKey = false
@@ -1534,6 +1497,10 @@ API.prototype.setLambdaHandler = function setLambdaHandler(handler) {
   return this.awsLambda.patchLambdaHandler(handler)
 }
 
+/**
+ * @param attributes
+ * @param name
+ */
 function _filterAttributes(attributes, name) {
   const filteredAttributes = Object.create(null)
   Object.keys(attributes).forEach((attributeKey) => {

package/lib/agent.js

@@ -29,6 +29,7 @@ const TxSegmentNormalizer = require('./metrics/normalizer/tx_segment')
 const uninstrumented = require('./uninstrumented')
 const util = require('util')
 const createSpanEventAggregator = require('./spans/create-span-event-aggregator')
+const createContextManager = require('./context-manager/create-context-manager')
 
 // Map of valid states to whether or not data collection is valid
 const STATES = {
@@ -53,6 +54,8 @@ const DEFAULT_HARVEST_INTERVAL_MS = 60000
  * This constructor can throw if, for some reason, the configuration isn't
  * available. Don't try to recover here, because without configuration the
  * agent can't be brought up to a useful state.
+ *
+ * @param config
  */
 function Agent(config) {
   EventEmitter.call(this)
@@ -136,8 +139,9 @@ function Agent(config) {
 
   this.errors = new ErrorCollector(config, errorTraceAggregator, errorEventAggregator, this.metrics)
 
+  this._contextManager = createContextManager(this.config)
   // Transaction tracing.
-  this.tracer = new Tracer(this)
+  this.tracer = new Tracer(this, this._contextManager)
   this.traces = new TransactionTraceAggregator(
     {
       periodMs: DEFAULT_HARVEST_INTERVAL_MS,
@@ -185,7 +189,6 @@ util.inherits(Agent, EventEmitter)
  * the configuration.
  *
  * @config {boolean} agent_enabled Whether to start up the agent.
- *
  * @param {Function} callback Continuation and error handler.
  */
 Agent.prototype.start = function start(callback) {
@@ -248,6 +251,7 @@ Agent.prototype.start = function start(callback) {
 
 /**
  * Forces all aggregators to send the data collected.
+ *
  * @param {Function} callback The callback to invoke when all data types have been sent.
  */
 Agent.prototype.forceHarvestAll = function forceHarvestAll(callback) {
@@ -416,6 +420,9 @@ Agent.prototype.startAggregators = function startAggregators() {
 /**
  * Completes any final setup upon full connection to New Relic
  * servers and sets the agent state to 'started'.
+ *
+ * @param shouldImmediatelyHarvest
+ * @param callback
  */
 Agent.prototype.onConnect = function onConnect(shouldImmediatelyHarvest, callback) {
   this._reconfigureAggregators(this.config)
@@ -485,6 +492,8 @@ Agent.prototype._serverlessModeStart = function _serverlessModeStart(callback) {
  * FIXME: make it possible to dispose of the agent, as well as do a
  * "hard" restart. This requires working with shimmer to strip the
  * current instrumentation and patch to the module loader.
+ *
+ * @param callback
  */
 Agent.prototype.stop = function stop(callback) {
   if (!callback) {