Faactory.Channels.Prometheus 0.8.0

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
Additional Details

This package is no longer supported or needed in Channels v2.x and has been marked as deprecated.

There is a newer version of this package available.
See the version list below for details. 
dotnet add package Faactory.Channels.Prometheus --version 0.8.0
                    


                    

                
NuGet\Install-Package Faactory.Channels.Prometheus -Version 0.8.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Faactory.Channels.Prometheus" Version="0.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Faactory.Channels.Prometheus" Version="0.8.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Faactory.Channels.Prometheus" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Faactory.Channels.Prometheus --version 0.8.0
                    


                    

                
#r "nuget: Faactory.Channels.Prometheus, 0.8.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Faactory.Channels.Prometheus@0.8.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Faactory.Channels.Prometheus&version=0.8.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Faactory.Channels.Prometheus&version=0.8.0
                    


                            Install as a Cake Tool

Prometheus Metrics

Extends Channels by providing Prometheus metrics.

The exported metrics are:

  • channels_active_total: Total number of active channels.
  • channels_bytes_received_total: Total number of bytes received.
  • channels_bytes_sent_total: Total number of bytes sent.

The project makes use of prometheus-net.

Usage

Install the package from NuGet

dotnet add package Faactory.Channels.Prometheus

To calculate the metrics, you just need to register the metrics middleware. This can be applied to either a service or a client channel builder.

IChannelBuilder channel = ...;

channel.UsePrometheusMetrics();

To export the metrics, the easiest way is to install prometheus-net.AspNetCore package and register the pre-built middleware. If no other HTTP functionality is required, this is a good option.

IServiceCollection services = ...;

services.AddMetricServer( options =>
{
    options.Port = 8081;
} );

You can find a more detailed sample project under the example folder. There are other ways to export the metrics, which can be found in the prometheus-net documentation.

Labels

By default, metrics are created just with the channelId label, which contains the channel identifier. However, it is possible to extend this and add more labels to the metrics.

To add more labels, you can add items to the channel's data dictionary. The middleware will automatically add all items with the prefix prometheus.label. to the metrics.

public class SampleIdentityHandler : ChannelHandler<IdentityInformation>
{
    public override Task ExecuteAsync( IChannelContext context, IdentityInformation data )
    {
        // ...

        /*
        This adds an `uuid` label to the metrics. The label will be included in all metrics.
        */
        context.Channel.Data["prometheus.label.uuid"] = data.UUId;

        return Task.CompletedTask;
    }
}
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.