···

       
1
       
1
       
 
       
{ config, lib, pkgs, ... }:

     

       
2
       
2
       
 
       


     

       
3
       
3
       
-
       
with lib;

     

       
3
       
3
       
+
       
let

     

       
4
       
4
       
+
       
  inherit (lib)

     

       
5
       
5
       
+
       
    collect

     

       
6
       
6
       
+
       
    concatLists

     

       
7
       
7
       
+
       
    concatStringsSep

     

       
8
       
8
       
+
       
    flip

     

       
9
       
9
       
+
       
    getAttrFromPath

     

       
10
       
10
       
+
       
    hasPrefix

     

       
11
       
11
       
+
       
    isList

     

       
12
       
12
       
+
       
    length

     

       
13
       
13
       
+
       
    literalExpression

     

       
14
       
14
       
+
       
    literalMD

     

       
15
       
15
       
+
       
    mapAttrsRecursiveCond

     

       
16
       
16
       
+
       
    mapAttrsToList

     

       
17
       
17
       
+
       
    mdDoc

     

       
18
       
18
       
+
       
    mkEnableOption

     

       
19
       
19
       
+
       
    mkIf

     

       
20
       
20
       
+
       
    mkMerge

     

       
21
       
21
       
+
       
    mkOption

     

       
22
       
22
       
+
       
    mkPackageOptionMD

     

       
23
       
23
       
+
       
    optional

     

       
24
       
24
       
+
       
    optionalAttrs

     

       
25
       
25
       
+
       
    optionalString

     

       
26
       
26
       
+
       
    types

     

       
27
       
27
       
+
       
    ;

     

       
4
       
28
       
 
       


     

       
5
       
5
       
-
       
let

     

       
6
       
29
       
 
       
  cfg = config.services.thanos;

     

       
7
       
30
       
 
       


     

       
8
       
31
       
 
       
  nullOpt = type: description: mkOption {

     

       
9
       
32
       
 
       
    type = types.nullOr type;

     

       
10
       
33
       
 
       
    default = null;

     

       
11
       
11
       
-
       
    description = lib.mdDoc description;

     

       
34
       
34
       
+
       
    description = mdDoc description;

     

       
12
       
35
       
 
       
  };

     

       
13
       
36
       
 
       


     

       
14
       
37
       
 
       
  optionToArgs = opt: v  : optional (v != null)  ''--${opt}="${toString v}"'';

     
···

       
32
       
55
       
 
       
    option = mkOption {

     

       
33
       
56
       
 
       
      type = types.bool;

     

       
34
       
57
       
 
       
      default = false;

     

       
35
       
35
       
-
       
      description = lib.mdDoc description;

     

       
58
       
58
       
+
       
      description = mdDoc description;

     

       
36
       
59
       
 
       
    };

     

       
37
       
60
       
 
       
  };

     

       
38
       
61
       
 
       


     
···

       
41
       
64
       
 
       
    option = mkOption {

     

       
42
       
65
       
 
       
      type = types.listOf types.str;

     

       
43
       
66
       
 
       
      default = [];

     

       
44
       
44
       
-
       
      description = lib.mdDoc description;

     

       
67
       
67
       
+
       
      description = mdDoc description;

     

       
45
       
68
       
 
       
    };

     

       
46
       
69
       
 
       
  };

     

       
47
       
70
       
 
       


     
···

       
50
       
73
       
 
       
    option = mkOption {

     

       
51
       
74
       
 
       
      type = types.attrsOf types.str;

     

       
52
       
75
       
 
       
      default = {};

     

       
53
       
53
       
-
       
      description = lib.mdDoc description;

     

       
76
       
76
       
+
       
      description = mdDoc description;

     

       
54
       
77
       
 
       
    };

     

       
55
       
78
       
 
       
  };

     

       
56
       
79
       
 
       


     
···

       
59
       
82
       
 
       
    option = mkOption {

     

       
60
       
83
       
 
       
      type = types.str;

     

       
61
       
84
       
 
       
      inherit default;

     

       
62
       
62
       
-
       
      description = lib.mdDoc description;

     

       
85
       
85
       
+
       
      description = mdDoc description;

     

       
63
       
86
       
 
       
    };

     

       
