Node.js agent release notesRSS

Notes

• Changed attributes.enabled to true by default.

  In the previous version we defaulted this to false to maintain parity with capture_params which defaulted to false. However, this is a invalid parity because attribute.enabled controls more attributes than capture_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 and cassandra versioned tests.

  As of mysql2 v1.3.1 and cassandra v3.4.0 the minimum supported version of Node is 4.

• Replaced as many instances of {} as possible with Object.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.

Nouvelles fonctionnalités

• Ajout du filtrage des attributs de l'agent via des règles d'inclusion et d'exclusion.

  Les attributs de l’agent peuvent désormais être contrôlés à l’aide de règles d’inclusion et d’exclusion précises. Ces règles, décrites ci-dessous, remplacent capture_params et ignored_params. Tous les attributs listés dans ignored_params seront migrés vers attributes.exclude en interne, à moins que attributes.exclude ne soit explicitement défini.

  Trois nouvelles propriétés de configuration ont été ajoutées à la configuration racine et à chaque destination (plus d’informations sur les destinations plus tard). Ces nouvelles configurations sont :

  • attributes.enabled - Permet la collecte d’attributs pour la destination.
  • attributes.include - Une liste d’attributs ou de règles de caractères génériques à inclure.
  • attributes.exclude - Une liste d’attributs ou de règles génériques à exclure.

  Les règles d'inclusion et d'exclusion peuvent être des règles exactes (par exemple request.headers.contentLength), ou des règles avec caractères génériques qui correspondent uniquement au début des clés d'attribut (par exemple request.headers.* correspondrait à tout en-tête de requête).

  Ces règles peuvent être spécifiées globalement à la racine de la configuration, ou pour des destinations spécifiques. Ces destinations sont :

  • transaction_tracer - Contrôle les attributs de trace de transaction.
  • transaction_events - Contrôle les attributs d’événement de transaction.
  • error_collector - Contrôle les attributs des événements d’erreur.
  • browser_monitoring - Contrôle les attributs de transaction de navigateur/RUM.

• addCustomParameter renommé en addCustomAttribute.

  La méthode addCustomParameter est désormais obsolète et sera supprimée dans une future sortie de l'agent. La méthode addCustomAttribute est un remplacement direct pour celle-ci.

• Ajout d’un cache au filtrage des attributs de l’agent.

  Pour minimiser la surcharge liée à l’application des règles d’attribut, l’agent met en cache les résultats du filtrage des clés d’attribut et des destinations spécifiques. Le cache est limité à 1000 paires destination-clé par défaut, mais peut être configuré avec attributes.filter_cache_limit. Ce cache offre une amélioration de 10x pour l’application des règles de filtre pour le taux d’accès au cache.

• Ajout de allow_all_headers aux options de configuration et mise à jour de l’instrumentation http.

  Lorsque la valeur est true, l’agent collectera tous les en-têtes de requête. Cette collecte respecte les règles d’inclusion et d’exclusion d’attribut de l’agent. Un ensemble par défaut de règles d’exclusion est fourni dans newrelic.js. Ces règles excluent tous les cookies, et les en-têtes d’authentification.

• Les segments peuvent désormais être marqués comme opaques, ce qui entraîne l’omission des segments internes de la trace de transaction.

Améliorations

• Ajout de limites pour les attributs de l’agent afin de maintenir la surcharge de monitoring à un niveau bas.

  Les clés et valeurs d’attribut sont limitées à 255 octets chacune. Les clés de plus de 255 octets sont supprimées, et un message d’avertissement est enregistré dans le log. Les valeurs de plus de 255 octets sont tronquées à 255 octets, en respectant l’encodage UTF-8 multi-octets. Les attributs personnalisés sont limités à 64 par transaction. Les attributs au-delà du 64e sont ignorés silencieusement.

• Ajout de l'erreur au message de log d'échec de connexion au collecteur.

• L’attribut request_uri a été renommé en request.uri.

  Cela aligne le nom de l’attribut avec tous les autres attributs de requête.

• Dépendance https-proxy-agent mise à jour de ^0.3.5 à ^0.3.6.

• Mise à jour des tests versionnés le cas échéant pour s’assurer que la plupart des versions mineures des modules instrumentés fonctionnent comme prévu.

• Correction du test bloquant pour la ligne v1 du pilote Mongo.

• Ajout de tests vérifiant que les transactions Hapi 404 génèrent des métriques correctement nommées.

  L’instrumentation Hapi fonctionnait correctement, mais nous n’avions pas de tests pour ce cas spécifique.

Débogage

• L’agent ne plantera plus lorsque crypto.DEFAULT_ENCODING a été modifié.

  Auparavant, l’agent supposait que le résultat de hash.digest() était une instance de Buffer. Si crypto.DEFAULT_ENCODING est modifié, hash.digest() renverra une chaîne et l’agent plantera. L’agent s’assure désormais que la valeur est une instance de Buffer avant de continuer.

• Correction de l’erreur si process.config.variables.node_prefix est manquant.

  Si process.config.variables.node_prefix est évalué à faux (ce qui peut arriver si vous utilisez electron, conduisant à ce problème https://support.newrelic.com/s/hubtopic/aAX8W0000008ZMO/new-relic-on-electron-nodejs) la fonction getGlobalPackages dans lib/environment.js donnera une erreur alors qu’elle ne le devrait pas.

  Merci à Jarred Filmer (@BrighTide) pour le correctif !

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 to next 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 the raw 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 an http.IncomingMessage. This caused modules that relied on that process, such as got, 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 the vision middleware.

• Added unwrapOnce method to shim object

  This 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 around nameState.appendPath/nameState.popPath calls to avoid doubling up paths in transaction names

  Previously, 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 module connect and end 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 in try/catch
• Removed lib/util/safe-json

Bug fixes

• Fixed creating supportability metric when mysql2 goes uninstrumented.
• Added a segmentStack.popto the middleware after 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 original route is an array
• Changed logic in http instrumentation to attach response.status to the transaction as a string
• Updated startWebTransaction and startBackgroundTransaction 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 a WrapSpec. 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.