commit c8021779cd365b58838ed456a37d9a0858ba6f80 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       14
       14
        
       

     

       15
       15
        
       - [Kimai](https://www.kimai.org/), a web-based multi-user time-tracking application. Available as [services.kimai](option.html#opt-services.kimai).

     

       16
       16
        
       

     

       17
       17
       +
       - [Amazon CloudWatch Agent](https://github.com/aws/amazon-cloudwatch-agent), the official telemetry collector for AWS CloudWatch and AWS X-Ray. Available as [services.amazon-cloudwatch-agent](#opt-services.amazon-cloudwatch-agent.enable).

     

       18
       18
       +
       

     

       17
       19
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

     

       18
       20
        
       

     

       19
       21
        
       ## Backward Incompatibilities {#sec-release-25.05-incompatibilities}

nixos/modules/module-list.nix

···

       880
       880
        
         ./services/misc/zookeeper.nix

     

       881
       881
        
         ./services/monitoring/alerta.nix

     

       882
       882
        
         ./services/monitoring/alloy.nix

     

       883
       883
       +
         ./services/monitoring/amazon-cloudwatch-agent.nix

     

       883
       884
        
         ./services/monitoring/apcupsd.nix

     

       884
       885
        
         ./services/monitoring/arbtt.nix

     

       885
       886
        
         ./services/monitoring/below.nix

+179

nixos/modules/services/monitoring/amazon-cloudwatch-agent.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         config,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.amazon-cloudwatch-agent;

     

       9
       9
       +
       

     

       10
       10
       +
         tomlFormat = pkgs.formats.toml { };

     

       11
       11
       +
         jsonFormat = pkgs.formats.json { };

     

       12
       12
       +
       

     

       13
       13
       +
         commonConfigurationFile = tomlFormat.generate "common-config.toml" cfg.commonConfiguration;

     

       14
       14
       +
         configurationFile = jsonFormat.generate "amazon-cloudwatch-agent.json" cfg.configuration;

     

       15
       15
       +
         # See https://docs.aws.amazon.com/prescriptive-guidance/latest/implementing-logging-monitoring-cloudwatch/create-store-cloudwatch-configurations.html#store-cloudwatch-configuration-s3.

     

       16
       16
       +
         #

     

       17
       17
       +
         # We don't use the multiple JSON configuration files feature,

     

       18
       18
       +
         # but "config-translator" will log a benign error if the "-input-dir" option is omitted or is a non-existent directory.

     

       19
       19
       +
         #

     

       20
       20
       +
         # Create an empty directory to hide this benign error log. This prevents false-positives if users filter for "error" in the agent logs.

     

       21
       21
       +
         configurationDirectory = pkgs.runCommand "amazon-cloudwatch-agent.d" { } "mkdir $out";

     

       22
       22
       +
       in

     

       23
       23
       +
       {

     

       24
       24
       +
         options.services.amazon-cloudwatch-agent = {

     

       25
       25
       +
           enable = lib.mkEnableOption "Amazon CloudWatch Agent";

     

       26
       26
       +
           package = lib.mkPackageOption pkgs "amazon-cloudwatch-agent" { };

     

       27
       27
       +
           commonConfiguration = lib.mkOption {

     

       28
       28
       +
             type = tomlFormat.type;

     

       29
       29
       +
             default = { };

     

       30
       30
       +
             description = ''

     

       31
       31
       +
               Amazon CloudWatch Agent common configuration. See

     

       32
       32
       +
               <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/install-CloudWatch-Agent-commandline-fleet.html#CloudWatch-Agent-profile-instance-first>

     

       33
       33
       +
               for supported values.

     

       34
       34
       +
             '';

     

       35
       35
       +
             example = {

     

       36
       36
       +
               credentials = {

     

       37
       37
       +
                 shared_credential_profile = "profile_name";

     

       38
       38
       +
                 shared_credential_file = "/path/to/credentials";

     

       39
       39
       +
               };

     

       40
       40
       +
               proxy = {

     

       41
       41
       +
                 http_proxy = "http_url";

     

       42
       42
       +
                 https_proxy = "https_url";

     

       43
       43
       +
                 no_proxy = "domain";

     

       44
       44
       +
               };

     

       45
       45
       +
             };

     

       46
       46
       +
           };

     

       47
       47
       +
           configuration = lib.mkOption {

     

       48
       48
       +
             type = jsonFormat.type;

     

       49
       49
       +
             default = { };

     

       50
       50
       +
             description = ''

     

       51
       51
       +
               Amazon CloudWatch Agent configuration. See

     

       52
       52
       +
               <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html>

     

       53
       53
       +
               for supported values.

     

       54
       54
       +
             '';

     

       55
       55
       +
             # Subset of "CloudWatch agent configuration file: Complete examples" and "CloudWatch agent configuration file: Traces section" in the description link.

     

       56
       56
       +
             #

     

       57
       57
       +
             # Log file path changed from "/opt/aws/amazon-cloudwatch-agent/logs" to "/var/log/amazon-cloudwatch-agent" to follow the FHS.

     

       58
       58
       +
             example = {

     

       59
       59
       +
               agent = {

     

       60
       60
       +
                 metrics_collection_interval = 10;

     

       61
       61
       +
                 logfile = "/var/log/amazon-cloudwatch-agent/amazon-cloudwatch-agent.log";

     

       62
       62
       +
               };

     

       63
       63
       +
               metrics = {

     

       64
       64
       +
                 namespace = "MyCustomNamespace";

     

       65
       65
       +
                 metrics_collected = {

     

       66
       66
       +
                   cpu = {

     

       67
       67
       +
                     resource = [ "*" ];

     

       68
       68
       +
                     measurement = [

     

       69
       69
       +
                       {

     

       70
       70
       +
                         name = "cpu_usage_idle";

     

       71
       71
       +
                         rename = "CPU_USAGE_IDLE";

     

       72
       72
       +
                         unit = "Percent";

     

       73
       73
       +
                       }

     

       74
       74
       +
                       {

     

       75
       75
       +
                         name = "cpu_usage_nice";

     

       76
       76
       +
                         unit = "Percent";

     

       77
       77
       +
                       }

     

       78
       78
       +
                       "cpu_usage_guest"

     

       79
       79
       +
                     ];

     

       80
       80
       +
                     totalcpu = false;

     

       81
       81
       +
                     metrics_collection_interval = 10;

     

       82
       82
       +
                     append_dimensions = {

     

       83
       83
       +
                       customized_dimension_key_1 = "customized_dimension_value_1";

     

       84
       84
       +
                       customized_dimension_key_2 = "customized_dimension_value_2";

     

       85
       85
       +
                     };

     

       86
       86
       +
                   };

     

       87
       87
       +
                 };

     

       88
       88
       +
               };

     

       89
       89
       +
               logs = {

     

       90
       90
       +
                 logs_collected = {

     

       91
       91
       +
                   files = {

     

       92
       92
       +
                     collect_list = [

     

       93
       93
       +
                       {

     

       94
       94
       +
                         file_path = "/var/log/amazon-cloudwatch-agent/amazon-cloudwatch-agent.log";

     

       95
       95
       +
                         log_group_name = "amazon-cloudwatch-agent.log";

     

       96
       96
       +
                         log_stream_name = "{instance_id}";

     

       97
       97
       +
                         timezone = "UTC";

     

       98
       98
       +
                       }

     

       99
       99
       +
                     ];

     

       100
       100
       +
                   };

     

       101
       101
       +
                 };

     

       102
       102
       +
                 log_stream_name = "log_stream_name";

     

       103
       103
       +
                 force_flush_interval = 15;

     

       104
       104
       +
               };

     

       105
       105
       +
               traces = {

     

       106
       106
       +
                 traces_collected = {

     

       107
       107
       +
                   xray = { };

     

       108
       108
       +
                   oltp = { };

     

       109
       109
       +
                 };

     

       110
       110
       +
               };

     

       111
       111
       +
             };

     

       112
       112
       +
           };

     

       113
       113
       +
           mode = lib.mkOption {

     

       114
       114
       +
             type = lib.types.str;

     

       115
       115
       +
             default = "auto";

     

       116
       116
       +
             description = ''

     

       117
       117
       +
               Amazon CloudWatch Agent mode. Indicates whether the agent is running in EC2 ("ec2"), on-premises ("onPremise"),

     

       118
       118
       +
               or if it should guess based on metadata endpoints like IMDS or the ECS task metadata endpoint ("auto").

     

       119
       119
       +
             '';

     

       120
       120
       +
             example = "onPremise";

     

       121
       121
       +
           };

     

       122
       122
       +
         };

     

       123
       123
       +
       

     

       124
       124
       +
         config = lib.mkIf cfg.enable {

     

       125
       125
       +
           # See https://github.com/aws/amazon-cloudwatch-agent/blob/v1.300048.1/packaging/dependencies/amazon-cloudwatch-agent.service.

     

       126
       126
       +
           systemd.services.amazon-cloudwatch-agent = {

     

       127
       127
       +
             description = "Amazon CloudWatch Agent";

     

       128
       128
       +
             after = [ "network.target" ];

     

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

     

       130
       130
       +
             serviceConfig = {

     

       131
       131
       +
               Type = "simple";

     

       132
       132
       +
               # "start-amazon-cloudwatch-agent" assumes the package is installed at "/opt/aws/amazon-cloudwatch-agent" so we can't use it.

     

       133
       133
       +
               #

     

       134
       134
       +
               # See https://github.com/aws/amazon-cloudwatch-agent/issues/1319.

     

       135
       135
       +
               #

     

       136
       136
       +
               # This program:

     

       137
       137
       +
               # 1. Switches to a non-root user if configured.

     

       138
       138
       +
               # 2. Runs "config-translator" to translate the input JSON configuration files into separate TOML (for CloudWatch Logs + Metrics),

     

       139
       139
       +
               #    YAML (for X-Ray + OpenTelemetry), and JSON (for environment variables) configuration files.

     

       140
       140
       +
               # 3. Runs "amazon-cloudwatch-agent" with the paths to these generated files.

     

       141
       141
       +
               #

     

       142
       142
       +
               # Re-implementing with systemd options.

     

       143
       143
       +
               User = lib.attrByPath [

     

       144
       144
       +
                 "agent"

     

       145
       145
       +
                 "run_as_user"

     

       146
       146
       +
               ] "root" cfg.configuration;

     

       147
       147
       +
               RuntimeDirectory = "amazon-cloudwatch-agent";

     

       148
       148
       +
               LogsDirectory = "amazon-cloudwatch-agent";

     

       149
       149
       +
               ExecStartPre = ''

     

       150
       150
       +
                 ${cfg.package}/bin/config-translator \

     

       151
       151
       +
                   -config ${commonConfigurationFile} \

     

       152
       152
       +
                   -input ${configurationFile} \

     

       153
       153
       +
                   -input-dir ${configurationDirectory} \

     

       154
       154
       +
                   -mode ${cfg.mode} \

     

       155
       155
       +
                   -output ''${RUNTIME_DIRECTORY}/amazon-cloudwatch-agent.toml

     

       156
       156
       +
               '';

     

       157
       157
       +
               ExecStart = ''

     

       158
       158
       +
                 ${cfg.package}/bin/amazon-cloudwatch-agent \

     

       159
       159
       +
                   -config ''${RUNTIME_DIRECTORY}/amazon-cloudwatch-agent.toml \

     

       160
       160
       +
                   -envconfig ''${RUNTIME_DIRECTORY}/env-config.json \

     

       161
       161
       +
                   -otelconfig ''${RUNTIME_DIRECTORY}/amazon-cloudwatch-agent.yaml \

     

       162
       162
       +
                   -pidfile ''${RUNTIME_DIRECTORY}/amazon-cloudwatch-agent.pid

     

       163
       163
       +
               '';

     

       164
       164
       +
               KillMode = "process";

     

       165
       165
       +
               Restart = "on-failure";

     

       166
       166
       +
               RestartSec = 60;

     

       167
       167
       +
             };

     

       168
       168
       +
             restartTriggers = [

     

       169
       169
       +
               cfg.package

     

       170
       170
       +
               commonConfigurationFile

     

       171
       171
       +
               configurationFile

     

       172
       172
       +
               configurationDirectory

     

       173
       173
       +
               cfg.mode

     

       174
       174
       +
             ];

     

       175
       175
       +
           };

     

       176
       176
       +
         };

     

       177
       177
       +
       

     

       178
       178
       +
         meta.maintainers = pkgs.amazon-cloudwatch-agent.meta.maintainers;

     

       179
       179
       +
       }

nixos/tests/all-tests.nix

···

       119
       119
        
         alloy = handleTest ./alloy.nix {};

     

       120
       120
        
         allTerminfo = handleTest ./all-terminfo.nix {};

     

       121
       121
        
         alps = handleTest ./alps.nix {};

     

       122
       122
       +
         amazon-cloudwatch-agent = handleTest ./amazon-cloudwatch-agent.nix {};

     

       122
       123
        
         amazon-init-shell = handleTest ./amazon-init-shell.nix {};

     

       123
       124
        
         amazon-ssm-agent = handleTest ./amazon-ssm-agent.nix {};

     

       124
       125
        
         amd-sev = runTest ./amd-sev.nix;

+93

nixos/tests/amazon-cloudwatch-agent.nix

···

       1
       1
       +
       import ./make-test-python.nix (

     

       2
       2
       +
         { lib, pkgs, ... }:

     

       3
       3
       +
         let

     

       4
       4
       +
           # See https://docs.aws.amazon.com/sdkref/latest/guide/file-format.html.

     

       5
       5
       +
           iniFormat = pkgs.formats.ini { };

     

       6
       6
       +
       

     

       7
       7
       +
           region = "ap-northeast-1";

     

       8
       8
       +
           sharedConfigurationDefaultProfile = "default";

     

       9
       9
       +
           sharedConfigurationFile = iniFormat.generate "config" {

     

       10
       10
       +
             "${sharedConfigurationDefaultProfile}" = {

     

       11
       11
       +
               region = region;

     

       12
       12
       +
             };

     

       13
       13
       +
           };

     

       14
       14
       +
           sharedCredentialsFile = iniFormat.generate "credentials" {

     

       15
       15
       +
             "${sharedConfigurationDefaultProfile}" = {

     

       16
       16
       +
               aws_access_key_id = "placeholder";

     

       17
       17
       +
               aws_secret_access_key = "placeholder";

     

       18
       18
       +
               aws_session_token = "placeholder";

     

       19
       19
       +
             };

     

       20
       20
       +
           };

     

       21
       21
       +
           sharedConfigurationDirectory = pkgs.runCommand ".aws" { } ''

     

       22
       22
       +
             mkdir $out

     

       23
       23
       +
       

     

       24
       24
       +
             cp ${sharedConfigurationFile} $out/config

     

       25
       25
       +
             cp ${sharedCredentialsFile} $out/credentials

     

       26
       26
       +
           '';

     

       27
       27
       +
         in

     

       28
       28
       +
         {

     

       29
       29
       +
           name = "amazon-cloudwatch-agent";

     

       30
       30
       +
           meta.maintainers = pkgs.amazon-cloudwatch-agent.meta.maintainers;

     

       31
       31
       +
       

     

       32
       32
       +
           nodes.machine =

     

       33
       33
       +
             { config, pkgs, ... }:

     

       34
       34
       +
             {

     

       35
       35
       +
               services.amazon-cloudwatch-agent = {

     

       36
       36
       +
                 enable = true;

     

       37
       37
       +
                 commonConfiguration = {

     

       38
       38
       +
                   credentials = {

     

       39
       39
       +
                     shared_credential_profile = sharedConfigurationDefaultProfile;

     

       40
       40
       +
                     shared_credential_file = "${sharedConfigurationDirectory}/credentials";

     

       41
       41
       +
                   };

     

       42
       42
       +
                 };

     

       43
       43
       +
                 configuration = {

     

       44
       44
       +
                   agent = {

     

       45
       45
       +
                     # Required despite documentation saying the agent ignores it in "onPremise" mode.

     

       46
       46
       +
                     region = region;

     

       47
       47
       +
       

     

       48
       48
       +
                     # Show debug logs and write to a file for interactive debugging.

     

       49
       49
       +
                     debug = true;

     

       50
       50
       +
                     logfile = "/var/log/amazon-cloudwatch-agent/amazon-cloudwatch-agent.log";

     

       51
       51
       +
                   };

     

       52
       52
       +
                   logs = {

     

       53
       53
       +
                     logs_collected = {

     

       54
       54
       +
                       files = {

     

       55
       55
       +
                         collect_list = [

     

       56
       56
       +
                           {

     

       57
       57
       +
                             file_path = "/var/log/amazon-cloudwatch-agent/amazon-cloudwatch-agent.log";

     

       58
       58
       +
                             log_group_name = "/var/log/amazon-cloudwatch-agent/amazon-cloudwatch-agent.log";

     

       59
       59
       +
                             log_stream_name = "{local_hostname}";

     

       60
       60
       +
                           }

     

       61
       61
       +
                         ];

     

       62
       62
       +
                       };

     

       63
       63
       +
                     };

     

       64
       64
       +
                   };

     

       65
       65
       +
                   traces = {

     

       66
       66
       +
                     local_mode = true;

     

       67
       67
       +
                     traces_collected = {

     

       68
       68
       +
                       xray = { };

     

       69
       69
       +
                     };

     

       70
       70
       +
                   };

     

       71
       71
       +
                 };

     

       72
       72
       +
                 mode = "onPremise";

     

       73
       73
       +
               };

     

       74
       74
       +
       

     

       75
       75
       +
               # Keep the runtime directory for interactive debugging.

     

       76
       76
       +
               systemd.services.amazon-cloudwatch-agent.serviceConfig.RuntimeDirectoryPreserve = true;

     

       77
       77
       +
             };

     

       78
       78
       +
       

     

       79
       79
       +
           testScript = ''

     

       80
       80
       +
             start_all()

     

       81
       81
       +
       

     

       82
       82
       +
             machine.wait_for_unit("amazon-cloudwatch-agent.service")

     

       83
       83
       +
       

     

       84
       84
       +
             machine.wait_for_file("/run/amazon-cloudwatch-agent/amazon-cloudwatch-agent.pid")

     

       85
       85
       +
             machine.wait_for_file("/run/amazon-cloudwatch-agent/amazon-cloudwatch-agent.toml")

     

       86
       86
       +
             # "config-translator" omits this file if no trace configurations are specified.

     

       87
       87
       +
             #

     

       88
       88
       +
             # See https://github.com/aws/amazon-cloudwatch-agent/issues/1320.

     

       89
       89
       +
             machine.wait_for_file("/run/amazon-cloudwatch-agent/amazon-cloudwatch-agent.yaml")

     

       90
       90
       +
             machine.wait_for_file("/run/amazon-cloudwatch-agent/env-config.json")

     

       91
       91
       +
           '';

     

       92
       92
       +
         }

     

       93
       93
       +
       )

+63

pkgs/by-name/am/amazon-cloudwatch-agent/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         amazon-cloudwatch-agent,

     

       4
       4
       +
         buildGoModule,

     

       5
       5
       +
         fetchFromGitHub,

     

       6
       6
       +
         nix-update-script,

     

       7
       7
       +
         nixosTests,

     

       8
       8
       +
         stdenv,

     

       9
       9
       +
         versionCheckHook,

     

       10
       10
       +
       }:

     

       11
       11
       +
       

     

       12
       12
       +
       buildGoModule rec {

     

       13
       13
       +
         pname = "amazon-cloudwatch-agent";

     

       14
       14
       +
         version = "1.300049.1";

     

       15
       15
       +
       

     

       16
       16
       +
         src = fetchFromGitHub {

     

       17
       17
       +
           owner = "aws";

     

       18
       18
       +
           repo = "amazon-cloudwatch-agent";

     

       19
       19
       +
           rev = "refs/tags/v${version}";

     

       20
       20
       +
           hash = "sha256-/VzLSHlBT40h7iErBisfSp7cTAm3L4vmZP03UiDmBaE=";

     

       21
       21
       +
         };

     

       22
       22
       +
       

     

       23
       23
       +
         vendorHash = "sha256-zsASHuTXL3brRlgLPNb4wFPHkYpUWbOdRDCXQUwZjIY=";

     

       24
       24
       +
       

     

       25
       25
       +
         # See the list in https://github.com/aws/amazon-cloudwatch-agent/blob/v1.300048.1/Makefile#L68-L77.

     

       26
       26
       +
         subPackages = [

     

       27
       27
       +
           "cmd/config-downloader"

     

       28
       28
       +
           "cmd/config-translator"

     

       29
       29
       +
           "cmd/amazon-cloudwatch-agent"

     

       30
       30
       +
           # Broken since it hardcodes the package install path. See https://github.com/aws/amazon-cloudwatch-agent/issues/1319.

     

       31
       31
       +
           # "cmd/start-amazon-cloudwatch-agent"

     

       32
       32
       +
           "cmd/amazon-cloudwatch-agent-config-wizard"

     

       33
       33
       +
         ];

     

       34
       34
       +
       

     

       35
       35
       +
         # See https://github.com/aws/amazon-cloudwatch-agent/blob/v1.300048.1/Makefile#L57-L64.

     

       36
       36
       +
         #

     

       37
       37
       +
         # Needed for "amazon-cloudwatch-agent -version" to not show "Unknown".

     

       38
       38
       +
         postInstall = ''

     

       39
       39
       +
           echo v${version} > $out/bin/CWAGENT_VERSION

     

       40
       40
       +
         '';

     

       41
       41
       +
       

     

       42
       42
       +
         doInstallCheck = true;

     

       43
       43
       +
       

     

       44
       44
       +
         nativeInstallCheckInputs = [ versionCheckHook ];

     

       45
       45
       +
       

     

       46
       46
       +
         versionCheckProgramArg = "-version";

     

       47
       47
       +
       

     

       48
       48
       +
         passthru = {

     

       49
       49
       +
           tests = lib.optionalAttrs stdenv.isLinux {

     

       50
       50
       +
             inherit (nixosTests) amazon-cloudwatch-agent;

     

       51
       51
       +
           };

     

       52
       52
       +
       

     

       53
       53
       +
           updateScript = nix-update-script { };

     

       54
       54
       +
         };

     

       55
       55
       +
       

     

       56
       56
       +
         meta = {

     

       57
       57
       +
           description = "CloudWatch Agent enables you to collect and export host-level metrics and logs on instances running Linux or Windows server";

     

       58
       58
       +
           homepage = "https://github.com/aws/amazon-cloudwatch-agent";

     

       59
       59
       +
           license = lib.licenses.mit;

     

       60
       60
       +
           mainProgram = "amazon-cloudwatch-agent";

     

       61
       61
       +
           maintainers = with lib.maintainers; [ pmw ];

     

       62
       62
       +
         };

     

       63
       63
       +
       }