spring-boot-starter-prometheus-alerts

Starter for spring boot application witch catch alerts from Prometheus Alertmanager

License	MIT
Categories	Spring Boot Container Microservices Prometheus Application Testing & Monitoring Monitoring
GroupId	com.github.mikesafonov
ArtifactId	spring-boot-starter-prometheus-alerts
Last Version	1.0.0
Release Date	Sep 1, 2019
Type	jar
Description	spring-boot-starter-prometheus-alerts Starter for spring boot application witch catch alerts from Prometheus Alertmanager
Project URL	https://github.com/MikeSafonov/spring-boot-starter-prometheus-alerts
Project Organization	com.github.mikesafonov
Source Code Management	https://github.com/MikeSafonov/spring-boot-starter-prometheus-alerts

Download spring-boot-starter-prometheus-alerts

Filename	Size
spring-boot-starter-prometheus-alerts-1.0.0.pom
spring-boot-starter-prometheus-alerts-1.0.0.jar	11 KB
spring-boot-starter-prometheus-alerts-1.0.0-sources.jar	5 KB
spring-boot-starter-prometheus-alerts-1.0.0-javadoc.jar	47 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.mikesafonov/spring-boot-starter-prometheus-alerts/ -->
<dependency>
    <groupId>com.github.mikesafonov</groupId>
    <artifactId>spring-boot-starter-prometheus-alerts</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.mikesafonov/spring-boot-starter-prometheus-alerts/
implementation 'com.github.mikesafonov:spring-boot-starter-prometheus-alerts:1.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.mikesafonov/spring-boot-starter-prometheus-alerts/
implementation ("com.github.mikesafonov:spring-boot-starter-prometheus-alerts:1.0.0")

Apache Buildr

'com.github.mikesafonov:spring-boot-starter-prometheus-alerts:jar:1.0.0'

Apache Ivy

<dependency org="com.github.mikesafonov" name="spring-boot-starter-prometheus-alerts" rev="1.0.0">
  <artifact name="spring-boot-starter-prometheus-alerts" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.mikesafonov', module='spring-boot-starter-prometheus-alerts', version='1.0.0')
)

Scala SBT

libraryDependencies += "com.github.mikesafonov" % "spring-boot-starter-prometheus-alerts" % "1.0.0"

Leiningen

[com.github.mikesafonov/spring-boot-starter-prometheus-alerts "1.0.0"]

Dependencies

runtime (3)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter	jar
org.springframework.boot : spring-boot-starter-web	jar
org.slf4j : slf4j-api	jar

test (4)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-test	jar
org.junit.jupiter : junit-jupiter	jar	5.5.1
org.mockito : mockito-core	jar
org.assertj : assertj-core	jar	3.13.1

Project Modules

There are no modules declared in this project.

spring-boot-starter-prometheus-alerts

This is a starter for spring boot application witch catch alerts from Prometheus Alertmanager.

The starter is available at https://repo1.maven.org/maven2/ repository.

Using gradle:

repositories {
    maven {url "https://repo1.maven.org/maven2/"}
}
dependencies {
    implementation 'com.github.mikesafonov:spring-boot-starter-prometheus-alerts:1.0.0'
}

The only thing you need to do after adding the dependency is to create a bean with implementation of NotificationService interface:

@Serivce
public class MyNotificationService implementation NotificationService {
...
} 

Configuration

The following properties can be configured:

property	description
prometheus.alertmanager.endpoint.base	base url for POST request mapping for prometheus alert (default /alert)

Build

Build from source

You can build application using following command:

./gradlew clean build -x signArchives

Requirements:

JDK >= 1.8

Unit tests

You can run unit tests using following command:

./gradlew test

Alertmanager configuration

route:
  receiver: 'my-application'
receivers:
- name: 'my-application'
  webhook_configs:
    - url: http://<application-host>:<application-port>/alert

Usage example

• prometheus-telegram-alert

Contributing

Feel free to contribute. New feature proposals and bug fixes should be submitted as GitHub pull requests. Fork the repository on GitHub, prepare your change on your forked copy, and submit a pull request.

IMPORTANT!

Before contributing please read about Conventional Commits / Conventional Commits RU

Versions

Version
1.0.0 Sep 1, 2019