Itselves.AlertManager.Prometheus 0.1.0

dotnet add package Itselves.AlertManager.Prometheus --version 0.1.0                
NuGet\Install-Package Itselves.AlertManager.Prometheus -Version 0.1.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="Itselves.AlertManager.Prometheus" Version="0.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Itselves.AlertManager.Prometheus --version 0.1.0                
#r "nuget: Itselves.AlertManager.Prometheus, 0.1.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.
// Install Itselves.AlertManager.Prometheus as a Cake Addin
#addin nuget:?package=Itselves.AlertManager.Prometheus&version=0.1.0

// Install Itselves.AlertManager.Prometheus as a Cake Tool
#tool nuget:?package=Itselves.AlertManager.Prometheus&version=0.1.0                

Itselves.AlertManager.Prometheus

.NET library for alert manager which use Prometheus like a provider

Based on libraries:

Install

Nuget:

Install-Package Itselves.AlertManager.Prometheus

Quick start

  • Add AddPrometheusAlertManager into DI container with extension

Do not forget to add Prometheus.Client into DI container

services
    .AddPrometheusAlertManager(opt => {});
  • Configure appsetting.json
{
    "PrometheusAlertManagerOptions": {
        "MetricOptions": {
            "Name": "alert_metrics",
            "Description": "test alert metrics",
            "Label": "alert"
        },
        "PreInitializeOptions": {
            "PreInitialize": true,
            "Alerts": [
                "alert1",
                "alert2"
            ]
        },
        "InitialDelay": "00:00:30",
        "LogLevel": "Error"
    }
}

Configuration

PrometheusAlertManagerOptions

  1. MetricOptions - options for prometheus metrics
  2. PreInitializeOptions - options for pre init prometheus metrics
  3. InitialDelay - delay to send first alert to avoid batching events
  4. LogLevel - log level for alerts

PrometheusMetricOptions

  1. Name - name of prometheus metric
  2. Description - description of prometheus metric
  3. Label - label for alert name

PrometheusPreInitializeOptions

  1. PreInitialize - need to preinit alerts by 0
  2. Alerts - alert names which should be preinited

Using in prometheus alert manager

You can create alert in prom-alertmanager by using query like:

sum(increase(alert_metrics{alert="alert1"}[10m])) > 0

Using example

1. Call with existing alert

await alertManager.AlertAsync(new Alert("name"), default);

2. Call with custom alert

await alertManager.AlertAsync(new CustomAlert(), default);

public sealed class CustomAlert : Alert
{
    public CustomAlert() : base("custom") {}
}

3. Call with string alert name

await alertManager.AlertAsync("name", default);
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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.

Version Downloads Last updated
0.1.0 126 9/15/2024