Skip to content

Commit 209efac

Browse files
committed
doc/01-About.md: Big Picture
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
1 parent ee82ee7 commit 209efac

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/01-About.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,28 @@ visualizing monitoring data in the Icinga ecosystem, consisting of:
1212
[Icinga DB Web](https://icinga.com/docs/icinga-db-web) module enabled,
1313
which connects to both Redis® and the database to display and work with the most up-to-date data
1414

15+
## Big Picture
16+
1517
![Icinga DB Architecture](images/icingadb-architecture.png)
1618

19+
Icinga DB consists of several components in an Icinga setup.
20+
This section tries to help understanding how these components relate, following the architecture diagram shown above.
21+
22+
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.
23+
24+
Let's start with Icinga 2.
25+
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.
26+
27+
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.
28+
Doing so removes load from Icinga 2 and lets Icinga DB do the more time-consuming database operations in bulk.
29+
In addition, the Icinga DB daemon does some bookkeeping, such as removing old history entries if a retention is configured.
30+
31+
To display information in Icinga Web 2, the Icinga DB Web module fetches the latest service and host state information from Redis®.
32+
Additional monitoring data and history information is retrieved from the relational database.
33+
Icinga DB Web also connects to the Icinga 2 API with its Command Transport to acknowledge problems, trigger check executions, and so on.
34+
35+
These are the components of Icinga DB embedded into an Icinga setup with Icinga 2 and Icinga Web 2.
36+
1737
## Installation
1838

1939
To install Icinga DB see [Installation](02-Installation.md).

0 commit comments

Comments
 (0)