64
       
87
       
 
       
  };

     

       
65
       
88
       
 
       


     
···

       
86
       
109
       
 
       
    defaultText = literalMD ''

     

       
87
       
110
       
 
       
      calculated from `config.services.thanos.${cmd}`

     

       
88
       
111
       
 
       
    '';

     

       
89
       
89
       
-
       
    description = lib.mdDoc ''

     

       
112
       
112
       
+
       
    description = mdDoc ''

     

       
90
       
113
       
 
       
      Arguments to the `thanos ${cmd}` command.

     

       
91
       
114
       
 
       


     

       
92
       
115
       
 
       
      Defaults to a list of arguments formed by converting the structured

     
···

       
127
       
150
       
 
       
            if config.services.thanos.<cmd>.tracing.config == null then null

     

       
128
       
151
       
 
       
            else toString (toYAML "tracing.yaml" config.services.thanos.<cmd>.tracing.config);

     

       
129
       
152
       
 
       
          '';

     

       
130
       
130
       
-
       
          description = lib.mdDoc ''

     

       
153
       
153
       
+
       
          description = mdDoc ''

     

       
131
       
154
       
 
       
            Path to YAML file that contains tracing configuration.

     

       
132
       
155
       
 
       


     

       
133
       
156
       
 
       
            See format details: <https://thanos.io/tip/thanos/tracing.md/#configuration>

     
···

       
192
       
215
       
 
       
            if config.services.thanos.<cmd>.objstore.config == null then null

     

       
193
       
216
       
 
       
            else toString (toYAML "objstore.yaml" config.services.thanos.<cmd>.objstore.config);

     

       
194
       
217
       
 
       
          '';

     

       
195
       
195
       
-
       
          description = lib.mdDoc ''

     

       
218
       
218
       
+
       
          description = mdDoc ''

     

       
196
       
219
       
 
       
            Path to YAML file that contains object store configuration.

     

       
197
       
220
       
 
       


     

       
198
       
221
       
 
       
            See format details: <https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage>

     
···

       
231
       
254
       
 
       
          type = types.str;

     

       
232
       
255
       
 
       
          default = "/var/lib/${config.services.prometheus.stateDir}/data";

     

       
233
       
256
       
 
       
          defaultText = literalExpression ''"/var/lib/''${config.services.prometheus.stateDir}/data"'';

     

       
234
       
234
       
-
       
          description = lib.mdDoc ''

     

       
257
       
257
       
+
       
          description = mdDoc ''

     

       
235
       
258
       
 
       
            Data directory of TSDB.

     

       
236
       
259
       
 
       
          '';

     

       
237
       
260
       
 
       
        };

     
···

       
659
       
682
       
 
       


     

       
660
       
683
       
 
       
  options.services.thanos = {

     

       
661
       
684
       
 
       


     

       
662
       
662
       
-
       
    package = lib.mkPackageOptionMD pkgs "thanos" {};

     

       
685
       
685
       
+
       
    package = mkPackageOptionMD pkgs "thanos" {};

     

       
663
       
686
       
 
       


     

       
664
       
687
       
 
       
    sidecar = paramsToOptions params.sidecar // {

     

       
665
       
688
       
 
       
      enable = mkEnableOption

     

       
666
       
666
       
-
       
        (lib.mdDoc "the Thanos sidecar for Prometheus server");

     

       
689
       
689
       
+
       
        (mdDoc "the Thanos sidecar for Prometheus server");

     

       
667
       
690
       
 
       
      arguments = mkArgumentsOption "sidecar";

     

       
668
       
691
       
 
       
    };

     

       
669
       
692
       
 
       


     

       
670
       
693
       
 
       
    store = paramsToOptions params.store // {

     

       
671
       
694
       
 
       
      enable = mkEnableOption

     

       
672
       
672
       
-
       
        (lib.mdDoc "the Thanos store node giving access to blocks in a bucket provider.");

     

       
695
       
695
       
+
       
        (mdDoc "the Thanos store node giving access to blocks in a bucket provider.");

     

       
