Documentation forSolarWinds Observability

Add a Node.js service

The solarwinds-apm package provides automatic tracing and metrics for Node.js applications. For new features, fixed issues, and updated components, see the Node.js Library release notes.

Get started

Before you start

Verify the following to ensure the library can collect and transmit data:

  • The platform where your APM library will be installed is supported.

  • Your application components are supported by the library.

  • Your firewall configuration permits TCP/HTTPS/TLS outbound connections to (where xx-yy is determined by the URL you use to access SolarWinds Observability, described in Data centers and endpoint URIs) using port 443. See Firewall or access control requirements.

    If your firewall or access control requirements do not allow such connections, configure the library to send data through a proxy.

Remove other APM libraries from your Node.js application before using the SolarWinds Observability Node.js Library.

To enable instrumentation for a Node.js application and send the data to SolarWinds Observability:

  1. In SolarWinds Observability, click Add Data at the top.

  2. In the Add Data dialog, click Services.

  3. Type a Name for your service and select the Node.js (Linux) language.

  4. Create or select an API Ingestion token to use when sending your collected service data by doing either of the following:

    • Select Generate New Token and enter an Ingestion Token Name, and then click Next.
    • Select Use Existing Token and select an ingestion token from the list, and then click Next.
  5. Download and install the Node.js Library on the host system.

  6. Enable the library for monitoring and configure the Service key during installation. Use the Service key shown in the Add Data dialog.

  7. Restart the application to load the library and automatically begin reporting data.

  8. Wait for the Node.js Library to successfully connect to the SolarWinds APM collector and for the Waiting for Connection button in SolarWinds Observability to change to OK.

  9. Click OK to finish setting up the service.

    To view data collected for the newly configured entity in the Entity Explorer, click the name of the entity type in the confirmation dialog in the lower-left corner. It may take a few seconds for data to appear for the newly created entity. See Entity Explorer for details.

    For transaction and trace data to appear in the Entity Explorer and Traces Explorer, your service must be running and in use.

Custom instrumentation

If you have code or a library that is not on the platform support list, use our SDK to customize.