Prometheus metrics

PowerShell Universal
1

Hi,
I’m trying to install metrics using this guide but I have no success

My appsettings.json looks like this:
“Plugins”: [
“UniversalAutomation.LiteDBv5”,
“PowerShellUniversal.Plugin.OpenTelemetry”
],
“OpenTelemetry”: {
“Otlp”: {
“Endpoint”: “http://localhost:9090/api/v1/otlp/v1/metrics”
}
},

I also added $Env:OpenTelemetry__Otlp__Endpoint = ‘http://localhost:9090/api/v1/otlp/v1/metrics’
1

When I go to http://localhost:9090/api/v1/otlp/v1/metrics I have nothing and if I run prometheus and go to the same page I have this result
2

Query for http_server_duration_milliseconds_count

3
31910×537 36.8 KB

I have nightly build 4.2.15 (8475317850)

Am I missing something?

Thank you

2

Did you ever figure this out?

3

Curious if you’ve figured this out as well. I’m looking at implementing and exposing some custom app/dashboard level metrics. Would be nice if there was some more documentation around this.

4

Digging into this a little bit more - we’re running PSU v4.4.1 and I noticed that it doesn’t ship with the PowerShellUniversal.Plugin.OpenTelemetry module.

Can anyone from ironmansoftware comment or update on whether the otel libraries were added into any of the stable build at some point?

5

I did not.

6

Can anyone from ironmansoftware comment or update on whether the otel libraries were added into any of the stable build at some point?

Scratch this, not necessary. I found the plugin libraries under C:\program files (x86)\universal\plugins

So there’s potentially a misunderstanding on my part. I’ve enabled the open telemetry plugin & added the otlp endpoint in my appsettings.json:

...
  "Plugins": [
    "SQL",
    "PowerShellUniversal.Plugin.OpenTelemetry"
  ],
  "OpenTelemetry": {
    "Otlp": {
        "Endpoint": "http://localhost:9090/api/v1/otlp/v1/metrics"
    }
  },

I guess I’m expecting to see raw metrics at http://localhost:9090/api/v1/otlp/v1/metrics like I would when running a prometheus exporter and hitting /metrics, but I just get localhost refused to connect.

7

I tried this in v4 and I gave up… I haven’t tested in v5 yet but now that i’m seeing this i’m reminded I need to try again.

8

Honestly, I haven’t tried this myself since I wrote that blog post. Feel free to open a GitHub issue for it. It should work on v4 and v5.

9

Ticket created, OpenTelemetry does not work · Issue #4355 · ironmansoftware/powershell-universal · GitHub

10

It looks like this was a Prometheus\PSU config issue on my end. I downloaded the latest version and had to use the following command line to start the OTLP connector.

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

I also had to update the URL used by PSU.

"OpenTelemetry__Otlp__Endpoint": "http://localhost:9090/metrics"

Once that was done, I am now receiving metrics in Prometheus from PSU.

image
image1078×837 26.6 KB

1 Like
11

Thanks for the test & update here Adam.

I just tried to get this running in our environment running PSU 4.4.1 with no luck. I’m not able to see any psu/platform related metrics in prometheus.

Running prometheus-3.1.0.windows-amd64

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

in appsettings.json:

  "OpenTelemetry": {
    "Otlp": {
        "Endpoint": "http://localhost:9090/metrics"
    }
  },

Screenshot 2025-02-24 at 3.13.28 PM
Screenshot 2025-02-24 at 3.13.28 PM2670×1312 175 KB

EDIT: opened an issue on github: OTEL metrics not found in prometheus · Issue #4427 · ironmansoftware/powershell-universal · GitHub