@appsignal/nodejs - npm Package Versions

3.0.25

Added

• ab7f3c7 patch - Add initializeOpentelemetrySdk configuration 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 opentelemetryInstrumentations method on the client, which returns AppSignal's default OpenTelemetry instrumentations, already configured to work correctly with AppSignal. The provided list of instrumentations will follow the additionalInstrumentations and disableDefaultInstrumentations config 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 instrumentations property in the OpenTelemetry SDK is set to the AppSignal client's list of OpenTelemetry instrumentations, which are configured to work correctly with AppSignal.

• daa8982 patch - Add the setSqlBody tracing 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 setBody helper is also used, the setSqlBody overwrites the setBody attribute.

  More information about our tracing helpers can be found in our documentation.

Changed

• 33bce2e 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_container to 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_body magic 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 the appsignal.body attribute, the new appsignal.sql_body attribute is leading.

  More information on AppSignal OpenTelemetry span attributes can be found in our docs.

• 285f89e 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.

• 3204cdd 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

• 3367dfe patch - Fix a TypeScript types compatibility error upon app compilation when using the AppSignal Express error handler.

3.0.24

Changed

• 2eb17b0 patch - Bump agent to e8207c1.

  • Add memory_in_percentages and swap_in_percentages host metrics that represents metrics in percentages.
  • Ignore /snap/ disk mountpoints.
  • Fix issue with the open span count in logs being logged as a negative number.
  • Fix agent's TCP server getting stuck when two requests are made within the same fraction of a second.

• 037fcaa patch - Update Fastify dependency to make it compatible with Fastify 5

3.0.23

Changed

• aad5535 patch - Update OpenTelemetry dependencies to the latest versions.

3.0.22

Changed

• 4d96c96 patch - Report express route parameters. If a route is defined like /user/:id, the id parameter will be reported from now on in the "Parameters" box on AppSignal.com.

3.0.21

Changed

• 2c91c70 patch - Improve the behaviour of the GraphQL instrumentation, so that it creates less redundant spans for similar items in a list, and less trivial spans for attribute resolutions.

Fixed

• 2c91c70 patch - Fix a misleading platform mismatch error when the AppSignal extension fails to load on musl-based systems.

3.0.20

Fixed

• eaaf01c patch - Bump agent to 6133900.

  • Fix disk_inode_usage metric name format to not be interpreted as a JSON object.

3.0.19

Added

• 5cdf57b patch - Add the hostRole config option. This config option can be set per host to generate some metrics automatically per host and possibly do things like grouping in the future.

3.0.18

Changed

• 7edc179 patch - Bump agent to version d789895.

  • Increase short data truncation from 2000 to 10000 characters.
  • Include HTTP request method on Next.js samples as incident action name. Instead of /path it will now report GET /path.
  • Add a extractor for Remix js spans.

3.0.17

Added

• d5ec649 patch - Report total CPU usage host metric for VMs. This change adds another state tag value on the cpu metric called total_usage, which reports the VM's total CPU usage in percentages.
• e37c108 patch - Add the --config flag to diagnose command to specify a custom path for your AppSignal configuration file to be taken into account when running the diagnose of your AppSignal installation.

Changed

• 702d4df patch - Bump agent to 6bec691.

  • Upgrade sql_lexer to v0.9.5. It adds sanitization support for the THEN and ELSE logical operators.

3.0.16

Added

• 8b9a84d patch - Allow configuration of the agent's StatsD server port through the statsdPort option.
• 655d04f patch - Use RENDER_GIT_COMMIT environment variable as revision if no revision is specified.
• 7bfaa61 patch - Support Prisma 5
• 2dd8b61 patch - Allow configuration of the agent's TCP and UDP servers using the bindAddress config option. This is by default set to 127.0.0.1, which only makes it accessible from the same host. If you want it to be accessible from other machines, use 0.0.0.0 or a specific IP address.

Changed

• 6afc890 patch - Bump agent to fd8ee9e.

  • Rely on APPSIGNAL_RUNNING_IN_CONTAINER config option value before other environment factors to determine if the app is running in a container.
  • Fix container detection for hosts running Docker itself.
  • Add APPSIGNAL_STATSD_PORT config option.

• c2f7b2b patch - Bump agent to 32590eb.

  • Only ignore disk metrics that start with "loop", not all mounted disks that end with a number to report metrics for more disks.

Fixed

• d1c9ab7 patch - Remove agent download file after extraction. This save a couple megabytes of space that are no longer needed when the agent and extension have been extracted from the downloaded .tar.gz file, reducing the overall app size.