673
       
696
       
 
       
      arguments = mkArgumentsOption "store";

     

       
674
       
697
       
 
       
    };

     

       
675
       
698
       
 
       


     

       
676
       
699
       
 
       
    query = paramsToOptions params.query // {

     

       
677
       
700
       
 
       
      enable = mkEnableOption

     

       
678
       
678
       
-
       
        (lib.mdDoc ("the Thanos query node exposing PromQL enabled Query API " +

     

       
701
       
701
       
+
       
        (mdDoc ("the Thanos query node exposing PromQL enabled Query API " +

     

       
679
       
702
       
 
       
         "with data retrieved from multiple store nodes"));

     

       
680
       
703
       
 
       
      arguments = mkArgumentsOption "query";

     

       
681
       
704
       
 
       
    };

     

       
682
       
705
       
 
       


     

       
683
       
706
       
 
       
    query-frontend = paramsToOptions params.query-frontend // {

     

       
684
       
707
       
 
       
      enable = mkEnableOption

     

       
685
       
685
       
-
       
        (lib.mdDoc ("the Thanos query frontend implements a service deployed in front of queriers to

     

       
708
       
708
       
+
       
        (mdDoc ("the Thanos query frontend implements a service deployed in front of queriers to

     

       
686
       
709
       
 
       
          improve query parallelization and caching."));

     

       
687
       
710
       
 
       
      arguments = mkArgumentsOption "query-frontend";

     

       
688
       
711
       
 
       
    };

     

       
689
       
712
       
 
       


     

       
690
       
713
       
 
       
    rule = paramsToOptions params.rule // {

     

       
691
       
714
       
 
       
      enable = mkEnableOption

     

       
692
       
692
       
-
       
        (lib.mdDoc ("the Thanos ruler service which evaluates Prometheus rules against" +

     

       
715
       
715
       
+
       
        (mdDoc ("the Thanos ruler service which evaluates Prometheus rules against" +

     

       
693
       
716
       
 
       
        " given Query nodes, exposing Store API and storing old blocks in bucket"));

     

       
694
       
717
       
 
       
      arguments = mkArgumentsOption "rule";

     

       
695
       
718
       
 
       
    };

     

       
696
       
719
       
 
       


     

       
697
       
720
       
 
       
    compact = paramsToOptions params.compact // {

     

       
698
       
721
       
 
       
      enable = mkEnableOption

     

       
699
       
699
       
-
       
        (lib.mdDoc "the Thanos compactor which continuously compacts blocks in an object store bucket");

     

       
722
       
722
       
+
       
        (mdDoc "the Thanos compactor which continuously compacts blocks in an object store bucket");

     

       
700
       
723
       
 
       
      arguments = mkArgumentsOption "compact";

     

       
701
       
724
       
 
       
    };

     

       
702
       
725
       
 
       


     

       
703
       
726
       
 
       
    downsample = paramsToOptions params.downsample // {

     

       
704
       
727
       
 
       
      enable = mkEnableOption

     

       
705
       
705
       
-
       
        (lib.mdDoc "the Thanos downsampler which continuously downsamples blocks in an object store bucket");

     

       
728
       
728
       
+
       
        (mdDoc "the Thanos downsampler which continuously downsamples blocks in an object store bucket");

     

       
706
       
729
       
 
       
      arguments = mkArgumentsOption "downsample";

     

       
707
       
730
       
 
       
    };

     

       
708
       
731
       
 
       


     

       
709
       
732
       
 
       
    receive = paramsToOptions params.receive // {

     

       
710
       
733
       
 
       
      enable = mkEnableOption

     

       
711
       
711
       
-
       
        (lib.mdDoc ("the Thanos receiver which accept Prometheus remote write API requests and write to local tsdb"));

     

       
734
       
734
       
+
       
        (mdDoc ("the Thanos receiver which accept Prometheus remote write API requests and write to local tsdb"));

     

       
712
       
735
       
 
       
      arguments = mkArgumentsOption "receive";

     

       
713
       
736
       
 
       
    };

     

       
714
       
737
       
 
       
  };