tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-04-08 17:05:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Introduce Influxdb2Writer

Browse Source 
refs #8711
This commit is contained in:
Alexander A. Klimov 2021-04-15 14:08:50 +02:00
parent d26aa9fb34
commit 9d4b0f1268
10 changed files with 216 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/06-distributed-monitoring.md
View File

@ -3001,7 +3001,7 @@ By default, the following features provide advanced HA functionality:
* [Elasticsearch](09-object-types.md#objecttype-elasticsearchwriter)
* [Gelf](09-object-types.md#objecttype-gelfwriter)
* [Graphite](09-object-types.md#objecttype-graphitewriter)
* [InfluxDB](09-object-types.md#objecttype-influxdbwriter)
* [InfluxDB](09-object-types.md#objecttype-influxdb2writer) (v1 and v2)
* [OpenTsdb](09-object-types.md#objecttype-opentsdbwriter)
* [Perfdata](09-object-types.md#objecttype-perfdatawriter) (for PNP)

63
doc/09-object-types.md
View File

@ -1606,6 +1606,7 @@ Runtime Attributes:
Writes check result metrics and performance data to a defined InfluxDB v1 host.
This configuration object is available as [influxdb feature](14-features.md#influxdb-writer).
For InfluxDB v2 support see the [Influxdb2Writer](#objecttype-influxdb2writer) below.
Example:
@ -1669,6 +1670,68 @@ or similar.
### Influxdb2Writer <a id="objecttype-influxdb2writer"></a>
Writes check result metrics and performance data to a defined InfluxDB v2 host.
This configuration object is available as [influxdb feature](14-features.md#influxdb-writer).
For InfluxDB v1 support see the [InfluxdbWriter](#objecttype-influxdbwriter) above.
Example:
```
object Influxdb2Writer "influxdb2" {
host = "127.0.0.1"
port = 8086
organization = "monitoring"
bucket = "icinga2"
auth_token = "ABCDEvwxyz0189-_"
flush_threshold = 1024
flush_interval = 10s
host_template = {
measurement = "$host.check_command$"
tags = {
hostname = "$host.name$"
}
}
service_template = {
measurement = "$service.check_command$"
tags = {
hostname = "$host.name$"
service = "$service.name$"
}
}
}
```
Configuration Attributes:
Name | Type | Description
--------------------------|-----------------------|----------------------------------
host | String | **Required.** InfluxDB host address. Defaults to `127.0.0.1`.
port | Number | **Required.** InfluxDB HTTP port. Defaults to `8086`.
organization | String | **Required.** InfluxDB organization name.
bucket | String | **Required.** InfluxDB bucket name.
auth\_token | String | **Required.** InfluxDB authentication token.
ssl\_enable | Boolean | **Optional.** Whether to use a TLS stream. Defaults to `false`.
ssl\_ca\_cert | String | **Optional.** Path to CA certificate to validate the remote host.
ssl\_cert | String | **Optional.** Path to host certificate to present to the remote host for mutual verification.
ssl\_key | String | **Optional.** Path to host key to accompany the ssl\_cert.
host\_template | Dictionary | **Required.** Host template to define the InfluxDB line protocol.
service\_template | Dictionary | **Required.** Service template to define the influxDB line protocol.
enable\_send\_thresholds | Boolean | **Optional.** Whether to send warn, crit, min & max tagged data.
enable\_send\_metadata | Boolean | **Optional.** Whether to send check metadata e.g. states, execution time, latency etc.
flush\_interval | Duration | **Optional.** How long to buffer data points before transferring to InfluxDB. Defaults to `10s`.
flush\_threshold | Number | **Optional.** How many data points to buffer before forcing a transfer to InfluxDB. Defaults to `1024`.
enable\_ha | Boolean | **Optional.** Enable the high availability functionality. Only valid in a [cluster setup](06-distributed-monitoring.md#distributed-monitoring-high-availability-features). Defaults to `false`.
Note: If `flush_threshold` is set too low, this will always force the feature to flush all data
to InfluxDB. Experiment with the setting, if you are processing more than 1024 metrics per second
or similar.
### LiveStatusListener <a id="objecttype-livestatuslistener"></a>
Livestatus API interface available as TCP or UNIX socket. Historical table queries

7
doc/13-addons.md
View File

@ -63,6 +63,13 @@ for sending real-time metrics from Icinga 2 to InfluxDB v1.
icinga2 feature enable influxdb
```
Use the [Influxdb2Writer](14-features.md#influxdb-writer) feature
for sending real-time metrics from Icinga 2 to InfluxDB v2.
```bash
icinga2 feature enable influxdb2
```
A popular frontend for InfluxDB is for example [Grafana](https://grafana.org).
Integration in Icinga Web 2 is possible by installing the community [Grafana module](https://github.com/Mikesch-mp/icingaweb2-module-grafana).

20
doc/14-features.md
View File

@ -369,7 +369,7 @@ where Carbon Cache/Relay is running as receiver.
### InfluxDB Writer <a id="influxdb-writer"></a>
Once there are new metrics available, Icinga 2 will directly write them to the
defined InfluxDB v1 HTTP API.
defined InfluxDB v1/v2 HTTP API.
You can enable the feature using
@ -377,10 +377,17 @@ You can enable the feature using
icinga2 feature enable influxdb
```
By default the [InfluxdbWriter](09-object-types.md#objecttype-influxdbwriter) feature
expects the InfluxDB daemon to listen at `127.0.0.1` on port `8086`.
or
Measurement names and tags are fully configurable by the end user. The InfluxdbWriter
```bash
icinga2 feature enable influxdb2
```
By default the
[InfluxdbWriter](09-object-types.md#objecttype-influxdbwriter)/[Influxdb2Writer](09-object-types.md#objecttype-influxdb2writer)
features expect the InfluxDB daemon to listen at `127.0.0.1` on port `8086`.
Measurement names and tags are fully configurable by the end user. The Influxdb(2)Writer
object will automatically add a `metric` tag to each data point. This correlates to the
perfdata label. Fields (value, warn, crit, min, max, unit) are created from data if available
and the configuration allows it. If a value associated with a tag is not able to be
@ -391,12 +398,13 @@ escape characters when followed by a space or comma, but cannot be escaped thems
As a result all trailling slashes in these fields are replaced with an underscore. This
predominantly affects Windows paths e.g. `C:\` becomes `C:_`.
The database is assumed to exist so this object will make no attempt to create it currently.
The database/bucket is assumed to exist so this object will make no attempt to create it currently.
If [SELinux](22-selinux.md#selinux) is enabled, it will not allow access for Icinga 2 to InfluxDB until the [boolean](22-selinux.md#selinux-policy-booleans)
`icinga2_can_connect_all` is set to true as InfluxDB is not providing its own policy.
More configuration details can be found [here](09-object-types.md#objecttype-influxdbwriter).
More configuration details can be found [here for v1](09-object-types.md#objecttype-influxdbwriter)
and [here for v2](09-object-types.md#objecttype-influxdb2writer).
#### Instance Tagging <a id="influxdb-writer-instance-tags"></a>

27
etc/icinga2/features-available/influxdb2.conf Normal file
View File

@ -0,0 +1,27 @@
/**
* The Influxdb2Writer type writes check result metrics and
* performance data to an InfluxDB v2 HTTP API
*/
object Influxdb2Writer "influxdb2" {
//host = "127.0.0.1"
//port = 8086
//organization = "monitoring"
//bucket = "icinga2"
//auth_token = "ABCDEvwxyz0189-_"
//flush_threshold = 1024
//flush_interval = 10s
//host_template = {
// measurement = "$host.check_command$"
// tags = {
// hostname = "$host.name$"
// }
//}
//service_template = {
// measurement = "$service.check_command$"
// tags = {
// hostname = "$host.name$"
// service = "$service.name$"
// }
//}
}

7
lib/perfdata/CMakeLists.txt
View File

@ -4,6 +4,7 @@ mkclass_target(gelfwriter.ti gelfwriter-ti.cpp gelfwriter-ti.hpp)
mkclass_target(graphitewriter.ti graphitewriter-ti.cpp graphitewriter-ti.hpp)
mkclass_target(influxdbcommonwriter.ti influxdbcommonwriter-ti.cpp influxdbcommonwriter-ti.hpp)
mkclass_target(influxdbwriter.ti influxdbwriter-ti.cpp influxdbwriter-ti.hpp)
mkclass_target(influxdb2writer.ti influxdb2writer-ti.cpp influxdb2writer-ti.hpp)
mkclass_target(elasticsearchwriter.ti elasticsearchwriter-ti.cpp elasticsearchwriter-ti.hpp)
mkclass_target(opentsdbwriter.ti opentsdbwriter-ti.cpp opentsdbwriter-ti.hpp)
mkclass_target(perfdatawriter.ti perfdatawriter-ti.cpp perfdatawriter-ti.hpp)
@ -14,6 +15,7 @@ set(perfdata_SOURCES
graphitewriter.cpp graphitewriter.hpp graphitewriter-ti.hpp
influxdbcommonwriter.cpp influxdbcommonwriter.hpp influxdbcommonwriter-ti.hpp
influxdbwriter.cpp influxdbwriter.hpp influxdbwriter-ti.hpp
influxdb2writer.cpp influxdb2writer.hpp influxdb2writer-ti.hpp
opentsdbwriter.cpp opentsdbwriter.hpp opentsdbwriter-ti.hpp
perfdatawriter.cpp perfdatawriter.hpp perfdatawriter-ti.hpp
)
@ -46,6 +48,11 @@ install_if_not_exists(
${ICINGA2_CONFIGDIR}/features-available
)
install_if_not_exists(
${PROJECT_SOURCE_DIR}/etc/icinga2/features-available/influxdb2.conf
${ICINGA2_CONFIGDIR}/features-available
)
install_if_not_exists(
${PROJECT_SOURCE_DIR}/etc/icinga2/features-available/elasticsearch.conf
${ICINGA2_CONFIGDIR}/features-available

44
lib/perfdata/influxdb2writer.cpp Normal file
View File

@ -0,0 +1,44 @@
/* Icinga 2 | (c) 2021 Icinga GmbH | GPLv2+ */
#include "perfdata/influxdb2writer.hpp"
#include "perfdata/influxdb2writer-ti.cpp"
#include "remote/url.hpp"
#include "base/configtype.hpp"
#include "base/perfdatavalue.hpp"
#include "base/statsfunction.hpp"
#include <utility>
#include <boost/beast/http/message.hpp>
#include <boost/beast/http/string_body.hpp>
using namespace icinga;
REGISTER_TYPE(Influxdb2Writer);
REGISTER_STATSFUNCTION(Influxdb2Writer, &Influxdb2Writer::StatsFunc);
void Influxdb2Writer::StatsFunc(const Dictionary::Ptr& status, const Array::Ptr& perfdata)
{
InfluxdbCommonWriter::StatsFunc<Influxdb2Writer>(status, perfdata);
}
boost::beast::http::request<boost::beast::http::string_body> Influxdb2Writer::AssembleRequest(String body)
{
auto request (AssembleBaseRequest(std::move(body)));
request.set(boost::beast::http::field::authorization, "Token " + GetAuthToken());
return std::move(request);
}
Url::Ptr Influxdb2Writer::AssembleUrl()
{
auto url (AssembleBaseUrl());
std::vector<String> path ({"api", "v2", "write"});
url->SetPath(path);
url->AddQueryElement("org", GetOrganization());
url->AddQueryElement("bucket", GetBucket());
return std::move(url);
}

33
lib/perfdata/influxdb2writer.hpp Normal file
View File

@ -0,0 +1,33 @@
/* Icinga 2 | (c) 2021 Icinga GmbH | GPLv2+ */
#ifndef INFLUXDB2WRITER_H
#define INFLUXDB2WRITER_H
#include "perfdata/influxdb2writer-ti.hpp"
#include <boost/beast/http/message.hpp>
#include <boost/beast/http/string_body.hpp>
namespace icinga
{
/**
* An Icinga InfluxDB v2 writer.
*
* @ingroup perfdata
*/
class Influxdb2Writer final : public ObjectImpl<Influxdb2Writer>
{
public:
DECLARE_OBJECT(Influxdb2Writer);
DECLARE_OBJECTNAME(Influxdb2Writer);
static void StatsFunc(const Dictionary::Ptr& status, const Array::Ptr& perfdata);
protected:
boost::beast::http::request<boost::beast::http::string_body> AssembleRequest(String body) override;
Url::Ptr AssembleUrl() override;
};
}
#endif /* INFLUXDB2WRITER_H */

19
lib/perfdata/influxdb2writer.ti Normal file
View File

@ -0,0 +1,19 @@
/* Icinga 2 | (c) 2021 Icinga GmbH | GPLv2+ */
#include "perfdata/influxdbcommonwriter.hpp"
library perfdata;
namespace icinga
{
class Influxdb2Writer : InfluxdbCommonWriter
{
activation_priority 100;
[config, required] String organization;
[config, required] String bucket;
[config, required, no_user_view] String auth_token;
};
}

2
tools/syntax/vim/syntax/icinga2.vim
View File

@ -57,7 +57,7 @@ syn keyword icinga2ObjType Comment Dependency Downtime ElasticsearchWriter
syn keyword icinga2ObjType Endpoint EventCommand ExternalCommandListener
syn keyword icinga2ObjType FileLogger GelfWriter GraphiteWriter Host HostGroup
syn keyword icinga2ObjType IcingaApplication IdoMysqlConnection IdoPgsqlConnection
syn keyword icinga2ObjType InfluxdbWriter LivestatusListener Notification NotificationCommand
syn keyword icinga2ObjType InfluxdbWriter Influxdb2Writer LivestatusListener Notification NotificationCommand
syn keyword icinga2ObjType NotificationComponent OpenTsdbWriter PerfdataWriter
syn keyword icinga2ObjType ScheduledDowntime Service ServiceGroup SyslogLogger
syn keyword icinga2ObjType TimePeriod User UserGroup WindowsEventLogLogger Zone