nixos/modules/services/monitoring/goss.md

   1 # Goss {#module-services-goss}
   2
   3 [goss](https://goss.rocks/) is a YAML based serverspec alternative tool
   4 for validating a server's configuration.
   5
   6 ## Basic Usage {#module-services-goss-basic-usage}
   7
   8 A minimal configuration looks like this:
   9
  10 ```nix
  11 {
  12   services.goss = {
  13     enable = true;
  14
  15     environment = {
  16       GOSS_FMT = "json";
  17       GOSS_LOGLEVEL = "TRACE";
  18     };
  19
  20     settings = {
  21       addr."tcp://localhost:8080" = {
  22         reachable = true;
  23         local-address = "127.0.0.1";
  24       };
  25       command."check-goss-version" = {
  26         exec = "${lib.getExe pkgs.goss} --version";
  27         exit-status = 0;
  28       };
  29       dns.localhost.resolvable = true;
  30       file."/nix" = {
  31         filetype = "directory";
  32         exists = true;
  33       };
  34       group.root.exists = true;
  35       kernel-param."kernel.ostype".value = "Linux";
  36       service.goss = {
  37         enabled = true;
  38         running = true;
  39       };
  40       user.root.exists = true;
  41     };
  42   };
  43 }
  44 ```