commit 2acc732b6a1db992c83649b829319a3c467f300b · pyrox.dev/nixpkgs

nixos/modules/services/monitoring/prometheus/exporters.nix

···

       58
       58
        
           "mikrotik"

     

       59
       59
        
           "modemmanager"

     

       60
       60
        
           "mongodb"

     

       61
       61
       +
           "mqtt"

     

       61
       62
        
           "mysqld"

     

       62
       63
        
           "nats"

     

       63
       64
        
           "nextcloud"

+140

nixos/modules/services/monitoring/prometheus/exporters/mqtt.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         options,

     

       6
       6
       +
         utils,

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       let

     

       10
       10
       +
         inherit (lib)

     

       11
       11
       +
           mkIf

     

       12
       12
       +
           mkEnableOption

     

       13
       13
       +
           mkOption

     

       14
       14
       +
           types

     

       15
       15
       +
           ;

     

       16
       16
       +
         cfg = config.services.prometheus.exporters.mqtt;

     

       17
       17
       +
         toConfigBoolean = x: if x then "True" else "False";

     

       18
       18
       +
         toConfigList = builtins.concatStringsSep ",";

     

       19
       19
       +
       in

     

       20
       20
       +
       {

     

       21
       21
       +
         # https://github.com/kpetremann/mqtt-exporter/tree/master?tab=readme-ov-file#configuration

     

       22
       22
       +
         port = 9000;

     

       23
       23
       +
         extraOpts = {

     

       24
       24
       +
           keepFullTopic = mkEnableOption "Keep entire topic instead of the first two elements only. Usecase: Shelly 3EM";

     

       25
       25
       +
           logLevel = mkOption {

     

       26
       26
       +
             type = types.enum [

     

       27
       27
       +
               "CRITICAL"

     

       28
       28
       +
               "ERROR"

     

       29
       29
       +
               "WARNING"

     

       30
       30
       +
               "INFO"

     

       31
       31
       +
               "DEBUG"

     

       32
       32
       +
             ];

     

       33
       33
       +
             default = "INFO";

     

       34
       34
       +
             example = "DEBUG";

     

       35
       35
       +
             description = "Logging level";

     

       36
       36
       +
           };

     

       37
       37
       +
           logMqttMessage = mkEnableOption "Log MQTT original message, only if `LOG_LEVEL` is set to DEBUG.";

     

       38
       38
       +
           mqttIgnoredTopics = mkOption {

     

       39
       39
       +
             type = types.listOf types.str;

     

       40
       40
       +
             default = [ ];

     

       41
       41
       +
             description = "Lists of topics to ignore. Accepts wildcards.";

     

       42
       42
       +
           };

     

       43
       43
       +
           mqttAddress = mkOption {

     

       44
       44
       +
             type = types.str;

     

       45
       45
       +
             default = "127.0.0.1";

     

       46
       46
       +
             description = "IP or hostname of MQTT broker.";

     

       47
       47
       +
           };

     

       48
       48
       +
           mqttPort = mkOption {

     

       49
       49
       +
             type = types.port;

     

       50
       50
       +
             default = 1883;

     

       51
       51
       +
             description = "TCP port of MQTT broker.";

     

       52
       52
       +
           };

     

       53
       53
       +
           mqttTopic = mkOption {

     

       54
       54
       +
             type = types.str;

     

       55
       55
       +
             default = "#";

     

       56
       56
       +
             description = "Topic path to subscribe to.";

     

       57
       57
       +
           };

     

       58
       58
       +
           mqttKeepAlive = mkOption {

     

       59
       59
       +
             type = types.int;

     

       60
       60
       +
             default = 60;

     

       61
       61
       +
             example = 30;

     

       62
       62
       +
             description = "Keep alive interval to maintain connection with MQTT broker.";

     

       63
       63
       +
           };

     

       64
       64
       +
           mqttUsername = mkOption {

     

       65
       65
       +
             type = types.nullOr types.str;

     

       66
       66
       +
             default = null;

     

       67
       67
       +
             example = "mqttexporter";

     

       68
       68
       +
             description = "Username which should be used to authenticate against the MQTT broker.";

     

       69
       69
       +
           };

     

       70
       70
       +
           mqttV5Protocol = mkEnableOption "Force to use MQTT protocol v5 instead of 3.1.1.";

     

       71
       71
       +
           mqttClientId = mkOption {

     

       72
       72
       +
             type = types.nullOr types.str;

     

       73
       73
       +
             default = null;

     

       74
       74
       +
             description = "Set client ID manually for MQTT connection";

     

       75
       75
       +
           };

     

       76
       76
       +
           mqttExposeClientId = mkEnableOption "Expose the client ID as a label in Prometheus metrics.";

     

       77
       77
       +
           prometheusPrefix = mkOption {

     

       78
       78
       +
             type = types.str;

     

       79
       79
       +
             default = "mqtt_";

     

       80
       80
       +
             description = "Prefix added to the metric name.";

     

       81
       81
       +
           };

     

       82
       82
       +
           topicLabel = mkOption {

     

       83
       83
       +
             type = types.str;

     

       84
       84
       +
             default = "topic";

     

       85
       85
       +
             description = "Define the Prometheus label for the topic.";

     

       86
       86
       +
           };

     

       87
       87
       +
           zigbee2MqttAvailability = mkEnableOption "Normalize sensor name for device availability metric added by Zigbee2MQTT.";

     

       88
       88
       +
           zwaveTopicPrefix = mkOption {

     

       89
       89
       +
             type = types.str;

     

       90
       90
       +
             default = "zwave/";

     

       91
       91
       +
             description = "MQTT topic used for Zwavejs2Mqtt messages.";

     

       92
       92
       +
           };

     

       93
       93
       +
           esphomeTopicPrefixes = mkOption {

     

       94
       94
       +
             type = types.listOf types.str;

     

       95
       95
       +
             default = [ ];

     

       96
       96
       +
             description = "MQTT topic used for ESPHome messages.";

     

       97
       97
       +
           };

     

       98
       98
       +
           hubitatTopicPrefixes = mkOption {

     

       99
       99
       +
             type = types.listOf types.str;

     

       100
       100
       +
             default = [ "hubitat/" ];

     

       101
       101
       +
             description = "MQTT topic used for Hubitat messages.";

     

       102
       102
       +
           };

     

       103
       103
       +
           environmentFile = mkOption {

     

       104
       104
       +
             type = types.nullOr types.path;

     

       105
       105
       +
             default = null;

     

       106
       106
       +
             example = [ "/run/secrets/mqtt-exporter" ];

     

       107
       107
       +
             description = ''

     

       108
       108
       +
               File to load as environment file. Useful for e.g. setting `MQTT_PASSWORD`

     

       109
       109
       +
               without putting any secrets into the Nix store.

     

       110
       110
       +
             '';

     

       111
       111
       +
           };

     

       112
       112
       +
         };

     

       113
       113
       +
         serviceOpts = {

     

       114
       114
       +
           environment = {

     

       115
       115
       +
             KEEP_FULL_TOPIC = toConfigBoolean cfg.keepFullTopic;

     

       116
       116
       +
             LOG_LEVEL = cfg.logLevel;

     

       117
       117
       +
             LOG_MQTT_MESSAGE = toConfigBoolean cfg.logMqttMessage;

     

       118
       118
       +
             MQTT_IGNORED_TOPIC = toConfigList cfg.mqttIgnoredTopics;

     

       119
       119
       +
             MQTT_ADDRESS = cfg.mqttAddress;

     

       120
       120
       +
             MQTT_PORT = toString cfg.mqttPort;

     

       121
       121
       +
             MQTT_TOPIC = cfg.mqttTopic;

     

       122
       122
       +
             MQTT_KEEPALIVE = toString cfg.mqttKeepAlive;

     

       123
       123
       +
             MQTT_USERNAME = cfg.mqttUsername;

     

       124
       124
       +
             MQTT_V5_PROTOCOL = toConfigBoolean cfg.mqttV5Protocol;

     

       125
       125
       +
             MQTT_CLIENT_ID = mkIf (cfg.mqttClientId != null) cfg.mqttClientId;

     

       126
       126
       +
             PROMETHEUS_ADDRESS = cfg.listenAddress;

     

       127
       127
       +
             PROMETHEUS_PORT = toString cfg.port;

     

       128
       128
       +
             PROMETHEUS_PREFIX = cfg.prometheusPrefix;

     

       129
       129
       +
             TOPIC_LABEL = cfg.topicLabel;

     

       130
       130
       +
             ZIGBEE2MQTT_AVAILABILITY = toConfigBoolean cfg.zigbee2MqttAvailability;

     

       131
       131
       +
             ZWAVE_TOPIC_PREFIX = cfg.zwaveTopicPrefix;

     

       132
       132
       +
             ESPHOME_TOPIC_PREFIXES = toConfigList cfg.esphomeTopicPrefixes;

     

       133
       133
       +
             HUBITAT_TOPIC_PREFIXES = toConfigList cfg.hubitatTopicPrefixes;

     

       134
       134
       +
           };

     

       135
       135
       +
           serviceConfig = {

     

       136
       136
       +
             EnvironmentFile = mkIf (cfg.environmentFile != null) cfg.environmentFile;

     

       137
       137
       +
             ExecStart = lib.getExe pkgs.mqtt-exporter;

     

       138
       138
       +
           };

     

       139
       139
       +
         };

     

       140
       140
       +
       }