upstream/icingadb
1
0
Fork 0
mirror of https://github.com/Icinga/icingadb.git synced 2026-06-08 16:34:29 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

doc/01-About.md: Big Picture

Browse source 
Inspired by the "Big Picture" section in the Icinga Notifications
documentation[^0], such a section was introduced for Icinga DB as well.
It aims to describe the essential components in an Icinga DB setup along
the architecture diagram for novice users. This hopefully helps new
users to understand what Icinga DB actually is and how it interconnects.

[^0]: https://icinga.com/docs/icinga-notifications/latest/#big-picture
This commit is contained in:
Alvar Penning 2025-04-25 13:19:32 +02:00
parent ee82ee7d8d
commit 209efac134
No known key found for this signature in database
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/01-About.md
View file

@ -12,8 +12,28 @@ visualizing monitoring data in the Icinga ecosystem, consisting of:
[Icinga DB Web](https://icinga.com/docs/icinga-db-web) module enabled,
which connects to both Redis® and the database to display and work with the most up-to-date data
## Big Picture
![Icinga DB Architecture](images/icingadb-architecture.png)
Icinga DB consists of several components in an Icinga setup.
This section tries to help understanding how these components relate, following the architecture diagram shown above.
First things first, Icinga DB is not a database itself, but consumes and passes data from Icinga 2 to be displayed in Icinga DB Web and persisted in a relational database.
Let's start with Icinga 2.
With the Icinga DB feature enabled, Icinga 2 synchronizes its state to a Redis® server that can be queried by both the Icinga DB daemon and Icinga DB Web.
The Icinga DB daemon reads all the information from Redis®, transforms it, and finally inserts it into a relational database such as MySQL, MariaDB, or PostgreSQL.
Doing so removes load from Icinga 2 and lets Icinga DB do the more time-consuming database operations in bulk.
In addition, the Icinga DB daemon does some bookkeeping, such as removing old history entries if a retention is configured.
To display information in Icinga Web 2, the Icinga DB Web module fetches the latest service and host state information from Redis®.
Additional monitoring data and history information is retrieved from the relational database.
Icinga DB Web also connects to the Icinga 2 API with its Command Transport to acknowledge problems, trigger check executions, and so on.
These are the components of Icinga DB embedded into an Icinga setup with Icinga 2 and Icinga Web 2.
## Installation
To install Icinga DB see [Installation](02-Installation.md).