@appsignal/nodejs
3.9.5 · 11 Nov 2026MIT24.2k / weekRepositoryHomepagenpmAtom feed
133 stable releases, newest first, by release line. Notes are quoted as the maintainers published them.
3.9.5
11 Nov 20263.9.4
23 Oct 2026- Security
Bump the bundled certificates that the agent uses when it can't open the configured CA file. They no longer include the emSign ECC Root CA - G3 and AAA Certificate Services root certificates, which compromised eMudhra intermediate certificates chain to.
(patch 498c087, 0178413, b9cbfeb, a8d1ce4, dc88605, 5d60637)
Published on 2026-10-23.
Security
- Security
Bump the bundled certificates that the agent uses when it can't open the configured CA file. They no longer include the emSign ECC Root CA - G3 and AAA Certificate Services root certificates, which compromised eMudhra intermediate certificates chain to.
(patch 498c087, 0178413, b9cbfeb, a8d1ce4, dc88605, 5d60637)
3.9.3
22 Oct 2026- Security
Stop trusting certificates issued under the eMudhra intermediate certificate authorities whose private keys were compromised in October 2026. The bundled CA certificates no longer include the emSign ECC Root CA - G3 root certificate, which those intermediates chain to. (patch 498c087, 0178413, b9cbfeb)
Published on 2026-10-22.
Security
- Security
Stop trusting certificates issued under the eMudhra intermediate certificate authorities whose private keys were compromised in October 2026. The bundled CA certificates no longer include the emSign ECC Root CA - G3 root certificate, which those intermediates chain to. (patch 498c087, 0178413, b9cbfeb)
3.9.2
14 Oct 2026Automatically detect the application's revision from the
HEROKU_BUILD_COMMITenvironment variable, which is set by Heroku at build time when theruntime-dyno-build-metadataHeroku Labs feature is enabled.(patch cb2bf69)
Improve handling of the extension internal queue when full. (patch 30f9e93)
Fix issues in the extension that lead to gaps in data reporting. (patch 3a91e18)
Published on 2026-10-14.
Added
Automatically detect the application's revision from the
HEROKU_BUILD_COMMITenvironment variable, which is set by Heroku at build time when theruntime-dyno-build-metadataHeroku Labs feature is enabled.(patch cb2bf69)
Fixed
3.9.1
10 Sep 2026Fix the sanitization of function arguments in SQL statements.
Before this release, SQL sanitization of function arguments stripped out parts of the SQL statement after the function argument list.
(patch 3f41a3b)
Published on 2026-09-10.
Fixed
Fix the sanitization of function arguments in SQL statements.
Before this release, SQL sanitization of function arguments stripped out parts of the SQL statement after the function argument list.
(patch 3f41a3b)
3.9.0
8 Sep 2026- Breaking
Drop support for Node.js 18. The minimum supported version is now Node.js 20.6.0, which is what the bundled OpenTelemetry packages require.
(minor 3994b08)
Report queue events from applications that use BullMQ's own telemetry, which is what BullMQ version 6 and newer offer through the
bullmq-otelpackage. These were previously reported as uncategorised events named after the raw span, because BullMQ describes its spans with its own attributes rather than the OpenTelemetry messaging conventions. They are now named and categorised the same way as events from the@appsignal/opentelemetry-instrumentation-bullmqpackage.(minor 96d9030)
Warn when your application loads more than one version of
@opentelemetry/api, warning about potential data loss, as older versions fail to send data through global values configured by newer versions. The warning names the versions and where they were loaded from.(patch 3994b08)
Published on 2026-09-08.
Added
Report queue events from applications that use BullMQ's own telemetry, which is what BullMQ version 6 and newer offer through the
bullmq-otelpackage. These were previously reported as uncategorised events named after the raw span, because BullMQ describes its spans with its own attributes rather than the OpenTelemetry messaging conventions. They are now named and categorised the same way as events from the@appsignal/opentelemetry-instrumentation-bullmqpackage.(minor 96d9030)
Warn when your application loads more than one version of
@opentelemetry/api, warning about potential data loss, as older versions fail to send data through global values configured by newer versions. The warning names the versions and where they were loaded from.(patch 3994b08)
Changed
Update the bundled OpenTelemetry packages to their current versions. This resolves two reported vulnerabilities:
CVE-2026-59892 in
@opentelemetry/propagator-jaeger, which this integration does not use but did bundle through@opentelemetry/sdk-node.CVE-2026-54285 in
@opentelemetry/core, which applies to the W3C baggage propagation that this integration does use.
(minor 3994b08)
Update the agent to handle high traffic apps. On high-traffic apps that would exceed the maximum accepted internal payload size, send data to the Push API more frequently. (patch 96d9030)
Allow any 1.x version of
@opentelemetry/apifrom 1.9.0 onwards. This prevents an issue where npm installs a second copy of the package for AppSignal alone, which can stop spans from being reported without any error.(patch 3994b08)
Removed
- Breaking
Drop support for Node.js 18. The minimum supported version is now Node.js 20.6.0, which is what the bundled OpenTelemetry packages require.
(minor 3994b08)
Fixed
Keep naming MongoDB events after the operation they perform when the
@opentelemetry/instrumentation-mongodbpackage is version 0.74.0 or newer. That version renames its spans to follow the stable database semantic conventions, and events from it were being namedunknown.mongodbas a result.(patch 96d9030)
Report the queue name on BullMQ events as the
queuetag. It was being reported as themessage_destinationtag instead.(patch 96d9030)
Do not emit B3 trace context propagation headers. If you relied on AppSignal to send the trace context in the
b3orx-b3-*headers, you can configure that yourself by passing your owntextMapPropagatorto the OpenTelemetry SDK.(patch 3994b08)
3.8.1
10 Jun 2026Continue reporting non-disk host metrics when a mount is frozen. (patch a4a652d)
Fix host-metrics leaking zombie
[timeout]processes in Alpine linux containers.Before this release AppSignal agent relied on a proper init process that reaps child processes killed by system
timeout. Now the agent terminates and reaps unresponsive child processes in host-metrics collection and a subreaper is no longer required.(patch 5c334bc)
Ensure
sendErrorends its span even when the callback throws. (patch e9c0209)
Published on 2026-06-10.
Fixed
Continue reporting non-disk host metrics when a mount is frozen. (patch a4a652d)
Fix host-metrics leaking zombie
[timeout]processes in Alpine linux containers.Before this release AppSignal agent relied on a proper init process that reaps child processes killed by system
timeout. Now the agent terminates and reaps unresponsive child processes in host-metrics collection and a subreaper is no longer required.(patch 5c334bc)
Ensure
sendErrorends its span even when the callback throws. (patch e9c0209)
3.8.0
17 Mar 2026Update OpenTelemetry dependencies to v2. All bundled OpenTelemetry packages have been updated to their OpenTelemetry v2-compatible versions. This resolves compatibility issues when third-party span processors or instrumentations are used alongside AppSignal, which could cause spans to silently drop due to v1/v2 incompatibilities. The
@opentelemetry/instrumentation-redis-4package has been removed. Redis v4 instrumentation is now handled by@opentelemetry/instrumentation-redis, which supports both Redis v3 and v4. (minor efbcc4a)Update Prisma instrumentation to v7. The
@prisma/instrumentationpackage has been updated from v6 to v7. Themiddlewareconfig option has been removed, as Prisma dropped its middleware API in Prisma v5. Prisma's native tracing is now the only supported instrumentation method. (minor efbcc4a)Bundled certificates have been updated. (patch 498c087)
Published on 2026-03-17.
Changed
Update OpenTelemetry dependencies to v2. All bundled OpenTelemetry packages have been updated to their OpenTelemetry v2-compatible versions. This resolves compatibility issues when third-party span processors or instrumentations are used alongside AppSignal, which could cause spans to silently drop due to v1/v2 incompatibilities. The
@opentelemetry/instrumentation-redis-4package has been removed. Redis v4 instrumentation is now handled by@opentelemetry/instrumentation-redis, which supports both Redis v3 and v4. (minor efbcc4a)Update Prisma instrumentation to v7. The
@prisma/instrumentationpackage has been updated from v6 to v7. Themiddlewareconfig option has been removed, as Prisma dropped its middleware API in Prisma v5. Prisma's native tracing is now the only supported instrumentation method. (minor efbcc4a)Bundled certificates have been updated. (patch 498c087)
Update BullMQ OpenTelemetry extractor to support new messaging semantic conventions. (patch 3702e4d)
Use system-specific operation name in messaging span names.
When
messaging.operation.nameis present (e.g.Queue.add), it is used directly as the span name prefix:Queue.add (myQueue). When only the genericmessaging.operation.typeis available (e.g.send), the word "message" is added for clarity:send message (myQueue).(patch 3702e4d)
3.7.4
5 Feb 2026Require parent spans on database and outgoing HTTP instrumentations that support it. When a database query is performed using the
ioredis,pg,redisormongooselibraries, or when an outgoing HTTP request is performed using thehttpmodule, a span will only be created if a trace has already been started in the current active context, that is, if the span to be created would have a parent.This helps prevent database queries and outgoing HTTP requests happening in uninstrumented contexts from counting towards your requests quota.
(patch 57d3cfb)
Add support for Koa v3. (patch 08908f2)
Published on 2026-02-05.
Changed
Require parent spans on database and outgoing HTTP instrumentations that support it. When a database query is performed using the
ioredis,pg,redisormongooselibraries, or when an outgoing HTTP request is performed using thehttpmodule, a span will only be created if a trace has already been started in the current active context, that is, if the span to be created would have a parent.This helps prevent database queries and outgoing HTTP requests happening in uninstrumented contexts from counting towards your requests quota.
(patch 57d3cfb)
Fixed
Add support for Koa v3. (patch 08908f2)
3.7.2
15 Oct 2025Add a log format option for autodetection the log format. (patch 48a1bde)
Add support for native OpenTelemetry spans from
@elastic/transportpackage in Node.js. (patch 663e5b5)Detect the log format automatically. We now detect if a log line is in the JSON, Logfmt, or plaintext format. No further config needed when calling our logger, like so:
const logger = Appsignal.logger("app"); logger.info("message");(patch 0ccc052)
Published on 2025-10-15.
Added
Add a log format option for autodetection the log format. (patch 48a1bde)
Add support for native OpenTelemetry spans from
@elastic/transportpackage in Node.js. (patch 663e5b5)
Changed
Detect the log format automatically. We now detect if a log line is in the JSON, Logfmt, or plaintext format. No further config needed when calling our logger, like so:
const logger = Appsignal.logger("app"); logger.info("message");(patch 0ccc052)
Fixed
Fix 'unknown' events being reported for some HTTP routes. (patch 87867bb)
3.7.1
27 Aug 2025Update the OpenTelemetry dependency to version 1.9 of the OpenTelemetry API. This improves compatibility with instrumentation libraries that depend on this version of the API. (patch 4cc4257)
Published on 2025-08-27.
Changed
Update the OpenTelemetry dependency to version 1.9 of the OpenTelemetry API. This improves compatibility with instrumentation libraries that depend on this version of the API. (patch 4cc4257)
3.7.0
22 Aug 2025Disable the OpenTelemetry trace context propagation across applications. If multiple applications are instrumented with AppSignal for Node.js using OpenTelemetry, the propagation across applications could lead to application data being reported the wrong application in AppSignal. (minor 7fc85b8, 7ddcbec)
Published on 2025-08-22.
Changed
Disable the OpenTelemetry trace context propagation across applications. If multiple applications are instrumented with AppSignal for Node.js using OpenTelemetry, the propagation across applications could lead to application data being reported the wrong application in AppSignal. (minor 7fc85b8, 7ddcbec)
3.6.7
6 Jun 2025Add
nginxPortconfiguration option. This configuration option can be used to customize the port on which the AppSignal integration exposes the NGINX metrics server. (patch 30490f3, 0085686, f5b20bc)
Published on 2025-06-06.
Added
Add
nginxPortconfiguration option. This configuration option can be used to customize the port on which the AppSignal integration exposes the NGINX metrics server. (patch 30490f3, 0085686, f5b20bc)
3.6.6
8 May 2025Allow overriding namespaces that are automatically set by the AppSignal agent based on the OpenTelemetry instrumentation that emitted the span, such as the
graphqlorbackgroundnamespaces. (patch 4c9aae1)Log a debug message when the reported error is ignored by the
ignore_errorsconfig option. (patch 4c9aae1)Update
mysql2andpginstrumentations. This fixes an issue where queries performed using promises withmysql2@3.11.5are not instrumented, as well as an issue wherepgis not instrumented under certain bundlers and runtimes. (patch e2d73ab)
Published on 2025-05-08.
Changed
Allow overriding namespaces that are automatically set by the AppSignal agent based on the OpenTelemetry instrumentation that emitted the span, such as the
graphqlorbackgroundnamespaces. (patch 4c9aae1)Log a debug message when the reported error is ignored by the
ignore_errorsconfig option. (patch 4c9aae1)
Fixed
Update
mysql2andpginstrumentations. This fixes an issue where queries performed using promises withmysql2@3.11.5are not instrumented, as well as an issue wherepgis not instrumented under certain bundlers and runtimes. (patch e2d73ab)
3.6.5
5 May 2025Remove redundant cron check-in pairs. When more than one pair of start and finish cron check-in events is reported for the same identifier in the same period, only one of them will be reported to AppSignal. (patch 1cfcc0a)
Published on 2025-05-05.
Changed
Remove redundant cron check-in pairs. When more than one pair of start and finish cron check-in events is reported for the same identifier in the same period, only one of them will be reported to AppSignal. (patch 1cfcc0a)
3.6.4
31 Mar 20253.6.2
11 Mar 2025Delay and eventually halt agent reboots by the extension.
The AppSignal extension is responsible for booting the AppSignal agent. If communication with the agent is lost, the extension is responsible for rebooting it.
In certain scenarios, such as when several processes with different AppSignal configurations are misconfigured to share the same working directory, the processes' extensions can enter a loop of rebooting and killing each others' agents. These short-lived agents may then attempt to repeatedly send pending payloads to AppSignal in quick succession.
This change causes the extension to delay each reboot of its agent by one additional second, and to no longer attempt to reboot the agent after the tenth reboot, slowing down and eventually breaking this loop.
(patch ff392c6)
Published on 2025-03-11.
Changed
Delay and eventually halt agent reboots by the extension.
The AppSignal extension is responsible for booting the AppSignal agent. If communication with the agent is lost, the extension is responsible for rebooting it.
In certain scenarios, such as when several processes with different AppSignal configurations are misconfigured to share the same working directory, the processes' extensions can enter a loop of rebooting and killing each others' agents. These short-lived agents may then attempt to repeatedly send pending payloads to AppSignal in quick succession.
This change causes the extension to delay each reboot of its agent by one additional second, and to no longer attempt to reboot the agent after the tenth reboot, slowing down and eventually breaking this loop.
(patch ff392c6)
3.6.0
24 Feb 2025- Breaking
Minor - Remove the OpenTelemetry beta feature in favor of the new AppSignal collector. If you are using the AppSignal agent to send OpenTelemetry data in our public beta through the
/enrichedendpoint on the agent's HTTP server, please migrate to the collector to continue using the beta. The collector has a much better implementation of this feature for the beta. Patch - Update span recognition following the OpenTelemetry Semantic Conventions 1.30 database specification. We now also sanitize SQL queries in the
db.query.textattribute and Redis queries in thedb.operation.nameattribute.Patch - Bump the log message when no span is active and one of our sample data helpers are used like
setParams,setSessionData,setCustomData, etc from debug to warning.
Published on 2025-02-24.
Changed
Patch - Update span recognition following the OpenTelemetry Semantic Conventions 1.30 database specification. We now also sanitize SQL queries in the
db.query.textattribute and Redis queries in thedb.operation.nameattribute.Patch - Bump the log message when no span is active and one of our sample data helpers are used like
setParams,setSessionData,setCustomData, etc from debug to warning.Patch - Update bundled trusted root certificates
Removed
- Breaking
Minor - Remove the OpenTelemetry beta feature in favor of the new AppSignal collector. If you are using the AppSignal agent to send OpenTelemetry data in our public beta through the
/enrichedendpoint on the agent's HTTP server, please migrate to the collector to continue using the beta. The collector has a much better implementation of this feature for the beta.
3.5.4
22 Nov 2024Allow Pino transport to be used as a transport. Before, our Pino transport could only be used as a destination:
import pino from "pino"; import { Appsignal, AppsignalPinoTransport } from "@appsignal/nodejs"; pino(AppsignalPinoTransport({ client: Appsignal.client, group: "pino" }));This meant it was not possible to log both to our transport and to another destination.
Now, it is also possible to use it as a Pino transport, with the
transportPino config option or thepino.transport()function:import pino from "pino"; pino({ transport: { target: "@appsignal/nodejs/pino", options: { group: "pino" } } });It is no longer necessary to pass the AppSignal client to the Pino transport. AppSignal must be active for the Pino transport to work.
By enabling its use as a transport, it is now possible to use it alongside other transports:
pino({ transport: { targets: [ // Send logs to AppSignal... { target: "@appsignal/nodejs/pino" }, // ... and to standard output! { target: "pino/file" } ] } });(patch 11b789d)
Published on 2024-11-22.
Fixed
Allow Pino transport to be used as a transport. Before, our Pino transport could only be used as a destination:
import pino from "pino"; import { Appsignal, AppsignalPinoTransport } from "@appsignal/nodejs"; pino(AppsignalPinoTransport({ client: Appsignal.client, group: "pino" }));This meant it was not possible to log both to our transport and to another destination.
Now, it is also possible to use it as a Pino transport, with the
transportPino config option or thepino.transport()function:import pino from "pino"; pino({ transport: { target: "@appsignal/nodejs/pino", options: { group: "pino" } } });It is no longer necessary to pass the AppSignal client to the Pino transport. AppSignal must be active for the Pino transport to work.
By enabling its use as a transport, it is now possible to use it alongside other transports:
pino({ transport: { targets: [ // Send logs to AppSignal... { target: "@appsignal/nodejs/pino" }, // ... and to standard output! { target: "pino/file" } ] } });(patch 11b789d)
3.5.3
7 Nov 2024Set the app revision config option for Scalingo deploys automatically. If the
CONTAINER_VERSIONsystem environment variable is present, it will use used to set therevisionconfig option automatically. Overwrite it's value by configuring therevisionconfig option for your application. (patch 5b90b64)Fix an issue where the extension fails to build on ARM64 Linux. (patch 69fcdcf)
Published on 2024-11-07.
Added
Set the app revision config option for Scalingo deploys automatically. If the
CONTAINER_VERSIONsystem environment variable is present, it will use used to set therevisionconfig option automatically. Overwrite it's value by configuring therevisionconfig option for your application. (patch 5b90b64)
Fixed
Fix an issue where the extension fails to build on ARM64 Linux. (patch 69fcdcf)
3.5.2
4 Nov 2024Patch - Add Fastify v5 compatibility
Published on 2024-11-04.
Added
Patch - Add Fastify v5 compatibility
3.5.1
16 Oct 2024Patch - A Pino transport is now available. If Pino is your main logger, you can now use the AppSignal pino transport to send those logs to AppSignal.
import pino from "pino" import { Appsignal, AppsignalPinoTransport } from "@appsignal/nodejs" const logger = pino( AppsignalPinoTransport({ client: Appsignal.client, group: "application", }) )Patch - Change the primary download mirror for integrations.
Published on 2024-10-16.
Added
Patch - A Pino transport is now available. If Pino is your main logger, you can now use the AppSignal pino transport to send those logs to AppSignal.
import pino from "pino" import { Appsignal, AppsignalPinoTransport } from "@appsignal/nodejs" const logger = pino( AppsignalPinoTransport({ client: Appsignal.client, group: "application", }) )
Changed
Patch - Change the primary download mirror for integrations.
3.5.0
26 Sep 2024Add support for heartbeat check-ins.
Use the
checkIn.heartbeatmethod to send a single heartbeat check-in event from your application. This can be used, for example, in your application's main loop:import { checkIn } from "@appsignal/nodejs" while (true) { checkIn.heartbeat("job_processor") await processJob() }Heartbeats are deduplicated and sent asynchronously, without blocking the current thread. Regardless of how often the
.heartbeatmethod is called, at most one heartbeat with the same identifier will be sent every ten seconds.Pass
{continuous: true}as the second argument to send heartbeats continuously during the entire lifetime of the current process. This can be used, for example, after your application has finished its boot process:import { checkIn } from "@appsignal/nodejs" function main() { checkIn.heartbeat("job_processor", {continuous: true}) startApp() }(minor 839073e)
Send check-ins concurrently. When calling
Appsignal.checkIn.cron, instead of blocking the current process while the check-in events are sent, schedule them to be sent in a separate process. (patch a61d16b)Do not block Node.js shutdown. It is no longer necessary to call
Appsignal.stopfor the Node.js engine to allow itself to shut down. It should still be called and awaited in production scenarios and at the end of scripts, as it ensures that scheduled check-ins are delivered. (patch 0f438d6)
Published on 2024-09-26.
Added
Add support for heartbeat check-ins.
Use the
checkIn.heartbeatmethod to send a single heartbeat check-in event from your application. This can be used, for example, in your application's main loop:import { checkIn } from "@appsignal/nodejs" while (true) { checkIn.heartbeat("job_processor") await processJob() }Heartbeats are deduplicated and sent asynchronously, without blocking the current thread. Regardless of how often the
.heartbeatmethod is called, at most one heartbeat with the same identifier will be sent every ten seconds.Pass
{continuous: true}as the second argument to send heartbeats continuously during the entire lifetime of the current process. This can be used, for example, after your application has finished its boot process:import { checkIn } from "@appsignal/nodejs" function main() { checkIn.heartbeat("job_processor", {continuous: true}) startApp() }(minor 839073e)
Changed
Send check-ins concurrently. When calling
Appsignal.checkIn.cron, instead of blocking the current process while the check-in events are sent, schedule them to be sent in a separate process. (patch a61d16b)Do not block Node.js shutdown. It is no longer necessary to call
Appsignal.stopfor the Node.js engine to allow itself to shut down. It should still be called and awaited in production scenarios and at the end of scripts, as it ensures that scheduled check-ins are delivered. (patch 0f438d6)
3.4.9
14 Aug 2024- Deprecated
Calls to
Appsignal.heartbeatand to theAppsignal.Heartbeatconstructor will emit a deprecation warning. (patch fc9abba) Rename heartbeats to cron check-ins. Calls to
Appsignal.heartbeatandAppsignal.Heartbeatshould be replaced with calls toAppsignal.checkIn.cronandAppsignal.checkIn.Cron, for example:// Before import { heartbeat } from "@appsignal/nodejs" heartbeat("do_something", () => { do_something() }) // After import { checkIn } from "@appsignal/nodejs" checkIn.cron("do_something", () => { do_something })(patch fc9abba)
Prevent internal AppSignal requests from being instrumented and appearing in the "Slow API requests" panel. (patch 95bf139)
Published on 2024-08-14.
Changed
Rename heartbeats to cron check-ins. Calls to
Appsignal.heartbeatandAppsignal.Heartbeatshould be replaced with calls toAppsignal.checkIn.cronandAppsignal.checkIn.Cron, for example:// Before import { heartbeat } from "@appsignal/nodejs" heartbeat("do_something", () => { do_something() }) // After import { checkIn } from "@appsignal/nodejs" checkIn.cron("do_something", () => { do_something })(patch fc9abba)
Deprecated
- Deprecated
Calls to
Appsignal.heartbeatand to theAppsignal.Heartbeatconstructor will emit a deprecation warning. (patch fc9abba)
Fixed
Prevent internal AppSignal requests from being instrumented and appearing in the "Slow API requests" panel. (patch 95bf139)
3.4.7
20 Jun 2024Patch - Update OpenTelemetry dependencies.
Published on 2024-06-20.
Changed
Patch - Update OpenTelemetry dependencies.
3.4.6
14 Jun 2024Patch - Fix an issue where a later span close time than accurate, and therefore a longer span duration, is reported to AppSignal under certain circumstances.
Published on 2024-06-14.
Fixed
Patch - Fix an issue where a later span close time than accurate, and therefore a longer span duration, is reported to AppSignal under certain circumstances.
3.4.5
12 Jun 2024Patch - Add BullMQ support through the
@appsignal/opentelemetry-instrumentation-bullmqinstrumentation. AppSignal will automatically instrument the use of BullMQ in your application.Calls to functions that enqueue jobs, such as
Queue.addand others, will be instrumented as an event in the event timeline for the performance sample in which it takes place.When a BullMQ
Workerprocesses a job, this will result in a performance sample in thebackgroundnamespace.Patch - Add basic OpenTelemetry messaging support. This adds support for any OpenTelemetry instrumentation that complies with the OpenTelemetry Semantic Conventions specification for messaging.
Patch - Rename the
hostnametag, which contains the host of the URI that an HTTP request was made against, torequest_host.This fixes an issue where the
hostnametag would later be internally overriden to the hostname of the machine processing the request, but notifications would still be emitted containing the previoushostnamevalue.
Published on 2024-06-12.
Added
Patch - Add BullMQ support through the
@appsignal/opentelemetry-instrumentation-bullmqinstrumentation. AppSignal will automatically instrument the use of BullMQ in your application.Calls to functions that enqueue jobs, such as
Queue.addand others, will be instrumented as an event in the event timeline for the performance sample in which it takes place.When a BullMQ
Workerprocesses a job, this will result in a performance sample in thebackgroundnamespace.Patch - Add basic OpenTelemetry messaging support. This adds support for any OpenTelemetry instrumentation that complies with the OpenTelemetry Semantic Conventions specification for messaging.
Changed
Patch - Rename the
hostnametag, which contains the host of the URI that an HTTP request was made against, torequest_host.This fixes an issue where the
hostnametag would later be internally overriden to the hostname of the machine processing the request, but notifications would still be emitted containing the previoushostnamevalue.Patch - Improve the amqlib instrumentation by parsing it like other messaging spans following the OpenTelemetry messaging spec.
Fixed
Patch - Fix an issue where Redis events are misidentified as HTTP events.
3.4.4
14 May 2024Patch - Instrument calls to
fetchin Node.js. Requests made using Node.js' globalfetch, or through the underlyingundicilibrary, will be automatically instrumented and shown as events in your performance samples' event timeline.
Published on 2024-05-14.
Added
Patch - Instrument calls to
fetchin Node.js. Requests made using Node.js' globalfetch, or through the underlyingundicilibrary, will be automatically instrumented and shown as events in your performance samples' event timeline.
3.4.3
14 May 2024Patch - Instrument calls to
fetchin Node.js. Requests made using Node.js' globalfetch, or through the underlyingundicilibrary, will be automatically instrumented and shown as events in your performance samples' event timeline.Patch - Support Kamal-based deployments. Read the
KAMAL_VERSIONenvironment variable, which Kamal exposes within the deployed container, if present, and use it as the application revision if it is not set. This will automatically report deploy markers for applications using Kamal.Patch - ### Improve error reporting during initialisation
Do not report an error with the extension installation when AppSignal is imported -- instead, report it when attempting to initialise AppSignal. Do not report an error with the extension if AppSignal is not configured to be active.
When AppSignal does not start due to its configuration (
activeis set tofalse, or the push API key is missing) report the specific reason why.
Published on 2024-05-14.
Added
Patch - Instrument calls to
fetchin Node.js. Requests made using Node.js' globalfetch, or through the underlyingundicilibrary, will be automatically instrumented and shown as events in your performance samples' event timeline.Patch - Support Kamal-based deployments. Read the
KAMAL_VERSIONenvironment variable, which Kamal exposes within the deployed container, if present, and use it as the application revision if it is not set. This will automatically report deploy markers for applications using Kamal.
Changed
Patch - ### Improve error reporting during initialisation
Do not report an error with the extension installation when AppSignal is imported -- instead, report it when attempting to initialise AppSignal. Do not report an error with the extension if AppSignal is not configured to be active.
When AppSignal does not start due to its configuration (
activeis set tofalse, or the push API key is missing) report the specific reason why.
Fixed
Patch - Improve compatibility with alternative package managers. Fix an issue where AppSignal would fail to install with Yarn when using package managers that require transitive dependencies to be declared.
3.4.2
7 May 2024Patch - Ignore AMQP spans if they're root spans.
Patch - The AMQP protocol is now instrumented when using amqplib. The AppSignal client automatically instruments and creates spans when using
amqplib. Packages using amqplib such as Rascal are supported.Patch - Log debug messages when metrics are received for easier debugging.
3.4.1
24 Apr 2024Patch - Fix an issue where internal Next.js traces were not correctly ignored in certain circumstances.
Published on 2024-04-24.
Fixed
Patch - Fix an issue where internal Next.js traces were not correctly ignored in certain circumstances.
3.4.0
22 Apr 2024Minor - Heartbeats are currently only available to beta testers. If you are interested in trying it out, send an email to support@appsignal.com!
Add heartbeats support. You can send heartbeats directly from your code, to track the execution of certain processes:
import { heartbeat } from "@appsignal/nodejs" function sendInvoices() { // ... your code here ... heartbeat("send_invoices") }You can pass a function to
heartbeat, to report to AppSignal both when the process starts, and when it finishes, allowing you to see the duration of the process:import { heartbeat } from "@appsignal/nodejs" function sendInvoices() { heartbeat("send_invoices", () => { // ... your code here ... }) }If an exception is raised within the function, the finish event will not be reported to AppSignal, triggering a notification about the missing heartbeat. The exception will bubble outside of the heartbeat function.
If the function passed to
heartbeatreturns a promise, the finish event will be reported to AppSignal if the promise resolves. This means that you can use heartbeats to track the duration of async functions:import { heartbeat } from "@appsignal/nodejs" async function sendInvoices() { await heartbeat("send_invoices", async () => { // ... your async code here ... }) }If the promise is rejected, or if it never resolves, the finish event will not be reported to AppSignal.
Patch - Implement the
ignoreLogsconfiguration option, which can also be configured as theAPPSIGNAL_IGNORE_LOGSenvironment variable.The value of
ignoreLogsis a list (comma-separated, when using the environment variable) of log line messages that should be ignored. For example, the value"start"will cause any message containing the word "start" to be ignored. Any log line message containing a value inignoreLogswill not be reported to AppSignal.The values can use a small subset of regular expression syntax (specifically,
^,$and.*) to narrow or expand the scope of lines that should be matched.For example, the value
"^start$"can be used to ignore any message that is exactly the word "start", but not messages that merely contain it, like "Process failed to start". The value"Task .* succeeded"can be used to ignore messages about task success regardless of the specific task name.Patch -
Appsignal.stop()now returns a promise. For your application to wait until AppSignal has been gracefully stopped, this promise must be awaited:import { Appsignal } from "@appsignal/nodejs" await Appsignal.stop() process.exit(0)In older Node.js versions where top-level await is not available, terminate the application when the promise is settled:
import { Appsignal } from "@appsignal/nodejs" Appsignal.stop().finally(() => { process.exit(0) })
Published on 2024-04-22.
Added
Minor - Heartbeats are currently only available to beta testers. If you are interested in trying it out, send an email to support@appsignal.com!
Add heartbeats support. You can send heartbeats directly from your code, to track the execution of certain processes:
import { heartbeat } from "@appsignal/nodejs" function sendInvoices() { // ... your code here ... heartbeat("send_invoices") }You can pass a function to
heartbeat, to report to AppSignal both when the process starts, and when it finishes, allowing you to see the duration of the process:import { heartbeat } from "@appsignal/nodejs" function sendInvoices() { heartbeat("send_invoices", () => { // ... your code here ... }) }If an exception is raised within the function, the finish event will not be reported to AppSignal, triggering a notification about the missing heartbeat. The exception will bubble outside of the heartbeat function.
If the function passed to
heartbeatreturns a promise, the finish event will be reported to AppSignal if the promise resolves. This means that you can use heartbeats to track the duration of async functions:import { heartbeat } from "@appsignal/nodejs" async function sendInvoices() { await heartbeat("send_invoices", async () => { // ... your async code here ... }) }If the promise is rejected, or if it never resolves, the finish event will not be reported to AppSignal.
Patch - Implement the
ignoreLogsconfiguration option, which can also be configured as theAPPSIGNAL_IGNORE_LOGSenvironment variable.The value of
ignoreLogsis a list (comma-separated, when using the environment variable) of log line messages that should be ignored. For example, the value"start"will cause any message containing the word "start" to be ignored. Any log line message containing a value inignoreLogswill not be reported to AppSignal.The values can use a small subset of regular expression syntax (specifically,
^,$and.*) to narrow or expand the scope of lines that should be matched.For example, the value
"^start$"can be used to ignore any message that is exactly the word "start", but not messages that merely contain it, like "Process failed to start". The value"Task .* succeeded"can be used to ignore messages about task success regardless of the specific task name.
Changed
Patch -
Appsignal.stop()now returns a promise. For your application to wait until AppSignal has been gracefully stopped, this promise must be awaited:import { Appsignal } from "@appsignal/nodejs" await Appsignal.stop() process.exit(0)In older Node.js versions where top-level await is not available, terminate the application when the promise is settled:
import { Appsignal } from "@appsignal/nodejs" Appsignal.stop().finally(() => { process.exit(0) })
3.3.4
19 Apr 2024Patch - Fix incorrect HTTP methods like
renderorgetServerSidePropsin Next.js 14 performance samples.
Published on 2024-04-19.
Fixed
Patch - Fix incorrect HTTP methods like
renderorgetServerSidePropsin Next.js 14 performance samples.
3.3.3
17 Apr 2024Patch - Fix
UNKNOWNmethod in Next.js 14 performance traces.
Published on 2024-04-17.
Fixed
Patch - Fix
UNKNOWNmethod in Next.js 14 performance traces.
3.3.2
22 Mar 2024Patch - Implement CPU count configuration option. Use it to override the auto-detected, cgroups-provided number of CPUs that is used to calculate CPU usage percentages.
To set it, use the
cpuCountconfiguration option, or theAPPSIGNAL_CPU_COUNTenvironment variable.
Published on 2024-03-22.
Added
Patch - Implement CPU count configuration option. Use it to override the auto-detected, cgroups-provided number of CPUs that is used to calculate CPU usage percentages.
To set it, use the
cpuCountconfiguration option, or theAPPSIGNAL_CPU_COUNTenvironment variable.
3.3.1
21 Mar 2024Patch - Don’t evaluate environment variable values to read configuration
In previous versions of the Node.js integration, environment variables were evaluated to read their values. This version instead parses them based on their expected values.
Published on 2024-03-21.
Changed
Patch - Don’t evaluate environment variable values to read configuration
In previous versions of the Node.js integration, environment variables were evaluated to read their values. This version instead parses them based on their expected values.
3.3.0
12 Mar 2024Minor - Add Node.js Apollo Gateway span mapping. This supports reporting OpenTelemetry Apollo Gateway spans as AppSignal spans, for the Node.js integration.
3.2.0
6 Mar 2024- Breaking
Minor - Breaking change: Normalize CPU metrics for cgroups v1 systems. When we can detect how many CPUs are configured in the container's limits, we will normalize the CPU percentages to a maximum of 100%. This is a breaking change. Triggers for CPU percentages that are configured for a CPU percentage higher than 100% will no longer trigger after this update. Please configure triggers to a percentage with a maximum of 100% CPU percentage.
Patch - Add histogram support to the OpenTelemetry HTTP server. This allows OpenTelemetry-based instrumentations to report histogram data to AppSignal as distribution metrics.
Patch - Support fractional CPUs for cgroups v2 metrics. Previously a CPU count of 0.5 would be interpreted as 1 CPU. Now it will be correctly seen as half a CPU and calculate CPU percentages accordingly.
Published on 2024-03-06.
Added
Patch - Add histogram support to the OpenTelemetry HTTP server. This allows OpenTelemetry-based instrumentations to report histogram data to AppSignal as distribution metrics.
Changed
- Breaking
Minor - Breaking change: Normalize CPU metrics for cgroups v1 systems. When we can detect how many CPUs are configured in the container's limits, we will normalize the CPU percentages to a maximum of 100%. This is a breaking change. Triggers for CPU percentages that are configured for a CPU percentage higher than 100% will no longer trigger after this update. Please configure triggers to a percentage with a maximum of 100% CPU percentage.
Patch - Support fractional CPUs for cgroups v2 metrics. Previously a CPU count of 0.5 would be interpreted as 1 CPU. Now it will be correctly seen as half a CPU and calculate CPU percentages accordingly.
Patch - Update bundled trusted root certificates.
Fixed
Patch - Fix (sub)traces not being reported in their entirety when the OpenTelemetry exporter sends one trace in multiple export requests. This would be an issue for long running traces, that are exported in several requests.
3.1.0
7 Feb 2024Minor - The OpenTelemetry metric exporter is now initialized by default. The integration will send default metrics from the instrumentations, and also allows you to send your custom metrics using OpenTelemetry to AppSignal to build your own dashboards.
Patch - Make the debug log message for OpenTelemetry spans from libraries we don't automatically recognize more clear. Mention the span id and the instrumentation library.
Patch - Fix an issue where queries containing a MySQL leading type indicator would only be partially sanitised.
Added
Minor - The OpenTelemetry metric exporter is now initialized by default. The integration will send default metrics from the instrumentations, and also allows you to send your custom metrics using OpenTelemetry to AppSignal to build your own dashboards.
Changed
Patch - Make the debug log message for OpenTelemetry spans from libraries we don't automatically recognize more clear. Mention the span id and the instrumentation library.
Patch - Fix an issue where queries containing a MySQL leading type indicator would only be partially sanitised.
Fixed
Patch - Fix issue with boolean config options not being set to
falseproperly for the agent configuration.
3.0.30
15 Jan 2024- Breaking
Patch - Remove the
appsignal_set_host_gaugeandappsignal_set_process_gaugeextension functions. These functions were already deprecated and did not report any metrics. Patch - When the AppSignal log level is set to "trace". Additional information from the OpenTelemetry instrumentations is now logged.
Patch - Fix disk usage returning a Vec with no entries on Alpine Linux when the
df --localcommand fails.
Added
Patch - When the AppSignal log level is set to "trace". Additional information from the OpenTelemetry instrumentations is now logged.
Changed
Patch - Fix disk usage returning a Vec with no entries on Alpine Linux when the
df --localcommand fails.
Removed
- Breaking
Patch - Remove the
appsignal_set_host_gaugeandappsignal_set_process_gaugeextension functions. These functions were already deprecated and did not report any metrics.
Fixed
Patch - Fix the demo sample recognition. Demo samples didn't show the helpful explanation box in the UI, because the
demo_sampletag was set incorrectly as an attribute.
3.0.29
7 Dec 2023Patch - Update OpenTelemetry dependencies. This fixes a known issue with Next.js and webpack compatibility and includes other fixes.
3.0.28
6 Dec 2023Patch - Update the diagnose tool URLs printed by the CLI and package to the new location in our documentation.
Patch - Fix compatibility issue with Node.js's node-gyp package and Python 3.12.0. Python 3.12.0 removed a package called "distutils", causing the extension to fail to install. Upgrade the node-gyp package with the fix for this issue.
3.0.27
6 Dec 2023Patch - Remove
routetag from HTTP server spans. Since the span will already have the route attribute as part of its name, the tag is redundant.Patch - Filter more disk mountpoints for disk usage and disk IO stats. This helps reduce noise in the host metrics by focussing on more important mountpoints.
The following mountpoint are ignored. Any mountpoint containing:
Patch - Fix an issue where the
methodtag extracted from an incoming HTTP request span would be overriden with the method used for an outgoing HTTP request span.
Changed
Patch - Remove
routetag from HTTP server spans. Since the span will already have the route attribute as part of its name, the tag is redundant.Patch - Filter more disk mountpoints for disk usage and disk IO stats. This helps reduce noise in the host metrics by focussing on more important mountpoints.
The following mountpoint are ignored. Any mountpoint containing:
/etc/hostname/etc/hosts/etc/resolv.conf/snap//proc/
Fixed
Patch - Fix an issue where the
methodtag extracted from an incoming HTTP request span would be overriden with the method used for an outgoing HTTP request span.Patch - - Support disk usage reporting (using
df) on Alpine Linux. This host metric would report an error on Alpine Linux.When a disk mountpoint has no inodes usage percentage, skip the mountpoint, and report the inodes information successfully for the inodes that do have an inodes usage percentage.
Patch - Fix missing error metrics for the error rate and error count graphs in some scenarios, like with Koa apps.
3.0.26
21 Nov 2023Patch - Bump agent to eec7f7b
Updated the probes dependency to 0.5.2. CPU usage is now normalized to the number of CPUs available to the container. This means that a container with 2 CPUs will have its CPU usage reported as 50% when using 1 CPU instead of 100%. This is a breaking change for anyone using the cpu probe.
If you have CPU triggers set up based on the old behaviour, you might need to update those to these new normalized values to get the same behaviour. Note that this is needed only if the AppSignal integration package you're using includes this change.
3.0.25
6 Nov 2023Patch - Add
initializeOpentelemetrySdkconfiguration option. This allows those who would rather take control of how OpenTelemetry is initialised in their application to skip AppSignal's initialization of the OpenTelemetry SDK.Additionally, add an
opentelemetryInstrumentationsmethod on the client, which returns AppSignal's default OpenTelemetry instrumentations, already configured to work correctly with AppSignal. The provided list of instrumentations will follow theadditionalInstrumentationsanddisableDefaultInstrumentationsconfig options, if those are set.This is not the recommended way to use AppSignal for Node.js. Only use this config option and this method if you're really sure that you know what you're doing.
When initialising OpenTelemetry, it is necessary to add the AppSignal span processor in order for data to be sent to AppSignal. For example, using the OpenTelemetry SDK:
import { SpanProcessor, Appsignal } from "@appsignal/nodejs"; // or: const { SpanProcessor, Appsignal } = require("@appsignal/nodejs") const sdk = new NodeSDK({ spanProcessor: new SpanProcessor(Appsignal.client) instrumentations: Appsignal.client.opentelemetryInstrumentations() }); sdk.start()The above snippet assumes that the AppSignal client has been initialised beforehand.
When making use of this config option, the OpenTelemetry instrumentations must be configured in the same way as it is done in the AppSignal integration. In the above snippet, the
instrumentationsproperty in the OpenTelemetry SDK is set to the AppSignal client's list of OpenTelemetry instrumentations, which are configured to work correctly with AppSignal.Patch - Add the
setSqlBodytracing helper to set the body attribute on a span that contains a SQL query. When using this helper the given SQL query will be sanitized, reducing the chances of sending sensitive data to AppSignal.import { setSqlBody } from "@appsignal/nodejs"; // Must be used in an instrumented context -- e.g. an Express route setSqlBody("SELECT * FROM users WHERE 'password' = 'secret'"); // Will be stored as: "SELECT * FROM users WHERE 'password' = ?"When the
setBodyhelper is also used, thesetSqlBodyoverwrites thesetBodyattribute.More information about our tracing helpers can be found in our documentation.
Patch - Bump agent to b604345.
Bump agent to 8260fa1.
More information on AppSignal OpenTelemetry span attributes can be found in our docs.
Added
Patch - Add
initializeOpentelemetrySdkconfiguration option. This allows those who would rather take control of how OpenTelemetry is initialised in their application to skip AppSignal's initialization of the OpenTelemetry SDK.Additionally, add an
opentelemetryInstrumentationsmethod on the client, which returns AppSignal's default OpenTelemetry instrumentations, already configured to work correctly with AppSignal. The provided list of instrumentations will follow theadditionalInstrumentationsanddisableDefaultInstrumentationsconfig options, if those are set.This is not the recommended way to use AppSignal for Node.js. Only use this config option and this method if you're really sure that you know what you're doing.
When initialising OpenTelemetry, it is necessary to add the AppSignal span processor in order for data to be sent to AppSignal. For example, using the OpenTelemetry SDK:
import { SpanProcessor, Appsignal } from "@appsignal/nodejs"; // or: const { SpanProcessor, Appsignal } = require("@appsignal/nodejs") const sdk = new NodeSDK({ spanProcessor: new SpanProcessor(Appsignal.client) instrumentations: Appsignal.client.opentelemetryInstrumentations() }); sdk.start()The above snippet assumes that the AppSignal client has been initialised beforehand.
When making use of this config option, the OpenTelemetry instrumentations must be configured in the same way as it is done in the AppSignal integration. In the above snippet, the
instrumentationsproperty in the OpenTelemetry SDK is set to the AppSignal client's list of OpenTelemetry instrumentations, which are configured to work correctly with AppSignal.Patch - Add the
setSqlBodytracing helper to set the body attribute on a span that contains a SQL query. When using this helper the given SQL query will be sanitized, reducing the chances of sending sensitive data to AppSignal.import { setSqlBody } from "@appsignal/nodejs"; // Must be used in an instrumented context -- e.g. an Express route setSqlBody("SELECT * FROM users WHERE 'password' = 'secret'"); // Will be stored as: "SELECT * FROM users WHERE 'password' = ?"When the
setBodyhelper is also used, thesetSqlBodyoverwrites thesetBodyattribute.More information about our tracing helpers can be found in our documentation.
Changed
Patch - Bump agent to b604345.
Add an exponential backoff to the retry sleep time to bind to the StatsD, NGINX and OpenTelemetry exporter ports. This gives the agent a longer time to connect to the ports if they become available within a 4 minute window.
Changes to the agent logger:
Logs from the agent and extension now use a more consistent format in logs for spans and transactions.
Logs that are for more internal use are moved to the trace log level and logs that are useful for debugging most support issues are moved to the debug log level. It should not be necessary to use log level 'trace' as often anymore. The 'debug' log level should be enough.
Add
running_in_containerto agent diagnose report, to be used primarily by the Python package as a way to detect if an app's host is a container or not.
Bump agent to 8260fa1.
Add
appsignal.sql_bodymagic span attribute for OpenTelemetry spans. When this attribute is detected, we store the value as the span/event body. This span is sanitized beforehand so it doesn't contain any sensitive data and helps to group events in our backend. When used in combination with theappsignal.bodyattribute, the newappsignal.sql_bodyattribute is leading.
More information on AppSignal OpenTelemetry span attributes can be found in our docs.
Patch - Print more path details in the diagnose CLI output. It will now print details like if a path exists, the ownership of a path and if it's writable or not to help debug issues locally.
Patch - Bump agent to 1dd2a18.
When adding an SQL body attribute via the extension, instead of truncating the body first and sanitising it later, sanitise it first and truncate it later. This prevents an issue where queries containing very big values result in truncated sanitisations.
Fixed
Patch - Fix a TypeScript types compatibility error upon app compilation when using the AppSignal Express error handler.
A whole project to check? Paste its package.json in the dependency check: every deprecated, outdated or vulnerable dependency, with what to upgrade to. Free, no account.