Notes
Changed
attributes.enabled
totrue
by default.In the previous version we defaulted this to
false
to maintain parity withcapture_params
which defaulted tofalse
. However, this is a invalid parity becauseattribute.enabled
controls more attributes thancapture_params
.
Improvements
Removed unnecessary checks around
Timer.unref()
calls.unref
has been supported since Node v0.9, meaning it will always be present in timers set by the agent (with 0.10 being the earliest supported version).Added a split in the node versions for the
mysql2
andcassandra
versioned tests.As of
mysql2
v1.3.1 andcassandra
v3.4.0 the minimum supported version of Node is 4.Replaced as many instances of
{}
as possible withObject.create(null)
.Removed extraneous logger arg in
addCustomAttribute
call.
Bug fixes
The agent will no longer generate browser data for ignored transactions.
Expanded Hapi instrumentation to support route
pre
handlers.This is a Hapi route config option that was previously uninstrumented, causing transaction names to become invalid. This expanded instrumentation ensures that all additional handlers are wrapped and associated with the main route.
New features
Added agent attribute filtering via include and exclude rules.
Agent attributes can now be controlled using fine grained include and exclude rules. These rules, described below, replace
capture_params
andignored_params
. Any attributes listed inignored_params
will be migrated toattributes.exclude
internally, unlessattributes.exclude
is explicitly set.There are three new configuration properties added to the root config and each destination (more on destinations later). These new configurations are:
attributes.enabled
- Enables collection of attributes for the destination.attributes.include
- A list of attributes or wildcard rules to include.attributes.exclude
- A list of attributes or wildcard rules to exclude.
The include and exclude rules can be exact rules (for example
request.headers.contentLength
), or wildcard rules which match just the beginning of attribute keys (for examplerequest.headers.*
would match any request header).These rules can be specified globally at the root of the configuration, or for specific destinations. These destinations are:
transaction_tracer
- Controls transaction trace attributes.transaction_events
- Controls transaction event attributes.error_collector
- Controls error event attributes.browser_monitoring
- Controls browser/RUM transaction attributes.
Renamed
addCustomParameter
toaddCustomAttribute
.The
addCustomParameter
method is now deprecated and will be removed in a future release of the agent. TheaddCustomAttribute
method is a drop-in replacement for it.Added cache to agent attribute filtering.
To minimize the overhead of applying attribute rules, the agent caches results of filtering specific attribute keys and destinations. The cache is limited to 1000 destination-key pairs by default but can be configured with
attributes.filter_cache_limit
. This cache offers a 10x improvement for applying filter rules for cache-hits.Added
allow_all_headers
to config options and updatedhttp
instrumentation.When set to
true
, the agent will collect all request headers. This collection respects the agent attribute include and exclude rules. A default set of exclusion rules are provided innewrelic.js
. These rules exclude all cookies and authentication headers.Segments may now be flagged as opaque, causing internal segments to be omitted from the transaction trace.
Improvements
Added limits for agent attributes to keep monitoring overhead down.
Attribute keys and values are limited to 255 bytes each. Keys which are larger than 255 bytes are dropped, and a warning message is logged. Values larger than 255 bytes are truncated to 255 bytes, respecting multi-byte UTF-8 encoding. Custom attributes are limited to 64 per transaction. Attributes beyond the 64th are silently ignored.
Added error to collector connection failure log message.
Renamed
request_uri
attribute torequest.uri
.This brings the attribute name in line with all other request attributes.
Updated
https-proxy-agent
dependency from^0.3.5
to^0.3.6
.Updated versioned tests where applicable to ensure most minor versions of instrumented modules work as expected.
Fixed stalling test for v1 line of Mongo driver.
Added tests verifying Hapi 404 transactions result in correctly named metrics.
The Hapi instrumentation was doing the correct thing, but we did not have tests for this specific case.
Bug fixes
The agent will no longer crash when
crypto.DEFAULT_ENCODING
has been changed.Previously, the agent would assume the result of
hash.digest()
was an instance of a Buffer. Ifcrypto.DEFAULT_ENCODING
is changed,hash.digest()
will return a string and the agent would crash. The agent now ensures that the value is a Buffer instance before moving on.Fixed error if
process.config.variables.node_prefix
missing.If
process.config.variables.node_prefix
is falsey (which can happen if using electron, leading to this issue https://discuss.newrelic.com/t/new-relic-on-electron-nodejs/53601) thegetGlobalPackages
function inlib/environment.js
will give an err when it shouldn't.Thanks to Jarred Filmer (@BrighTide) for the fix!
Improvements
- Added regression test for promise instrumentation and stack overflows.
Bug fixes
Fixed naming bug in Restify instrumentation regarding parameters to
next
.The instrumentation previously considered any truthy value passed to
next
to be an error. It is possible to pass a string or boolean tonext
in Restify to control further routing of the request. This would cause the middleware's mounting path to be erroneously appended to the transaction name.Fixed access to
bluebird.coroutine.addYieldHandler
.This was accidentally not copied by our instrumentation making access to the function fail. This has been resolved and tests expanded to ensure no other properties were missed.
New features
Added
transaction_tracer.hide_internals
configuration.This configuration controls the enumerability of the internal properties of the agent. Making these properties non-enumerable can have an impact on the performance of the agent. Disabling this option may decrease agent overhead.
Improvements
Refactored promise instrumentation.
This new instrumentation is far more performant than the previous and maintains a more sensible trace structure under a wider range of sequences.
Added concurrent environment scanning, limited to 2 reads at a time.
This improves the performance of dependency scanning at agent startup, allowing the agent to connect to our services more quickly.
Refactored instrumentation tests to run against wide range of module versions.
Instrumentation tests will be run against all supported major versions of every instrumented module. For releases, we will test against every supported minor version of the modules. This vastly improves our test coverage and should reduce the instances of regressions for specific versions of modules.
Added tests for all of bluebird's promise methods.
These tests ensure that we 100% instrument bluebird. Some gaps in instrumentation were found and fixed. Anyone using bluebird should upgrade.
Bug fixes
Fixed a crashing error in the hapi instrumentation.
When recording the execution of an extension listening to a server event (for example, 'onPreStart') the agent would crash due to the lack of a
raw
property on the first argument passed to the extension handler. The agent now checks the event before wrapping the extension handler and checks for the existence of theraw
property before attempting to dereference off of it.Fixed an incompatibility with the npm module
mimic-response
.The agent's HTTP instrumentation previously did not play well with the way
mimic-response
copied properties from anhttp.IncomingMessage
. This caused modules that relied on that process, such asgot
, to hang.Fixed naming rule testing tool to use same url scrubbing as the agent itself.
New features
Added hapi v17 instrumentation
Hapi v17 added support for promise-based middleware which broke transaction tracking in the agent. This caused issues in naming, as the agent will name the transaction after the path to the middleware that responded to a request.
Added instrumentation for
vision@5
Due to the way
vision
is mounted to the hapi server when using hapi v17.x, the agent's instrumentation would not pick up on the middleware being mounted. This new instrumentation now correctly times rendering done in thevision
middleware.Added
unwrapOnce
method to shim objectThis new method can be used to unwrap a single layer of instrumentation.
unwrapOnce
is useful in cases where multiple instrumentations wrap the same method and unwrapping of the top level is required.Added
isErrorWare
checks aroundnameState.appendPath
/nameState.popPath
calls to avoid doubling up paths in transaction namesPreviously, the agent would append its transaction name with the path fragment where an error handler middleware was mounted. The extraneous path fragment will now be omitted, and the transaction will be named properly after the middleware that threw the error.
Added support for
pg
6 on Node 5 or higher
Improvements
- Added
parent
property to webframework-shim segment description - Refactored existing hapi instrumentation for different
server.ext()
invocations - Refactored webframework-shim
_recordMiddleware
to construct different segment descriptions for callback- or promise-based middleware - Updated
node-postgres@^6
versioned tests to avoid deprecation warning on direct moduleconnect
andend
calls - Fixed running domain tests on Node 9.3.0.
- Improved logging for CAT headers and transaction name-state management.
- All
json-safe-stringify
calls now wrapped intry/catch
- Removed
lib/util/safe-json
Bug fixes
- Fixed creating supportability metric when mysql2 goes uninstrumented.
- Added a
segmentStack.pop
to the middlewareafter
in cases when an error is caught and there is no next handler - Fixed determining parents for middleware segments when transaction state is lost and reinstated
- Added check to
_recordMiddleware
to avoid prepending a slash if originalroute
is an array - Changed logic in http instrumentation to attach
response.status
to the transaction as a string - Updated
startWebTransaction
andstartBackgroundTransaction
to add nested transactions as segments to parent transactions
Notes
- Added Peter Svetlichny to the contributors list!
Improvements
- Optimized
NameState#getPath
. - Optimized
shim.record
. - Optimized
shim.recordMiddleware
. - Upgraded
eslint
to v4.
Bug fixes
- Fixed parsing SQL for queries containing newlines.
Improvements
- Added promise benchmarks to test non-async_hooks instrumentation.
- Added logging for external calls made outside of a transaction.
- Added logging for when
unhandledRejection
is noticed. - Improved performance of creating and merging metrics.
- Improved performance of
tracer.bindFunction
. - Removed try-catch around internal property setting on older versions of Node.
Bug fixes
- Moved
require
calls for vendor metadata to module-level.
New features
Instrumentation will now only modify the arity of wrapped functions when needed.
This can be controlled with the
matchArity
property on aWrapSpec
. Disabling arity matching has a significant, positive impact on the performance of instrumentation.
Improvements
Added benchmarks for shimmer methods.
Pinned hapi tests at v16 due to incompatibility in hapi v17 with Node.js versions <8.
The agent's parsed queries will now only hold onto the stack that the query was made at, instead of an error object instance.
Previously, the parsed query objects would hold onto an error instance, which would in turn hold onto references to all the functions in the stack when the error was created. This could cause memory issues if the functions were holding onto references to other pieces of data.
Bug fixes
Revert wrapping of
https
for Node^8.9.1
.The original cause for this problem was reverted by Node.
Improvements
- Added Node 9 to test suite.
- Removed problematic tests for ancient version of Hapi (7.1).
- Document purpose of
throw
in tracer to prevent developer confusion. - Added script for running agent micro benchmarks.
- Added benchmarks for all the
Shim
andTracer
methods.
Bug fixes
- Fixed a bug with Node >=8.9 that prevented https externals from being recorded.
Improvements
- Agent will attempt to reconnect to the collector forever after backing off to 5 minute delays.
Bug fixes
- Refactored environment scan to improve startup time and fix cyclical symlink resolving.