Documentation forSolarWinds Observability

Add a Python service

The Python Library is a custom distro based on OpenTelemetry Python instrumentation, providing automatic tracing and metrics for Python-based applications. In addition to offering full compatibility with OpenTelemetry, the Python Library adds extra features. For new features, fixed issues, and updated components, see the Python 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 Python 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 Python language.

  4. Create or select an API Ingestion token to use when sending your collected Entity type 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, install, and enable the Python Library on the host system and configure the Service key and correct ingestion endpoint during installation. Use the Service key shown in the Add Data dialog.

  6. Restart your Python application to load the library and start reporting data to the SolarWinds APM collector

  7. When the Python Library successfully connects to the SolarWinds APM collector, the Waiting for Connection button in SolarWinds Observability changes to OK.

  8. Click OK to finish setting up the service.

To tailor the installed library to your monitoring needs, see Configure the Python Library.

Custom instrumentation

Custom instrumentation can be used to get extra application-specific visibility in SolarWinds Observability, both adding custom spans for distributed tracing and adding custom timers or counters for metric reporting and alerting. See Python Library instrumentation SDK.