README
¶
Icinga Go Library
The Icinga Go Library is a collection of Go packages used for common tasks in Icinga's Go applications.
While some of these packages are intended for internal use, others might be useful for extending Icinga applications.
For example, the notifications package is designed for interoperability with Icinga Notifications.
Documentation
The Go package documentation is available online at pkg.go.dev/github.com/icinga/icinga-go-library.
License
Icinga Go Library and its documentation are licensed under the terms of the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config provides utilities for configuration parsing and loading.
|
Package config provides utilities for configuration parsing and loading. |
|
Package notifications contains subpackages related to Icinga Notifications.
|
Package notifications contains subpackages related to Icinga Notifications. |
|
event
Package event describes the central Icinga Notifications Event type.
|
Package event describes the central Icinga Notifications Event type. |
|
plugin
Package plugin implements a high-level Icinga Notifications Channel Plugin API.
|
Package plugin implements a high-level Icinga Notifications Channel Plugin API. |
|
rpc
Package rpc implements the low-level JSON RPC connection between a channel plugin and Icinga Notifications.
|
Package rpc implements the low-level JSON RPC connection between a channel plugin and Icinga Notifications. |
|
source
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. |
|
Package strcase implements functions to convert a camelCase UTF-8 string into various cases.
|
Package strcase implements functions to convert a camelCase UTF-8 string into various cases. |
|
Package testutils provides utilities for testing, including generic test case structures and helper functions for error checking and temporary file handling.
|
Package testutils provides utilities for testing, including generic test case structures and helper functions for error checking and temporary file handling. |
Click to show internal directories.
Click to hide internal directories.