notifications

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 29, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Overview

Package notifications contains subpackages related to Icinga Notifications.

The event package defines the central Event type used to describe Icinga Notifications events.

When implementing a new Icinga Notifications Channel Plugins to allow notifications be sent over a new way, take a look at the plugin package. Internally, this uses the rpc package, which, however, should not be relevant for mere channel plugin implementations.

When implementing a new Icinga Notifications Source to submit events to Icinga Notifications' HTTP API, consider the source package.

Index

Constants

View Source
const (
	// MethodLog is the JSON-RPC method used by channel plugins to log messages to Icinga Notifications' logging system.
	//
	// Note: This method is intended to be used by channel plugins to make JSON-RPC calls back to Icinga Notifications
	// to log messages. It is not meant to be implemented by channel plugins themselves.
	MethodLog = "channel::Log"
)
View Source
const XIcingaRejectIfRelationsIncomplete = "X-Icinga-Reject-If-Relations-Incomplete"

XIcingaRejectIfRelationsIncomplete is a custom HTTP header that can be used by sources to indicate that Icinga Notifications should reject the request if the event's relations are incomplete.

By default, Icinga Notifications will attempt to process events even if their relations are incomplete, which may not be desirable in some cases. If a source sets this header to "true", Icinga Notifications rejects the request with all the missing relations in the response body, allowing the source to retry with the complete set of relations.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
Package event describes the central Icinga Notifications Event type.
Package event describes the central Icinga Notifications Event type.
Package jsonrpc provides a wrapper around the github.com/sourcegraph/jsonrpc2 package to facilitate communication between Icinga Notifications and its plugins using the JSON-RPC 2.0 protocol.
Package jsonrpc provides a wrapper around the github.com/sourcegraph/jsonrpc2 package to facilitate communication between Icinga Notifications and its plugins using the JSON-RPC 2.0 protocol.
Package plugin implements a high-level Icinga Notifications Channel Plugin API.
Package plugin implements a high-level Icinga Notifications Channel Plugin API.
Package source implements an Icinga Notifications source to send events to the Icinga Notifications API.
Package source implements an Icinga Notifications source to send events to the Icinga Notifications API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL