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

Ensure that your application components are supported and the platform for your APM library is supported. Also, verify your firewall configuration permits TCP/HTTPS/TLS outbound connections to (where xx-yy is determined by the URL you use to access SolarWinds Observability, see Endpoint URIs) using port 443. See Firewall or access control requirements.

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

  1. In SolarWinds Observability, click Add Data in the upper-right corner.

  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, then click Next.
    • Select Use Existing Token and select an ingestion token from the list, 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. When the Node.js Library successfully connects to the SolarWinds APM collector, the Waiting for Connection button in SolarWinds Observability changes to OK.

  9. Click OK to finish setting up the service.

Custom instrumentation

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