Documentation forSolarWinds Observability

Add a service

Before adding your service entity to SolarWinds Observability, ensure that your platform, components, and application language are supported. Also, verify your firewall configuration permits TCP/HTTPS/TLS outbound connections to apm.collector.xx-yy.cloud.solarwinds.com (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.

To enable instrumentation for an 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 language for your operating system.

  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. Follow the instructions provided to install and enable the library. During installation, configure the Service key and correct ingestion endpoint during installation. Use the Service key shown in the Add Data dialog.

    An example Service key statement for Linux applications:

    An example Service key statement for Windows applications:

  6. Enable the library and start sending monitoring data by restarting the service, server, or application host.

  7. When the library successfully connects to the SolarWinds APM collector, the Waiting for Connection button in SolarWinds Observability changes to OK. If a connection is not successful, you may need to set up Proxy configuration to forward collected data to the SolarWinds APM collector.

  8. 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 Services 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.

For detailed instructions specific to your application's language and operating system, as well as powerful customization options to tailor your service's monitoring to fit your precise needs, see the following:

You can also Configure custom instrumentation to get extra application-specific visibility in SolarWinds Observability.