commit 068a5dea6760b6d9aac44f7843eba3c60257bc3e · pyrox.dev/nixpkgs

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

···

       56
       56
        
               "blackbox"

     

       57
       57
        
               "borgmatic"

     

       58
       58
        
               "buildkite-agent"

     

       59
       59
       +
               "ecoflow"

     

       59
       60
        
               "chrony"

     

       60
       61
        
               "collectd"

     

       61
       62
        
               "deluge"

+151

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

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.prometheus.exporters.ecoflow;

     

       9
       9
       +
         inherit (lib) mkOption types;

     

       10
       10
       +
       in

     

       11
       11
       +
       {

     

       12
       12
       +
         port = 2112;

     

       13
       13
       +
         extraOpts = {

     

       14
       14
       +
           exporterType = mkOption {

     

       15
       15
       +
             type = types.enum [

     

       16
       16
       +
               "rest"

     

       17
       17
       +
               "mqtt"

     

       18
       18
       +
             ];

     

       19
       19
       +
             default = "rest";

     

       20
       20
       +
             example = "mqtt";

     

       21
       21
       +
             description = ''

     

       22
       22
       +
               The type of exporter you'd like to use.

     

       23
       23
       +
               Possible values: "rest" and "mqtt". Default value is "rest".

     

       24
       24
       +
               Choose "rest" for the ecoflow online cloud api use "rest" and define: accessKey, secretKey.

     

       25
       25
       +
               Choose "mqtt" for the lan realtime integration use "mqtt" and define: email, password, devices.

     

       26
       26
       +
             '';

     

       27
       27
       +
           };

     

       28
       28
       +
           ecoflowAccessKeyFile = mkOption {

     

       29
       29
       +
             type = types.path;

     

       30
       30
       +
             default = /etc/ecoflow-access-key;

     

       31
       31
       +
             description = ''

     

       32
       32
       +
               Path to the file with your personal api access string from the Ecoflow development website https://developer-eu.ecoflow.com.

     

       33
       33
       +
               Do to share or commit your plaintext scecrets to a public repo use: agenix or soaps.

     

       34
       34
       +
             '';

     

       35
       35
       +
           };

     

       36
       36
       +
           ecoflowSecretKeyFile = mkOption {

     

       37
       37
       +
             type = types.path;

     

       38
       38
       +
             default = /etc/ecoflow-secret-key;

     

       39
       39
       +
             description = ''

     

       40
       40
       +
               Path to the file with your personal api secret string from the Ecoflow development website https://developer-eu.ecoflow.com.

     

       41
       41
       +
               Do to share or commit your plaintext scecrets to a public repo use: agenix or soaps.

     

       42
       42
       +
             '';

     

       43
       43
       +
           };

     

       44
       44
       +
           ecoflowEmailFile = mkOption {

     

       45
       45
       +
             type = types.path;

     

       46
       46
       +
             default = /etc/ecoflow-email;

     

       47
       47
       +
             description = ''

     

       48
       48
       +
               Path to the file with your personal ecoflow app login email address.

     

       49
       49
       +
               Do to share or commit your plaintext scecrets to a public repo use: agenix or soaps.

     

       50
       50
       +
             '';

     

       51
       51
       +
           };

     

       52
       52
       +
           ecoflowPasswordFile = mkOption {

     

       53
       53
       +
             type = types.path;

     

       54
       54
       +
             default = /etc/ecoflow-password;

     

       55
       55
       +
             description = ''

     

       56
       56
       +
               Path to the file with your personal ecoflow app login email password.

     

       57
       57
       +
               Do to share or commit your plaintext passwords to a public repo use: agenix or soaps here!

     

       58
       58
       +
             '';

     

       59
       59
       +
           };

     

       60
       60
       +
           ecoflowDevicesFile = mkOption {

     

       61
       61
       +
             type = types.path;

     

       62
       62
       +
             default = /etc/ecoflow-devices;

     

       63
       63
       +
             description = ''

     

       64
       64
       +
               File must contain one line, example: R3300000,R3400000,NC430000,....

     

       65
       65
       +
               The list of devices serial numbers separated by comma. For instance: SN1,SN2,SN3.

     

       66
       66
       +
               Instead of "devicesFile" you can specify "devicesPrettynamesFile" which will also work. You can specify both.

     

       67
       67
       +
               Do to share or commit your plaintext serial numbers to a public repo use: agenix or soaps.

     

       68
       68
       +
             '';

     

       69
       69
       +
           };

     

       70
       70
       +
           ecoflowDevicesPrettyNamesFile = mkOption {

     

       71
       71
       +
             type = types.path;

     

       72
       72
       +
             default = /etc/ecoflow-devices-pretty-names;

     

       73
       73
       +
             description = ''

     

       74
       74
       +
               File must contain one line, example: {"R3300000":"Delta 2","R3400000":"Delta Pro",...}

     

       75
       75
       +
               The key/value map of custom names for your devices. Key is a serial number, value is a device name you want

     

       76
       76
       +
               to see in Grafana Dashboard. It's helpful to see a meaningful name in Grafana dashboard instead of a serialnumber.

     

       77
       77
       +
               Do to share or commit your plaintext serial numbers to a public repo use: agenix or soaps.

     

       78
       78
       +
             '';

     

       79
       79
       +
           };

     

       80
       80
       +
           debug = mkOption {

     

       81
       81
       +
             type = types.str;

     

       82
       82
       +
             default = "0";

     

       83
       83
       +
             example = "1";

     

       84
       84
       +
             description = ''

     

       85
       85
       +
               Enable debug log messages. Disabled by default. Set to "1" to enable.

     

       86
       86
       +
             '';

     

       87
       87
       +
           };

     

       88
       88
       +
           prefix = mkOption {

     

       89
       89
       +
             type = types.str;

     

       90
       90
       +
             default = "ecoflow";

     

       91
       91
       +
             example = "ecoflow_privateSite";

     

       92
       92
       +
             description = ''

     

       93
       93
       +
               The prefix that will be added to all metrics. Default value is ecoflow.

     

       94
       94
       +
               For instance metric bms_bmsStatus.minCellTemp will be exported to prometheus as ecoflow.bms_bmsStatus.minCellTemp.

     

       95
       95
       +
               With default value "ecoflow" you can use Grafana Dashboard with ID 17812 without any changes.

     

       96
       96
       +
             '';

     

       97
       97
       +
           };

     

       98
       98
       +
           scrapingInterval = mkOption {

     

       99
       99
       +
             type = types.ints.positive;

     

       100
       100
       +
             default = 30;

     

       101
       101
       +
             example = 120;

     

       102
       102
       +
             description = ''

     

       103
       103
       +
               Scrapping interval in seconds. How often should the exporter execute requests to Ecoflow Rest API in order to get the data.

     

       104
       104
       +
               Default value is 30 seconds. Align this value with your prometheus scraper interval settings.

     

       105
       105
       +
             '';

     

       106
       106
       +
           };

     

       107
       107
       +
           mqttDeviceOfflineThreshold = mkOption {

     

       108
       108
       +
             type = types.ints.positive;

     

       109
       109
       +
             default = 60;

     

       110
       110
       +
             example = 120;

     

       111
       111
       +
             description = ''

     

       112
       112
       +
               The threshold in seconds which indicates how long we should wait for a metric message from MQTT broker.

     

       113
       113
       +
               Default value: 60 seconds. If we don't receive message within 60 seconds we consider that device is offline.

     

       114
       114
       +
               If we don't receive messages within the threshold for all devices, we'll try to reconnect to the MQTT broker.

     

       115
       115
       +
               There is a strange behavior that MQTT stop sends messages if you open Ecoflow mobile app and then close it).

     

       116
       116
       +
             '';

     

       117
       117
       +
           };

     

       118
       118
       +
         };

     

       119
       119
       +
         serviceOpts = {

     

       120
       120
       +
           environment = {

     

       121
       121
       +
             PROMETHEUS_ENABLED = "1";

     

       122
       122
       +
             EXPORTER_TYPE = cfg.exporterType;

     

       123
       123
       +
             DEBUG_ENABLED = cfg.debug;

     

       124
       124
       +
             METRIC_PREFIX = cfg.prefix;

     

       125
       125
       +
             SCRAPING_INTERVAL = toString cfg.scrapingInterval;

     

       126
       126
       +
             MQTT_DEVICE_OFFLINE_THRESHOLD_SECONDS = toString cfg.mqttDeviceOfflineThreshold;

     

       127
       127
       +
           };

     

       128
       128
       +
           script = ''

     

       129
       129
       +
             export ECOFLOW_ACCESS_KEY="$(cat ${toString cfg.ecoflowAccessKeyFile})"

     

       130
       130
       +
             export ECOFLOW_SECRET_KEY="$(cat ${toString cfg.ecoflowSecretKeyFile})"

     

       131
       131
       +
             export ECOFLOW_EMAIL="$(cat ${toString cfg.ecoflowEmailFile})"

     

       132
       132
       +
             export ECOFLOW_PASSWORD="$(cat ${toString cfg.ecoflowPasswordFile})"

     

       133
       133
       +
             export ECOFLOW_DEVICES="$(cat ${toString cfg.ecoflowDevicesFile})"

     

       134
       134
       +
             export ECOFLOW_DEVICES_PRETTY_NAMES="$(cat ${toString cfg.ecoflowDevicesPrettyNamesFile})"

     

       135
       135
       +
             exec ${lib.getExe pkgs.go-ecoflow-exporter}'';

     

       136
       136
       +
           serviceConfig = {

     

       137
       137
       +
             AmbientCapabilities = [ "CAP_NET_BIND_SERVICE" ];

     

       138
       138
       +
             CapabilityBoundingSet = [ "CAP_NET_BIND_SERVICE" ];

     

       139
       139
       +
             MemoryDenyWriteExecute = true;

     

       140
       140
       +
             NoNewPrivileges = true;

     

       141
       141
       +
             ProtectSystem = "strict";

     

       142
       142
       +
             Restart = "on-failure";

     

       143
       143
       +
             RestrictAddressFamilies = [

     

       144
       144
       +
               "AF_INET"

     

       145
       145
       +
               "AF_INET6"

     

       146
       146
       +
             ];

     

       147
       147
       +
             RestrictNamespaces = true;

     

       148
       148
       +
             User = "prometheus"; # context needed to runtime access encrypted token and secrets

     

       149
       149
       +
           };

     

       150
       150
       +
         };

     

       151
       151
       +
       }