alertmanager

Documentation

Overview

Package alertmanager provides definitions and functionality related to Alertmanager notifications.

Index

• type Handler
  • func (h *Handler) CreateAlert(ctx *gin.Context)
• type HandlerSettings

Types

type Handler

type Handler struct {
	DP       api.NotificationDispatcher
	Settings HandlerSettings
}

Handler holds information for processing alerts received via Alertmanager.

func (*Handler) CreateAlert

func (h *Handler) CreateAlert(ctx *gin.Context)

CreateAlert godoc @Summary Create an Alert @Description Creates an alert that is send to the channel as a notification. This endpoint is compatible with alertmanager webhooks. @ID post-alert @Tags Alertmanager @Accept json @Produce json @Param token query string true "Channels token, can also be provieded in the header" @Param data body model.AlertmanagerWebhook true "alertmanager webhook call" @Success 200 {object} []model.Notification @Failure 500,404,403 "" @Router /alert [post]

type HandlerSettings

type HandlerSettings struct {
	TitleAnnotation   string
	MessageAnnotation string
}

HandlerSettings represents the settings for processing alerts received via Alertmanager.