OpenTelemetry

Send telemetry data to OpenTelemetry.

Identifier: PowerShellUniversal.Plugins.OpenTelemetry

OpenTelemetry is a collection of APIs, SDKs, and tools. Use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help you analyze your software’s performance and behavior.

The plugin enables integration with the technology. You can use App Settings to configure where to send data. PowerShell Universal currently only exposes a single OTLP endpoint configuration. The below configuration would work with Prometheus.

{    
    "OpenTelemetry": {
        "Otlp": {
            "Endpoint": "http://localhost:9090/api/v1/otlp/v1/metrics"
        }
    }
}

Prometheus

You can configure Prometheus to collect PowerShell Universal data by starting it with the OTLP collector enabled.

 .\prometheus.exe --web.enable-otlp-receiver

Within PowerShell Universal, you will need to specify the /api/v1/otlp/v1/metrics URL for the Prometheus server. This example uses Prometheus 3.5.

{    
    "OpenTelemetry": {
        "Otlp": {
            "Endpoint": "http://localhost:9090/api/v1/otlp/v1/metrics"
        }
    }
}