summary refs log tree commit diff
path: root/nixos/modules/services/monitoring/prometheus/exporters/buildkite-agent.nix
blob: e9be39608fcbe705010955c5fffc3d139bb4d157 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{ config, lib, pkgs, options }:

with lib;

let
  cfg = config.services.prometheus.exporters.buildkite-agent;
in
{
  port = 9876;
  extraOpts = {
    tokenPath = mkOption {
      type = types.nullOr types.path;
      apply = final: if final == null then null else toString final;
      description = ''
        The token from your Buildkite "Agents" page.

        A run-time path to the token file, which is supposed to be provisioned
        outside of Nix store.
      '';
    };
    interval = mkOption {
      type = types.str;
      default = "30s";
      example = "1min";
      description = ''
        How often to update metrics.
      '';
    };
    endpoint = mkOption {
      type = types.str;
      default = "https://agent.buildkite.com/v3";
      description = ''
        The Buildkite Agent API endpoint.
      '';
    };
    queues = mkOption {
      type = with types; nullOr (listOf str);
      default = null;
      example = literalExpression ''[ "my-queue1" "my-queue2" ]'';
      description = ''
        Which specific queues to process.
      '';
    };
  };
  serviceOpts = {
    script =
      let
        queues = concatStringsSep " " (map (q: "-queue ${q}") cfg.queues);
      in
      ''
        export BUILDKITE_AGENT_TOKEN="$(cat ${toString cfg.tokenPath})"
        exec ${pkgs.buildkite-agent-metrics}/bin/buildkite-agent-metrics \
          -backend prometheus \
          -interval ${cfg.interval} \
          -endpoint ${cfg.endpoint} \
          ${optionalString (cfg.queues != null) queues} \
          -prometheus-addr "${cfg.listenAddress}:${toString cfg.port}" ${concatStringsSep " " cfg.extraFlags}
      '';
    serviceConfig = {
      DynamicUser = false;
      RuntimeDirectory = "buildkite-agent-metrics";
    };
  };
}