upstream/icingadb
1
0
Fork 0
mirror of https://github.com/Icinga/icingadb.git synced 2026-04-21 14:20:33 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Update configuration docs

Browse source
This commit is contained in:
Eric Lippmann 2021-05-27 10:13:09 +02:00
parent 3f26374eac
commit e1efa23ea4
2 changed files with 23 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/02-Installation.md
View file

@ -186,7 +186,7 @@ cat /usr/share/icingadb/schema/mysql/mysql.schema.sql | mysql -uroot icingadb -p
Foreground:
```
icingadb -config /etc/icingadb/icingadb.ini
icingadb -config /etc/icingadb/icingadb.yml
```
Systemd service:

50
doc/03-Configuration.md
View file

@ -2,43 +2,37 @@
## Overview <a id="configuration-overview"></a>
The configuration is stored in `/etc/icingadb/icingadb.ini`.
The configuration is stored in `/etc/icingadb/icingadb.yml`.
## General Configuration <a id="configuration-general"></a>
## Redis Configuration <a id="configuration-redis"></a>
### Redis Configuration <a id="configuration-general-redis"></a>
Data resource where Icinga 2 is writing monitoring data.
Configuration of the Redis that Icinga writes to.
Option | Description
-------------------------|-----------------------------------------------
host | **Optional.** Redis host. Defaults to `127.0.0.1`.
port | **Optional.** Redis port. Defaults to `6380`.
password | **Optional.** Redis password. Not set by default.
pool\_size | **Optional.** Maximum number of socket connections. Defaults to `64`.
address | **Required.** Redis host:port address.
### MySQL Configuration <a id="configuration-general-mysql"></a>
## Database Configuration <a id="configuration-database"></a>
Data resource where IcingaDB stores synced data and historical events.
Configuration of the database used by Icinga DB.
Option | Description
-------------------------|-----------------------------------------------
host | **Optional.** MySQL host or absolute Unix socket path. Defaults to `127.0.0.1`.
port | **Optional.** MySQL port. Defaults to `3306`.
database | **Optional.** MySQL database. Defaults to `icingadb`.
user | **Optional.** MySQL username.
password | **Optional.** MySQL password.
max\_open\_conns | **Optional.** Maximum number of open connections. Defaults to `50`.
host | **Required.** Database host or absolute Unix socket path.
port | **Required.** Database port.
database | **Required.** Database database.
user | **Required.** Database username.
password | **Required.** Database password.
### Logging Configuration <a id="configuration-general-logging"></a>
## Example Configuration <a id="configuration-example"></a>
Option | Description
-------------------------|-----------------------------------------------
level | **Optional.** Specifies the logging level. Can be set to `error`, `warn`, `info` or `debug`. See the [logrus spec](https://github.com/sirupsen/logrus#level-logging).
### Prometheus Metrics Configuration <a id="configuration-general-metrics"></a>
Option | Description
-------------------------|-----------------------------------------------
host | **Optional.** Prometheus metrics endpoint host.
port | **Optional.** Prometheus metrics endpoint port.
```yaml
database:
host: icingadb
port: 3306
database: icingadb
user: icingadb
password: icingadb
redis:
address: redis:6380
```