commit 59e5aabee6b36b998c7ac47778dbe6c4bf245ed9 · pyrox.dev/nixpkgs

+112
nixos/modules/services/logging/journaldriver.nix
···

       1
       1
       +
       # This module implements a systemd service for running journaldriver,

     

       2
       2
       +
       # a log forwarding agent that sends logs from journald to Stackdriver

     

       3
       3
       +
       # Logging.

     

       4
       4
       +
       #

     

       5
       5
       +
       # It can be enabled without extra configuration when running on GCP.

     

       6
       6
       +
       # On machines hosted elsewhere, the other configuration options need

     

       7
       7
       +
       # to be set.

     

       8
       8
       +
       #

     

       9
       9
       +
       # For further information please consult the documentation in the

     

       10
       10
       +
       # upstream repository at: https://github.com/aprilabank/journaldriver/

     

       11
       11
       +
       

     

       12
       12
       +
       { config, lib, pkgs, ...}:

     

       13
       13
       +
       

     

       14
       14
       +
       with lib; let cfg = config.services.journaldriver;

     

       15
       15
       +
       in {

     

       16
       16
       +
         options.services.journaldriver = {

     

       17
       17
       +
           enable = mkOption {

     

       18
       18
       +
             type        = types.bool;

     

       19
       19
       +
             default     = false;

     

       20
       20
       +
             description = ''

     

       21
       21
       +
               Whether to enable journaldriver to forward journald logs to

     

       22
       22
       +
               Stackdriver Logging.

     

       23
       23
       +
             '';

     

       24
       24
       +
           };

     

       25
       25
       +
       

     

       26
       26
       +
           logLevel = mkOption {

     

       27
       27
       +
             type        = types.str;

     

       28
       28
       +
             default     = "info";

     

       29
       29
       +
             description = ''

     

       30
       30
       +
               Log level at which journaldriver logs its own output.

     

       31
       31
       +
             '';

     

       32
       32
       +
           };

     

       33
       33
       +
       

     

       34
       34
       +
           logName = mkOption {

     

       35
       35
       +
             type        = with types; nullOr str;

     

       36
       36
       +
             default     = null;

     

       37
       37
       +
             description = ''

     

       38
       38
       +
               Configures the name of the target log in Stackdriver Logging.

     

       39
       39
       +
               This option can be set to, for example, the hostname of a

     

       40
       40
       +
               machine to improve the user experience in the logging

     

       41
       41
       +
               overview.

     

       42
       42
       +
             '';

     

       43
       43
       +
           };

     

       44
       44
       +
       

     

       45
       45
       +
           googleCloudProject = mkOption {

     

       46
       46
       +
             type        = with types; nullOr str;

     

       47
       47
       +
             default     = null;

     

       48
       48
       +
             description = ''

     

       49
       49
       +
               Configures the name of the Google Cloud project to which to

     

       50
       50
       +
               forward journald logs.

     

       51
       51
       +
       

     

       52
       52
       +
               This option is required on non-GCP machines, but should not be

     

       53
       53
       +
               set on GCP instances.

     

       54
       54
       +
             '';

     

       55
       55
       +
           };

     

       56
       56
       +
       

     

       57
       57
       +
           logStream = mkOption {

     

       58
       58
       +
             type        = with types; nullOr str;

     

       59
       59
       +
             default     = null;

     

       60
       60
       +
             description = ''

     

       61
       61
       +
               Configures the name of the Stackdriver Logging log stream into

     

       62
       62
       +
               which to write journald entries.

     

       63
       63
       +
       

     

       64
       64
       +
               This option is required on non-GCP machines, but should not be

     

       65
       65
       +
               set on GCP instances.

     

       66
       66
       +
             '';

     

       67
       67
       +
           };

     

       68
       68
       +
       

     

       69
       69
       +
           applicationCredentials = mkOption {

     

       70
       70
       +
             type        = with types; nullOr path;

     

       71
       71
       +
             default     = null;

     

       72
       72
       +
             description = ''

     

       73
       73
       +
               Path to the service account private key (in JSON-format) used

     

       74
       74
       +
               to forward log entries to Stackdriver Logging on non-GCP

     

       75
       75
       +
               instances.

     

       76
       76
       +
       

     

       77
       77
       +
               This option is required on non-GCP machines, but should not be

     

       78
       78
       +
               set on GCP instances.

     

       79
       79
       +
             '';

     

       80
       80
       +
           };

     

       81
       81
       +
         };

     

       82
       82
       +
       

     

       83
       83
       +
         config = mkIf cfg.enable {

     

       84
       84
       +
           systemd.services.journaldriver = {

     

       85
       85
       +
             description = "Stackdriver Logging journal forwarder";

     

       86
       86
       +
             script      = "${pkgs.journaldriver}/bin/journaldriver";

     

       87
       87
       +
             after       = [ "network-online.target" ];

     

       88
       88
       +
             wantedBy    = [ "multi-user.target" ];

     

       89
       89
       +
       

     

       90
       90
       +
             serviceConfig = {

     

       91
       91
       +
               Restart        = "always";

     

       92
       92
       +
               DynamicUser    = true;

     

       93
       93
       +
       

     

       94
       94
       +
               # This directive lets systemd automatically configure

     

       95
       95
       +
               # permissions on /var/lib/journaldriver, the directory in

     

       96
       96
       +
               # which journaldriver persists its cursor state.

     

       97
       97
       +
               StateDirectory = "journaldriver";

     

       98
       98
       +
       

     

       99
       99
       +
               # This group is required for accessing journald.

     

       100
       100
       +
               SupplementaryGroups = "systemd-journal";

     

       101
       101
       +
             };

     

       102
       102
       +
       

     

       103
       103
       +
             environment = {

     

       104
       104
       +
               RUST_LOG                       = cfg.logLevel;

     

       105
       105
       +
               LOG_NAME                       = cfg.logName;

     

       106
       106
       +
               LOG_STREAM                     = cfg.logStream;

     

       107
       107
       +
               GOOGLE_CLOUD_PROJECT           = cfg.googleCloudProject;

     

       108
       108
       +
               GOOGLE_APPLICATION_CREDENTIALS = cfg.applicationCredentials;

     

       109
       109
       +
             };

     

       110
       110
       +
           };

     

       111
       111
       +
         };

     

       112
       112
       +
       }