rocklib / rocklib.distributedtracing Goto Github PK

Prometheus will provide correlation to the 3rd pillar of observability, metrics. This library already provides correlation of the other two, logs & traces. Tracing is provided by this library, while logging is largely handled by RockLib.Logging. (Logging simply needs to be configured to enable the HttpContextProvider, by the app.)

Dotnet’s OpenTelemetry framework is expected to reveal Prometheus support by mid-2021, with the formal release (by Microsoft) coming later in the year. We anticipate largely a plug-n-play effort to integrate that library into this one; there-in exposing support to RockLib-instrumented applications.

Actionable tasks; eventually to be storied in TFS:

1. Integrate the OpenTelemetry Prometheus exporter into this library. (Includes configuration from AppSettings.)
2. Write an Exporter for RockLib.Metrics that can transpose our existing metrics collection (style & format) into Prometheus format.
3. Document how to install a Prometheus Exporter (Agent) to the localhost. This agent will probe the OpenTelemetry endpoint (http://localhost:<port>/metrics) to ‘scrape’ the metrics from the application, and relay them to the Prometheus Collector.
4. Conditional: Should OpenTelemetry expose better methods to collect our structured metrics, incorporate those into this and/or the Metrics library so developers can adopt them. Obsolete/deprecate the legacy (“InfluxDB”) ways. Perhaps we can abstract this support from the Metrics library (via an Adapter pattern), but it’s impossible to know until the specs are released.