Documentation forSolarWinds Observability

Migrate the Node.js Library from AppOptics to SolarWinds Observability

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.

Migrate from AppOptics

AppOptics users can use the following information to migrate to SolarWinds Observability.

  1. Remove any references to the AppOptics custom instrumentation API in your application code.

    Save a list detailing your application's usage so it can be updated for the SolarWinds Observability Node.js Library's instrumentation API.

  2. Uninstall the AppOptics agent.

    1. Undo the steps taken to load the library into your application. See Loading instructions in the AppOptics APM repo.

      For example, depending on the methods used to load the library into your application, you may need to remove the -r appoptics-apm command at node startup or remove the require('appoptics-apm') line in the application code.

    2. Uninstall the appoptics-apm package and remove it from your application dependencies.

  3. Install the SolarWinds library for SolarWinds Observability.

  4. Set the collector configuration option to the AppOptics endpoint Use a config option or an environment variable to override the default APM collector endpoint.

  5. Update your application to use the new instrumentation API, if needed.

    See appoptics-apm migration guide to solarwinds-apm for a summary of changes, and Node.js Library instrumentation SDK for more information about the SolarWinds Observability Node.js Library's instrumentation API.