config.yml.example

postgresql:
  host: green-coding-postgres-container
  user: postgres
  dbname: green-coding
  password: PLEASE_CHANGE_THIS
  port: 9573
  retry_timeout: 300  # Total time to retry database connections on outage/failure (5 minutes)

redis:
  host: green-coding-redis-container
  port: 6379

smtp:
  server: SMTP_SERVER
  sender: SMTP_SENDER
  port: SMTP_PORT
  password: SMTP_AUTH_PW
  user: SMTP_AUTH_USER

admin:
  # This address will get an email, for notifications in the system like an added job through the interface
  notification_email: False
  # Takes a file path to log all the errors to it. This is disabled if False
  error_file: False
  # Sends an error notification also via email. This is disabled if False
  error_email: False
  # This email will always get a copy of email sent which is not already the receipient, even for user-only mails like the "Your report is ready" mail.
  email_bcc: False


cluster:
  api_url: __API_URL__
  metrics_url: __METRICS_URL__
  cors_allowed_origins:
      - __API_URL__
      - __METRICS_URL__
  client:
    sleep_time_no_job: 300
    jobs_processing: "random"
    shutdown_on_job_no: suspend
    # These two parameters have only effect in cluster mode. When using CLI they will be set via flags --docker-prune and --full-docker-prune only
    docker_prune: True
    full_docker_prune: False
    # define a workload to check cluster noise floor
    time_between_control_workload_validations: 21600
    send_control_workload_status_mail: False
    control_workload:
      name: "Measurement control Workload"
      uri: "https://github.com/green-coding-solutions/measurement-control-workload"
      filename: "usage_scenario.yml"
      branch: "event-bound"
      comparison_window: 5
      phase: "004_[RUNTIME]"
      metrics:
        psu_energy_ac_mcp_machine:
          threshold: 0.01 # 1%
          type: stddev_rel
        psu_power_ac_mcp_machine:
          threshold: 0.01 # 1%
          type: stddev_rel
        cpu_power_rapl_msr_component:
          threshold: 0.01 # 1%
          type: stddev_rel
        cpu_energy_rapl_msr_component:
          threshold: 0.01 # 1%
          type: stddev_rel
        psu_carbon_ac_mcp_machine:
          threshold: 0.01 # 1%
          type: stddev_rel
        network_total_cgroup_container:
          threshold: 10000 # 10 kB
          type: stddev
        phase_time_syscall_system:
          threshold: 0.01 # 1%
          type: stddev_rel


machine:
  id: 1
  description: "Development machine for testing"
  base_temperature_value: False
  base_temperature_chip: False
  base_temperature_feature: False

measurement:
  full_docker_prune_whitelist:
    - gcr.io/kaniko-project/executor
  metric_providers:
  # Please select the needed providers according to the working ones on your system
  # More info https://docs.green-coding.io/docs/measuring/metric-providers
  # Please activate and deactivate any provider in this list by uncommenting it.
  # Keep in mind that some reporters need separate installation steps to be found @
  # https://docs.green-coding.io/docs/installation/installation-overview/
  # You can ignore any line that starts with #---
    #--- Architecture - Linux Only
    linux:
    #--- Always-On - We recommend these providers to be always enabled
      cpu.utilization.procfs.system.provider.CpuUtilizationProcfsSystemProvider:
        sampling_rate: 99
    #--- CGroupV2 - Turn these on if you have CGroupsV2 working on your machine
      cpu.utilization.cgroup.container.provider.CpuUtilizationCgroupContainerProvider:
        sampling_rate: 99
      memory.used.cgroup.container.provider.MemoryUsedCgroupContainerProvider:
        sampling_rate: 99
      network.io.cgroup.container.provider.NetworkIoCgroupContainerProvider:
        sampling_rate: 99
      disk.io.cgroup.container.provider.DiskIoCgroupContainerProvider:
        sampling_rate: 99
    #--- RAPL - Only enable these if you have RAPL enabled on your machine
#      cpu.energy.rapl.msr.component.provider.CpuEnergyRaplMsrComponentProvider:
#        sampling_rate: 99
#      memory.energy.rapl.msr.component.provider.MemoryEnergyRaplMsrComponentProvider:
#        sampling_rate: 99
    #--- Machine Energy - These providers need special hardware / lab equipment to work
#      psu.energy.ac.gude.machine.provider.PsuEnergyAcGudeMachineProvider:
#        sampling_rate: 99
#      psu.energy.ac.powerspy2.machine.provider.PsuEnergyAcPowerspy2MachineProvider:
#        sampling_rate: 250
#      psu.energy.ac.mcp.machine.provider.PsuEnergyAcMcpMachineProvider:
#        sampling_rate: 99
#      psu.energy.ac.ipmi.machine.provider.PsuEnergyAcIpmiMachineProvider:
#        sampling_rate: 99
#      psu.energy.dc.rapl.msr.machine.provider.PsuEnergyDcRaplMsrMachineProvider:
#        sampling_rate: 99
    #--- GPU - Only enable these if you have GPUs with power measurement enabled in your machine
#      gpu.energy.nvidia.nvml.component.provider.GpuEnergyNvidiaNvmlComponentProvider:
#        sampling_rate: 99
    #--- Sensors - these providers need the lm-sensors package installed
#      lmsensors.temperature.component.provider.LmsensorsTemperatureComponentProvider:
#        sampling_rate: 99
      # Please change these values according to the names in '$ sensors'
#        chips: ['thinkpad-isa-0000', 'coretemp-isa-0000']
#        features: ['CPU', 'Package id 0', 'Core 0', 'Core 1', 'Core 2', 'Core 3']
#      lmsensors.fan.component.provider.LmsensorsFanComponentProvider:
#        sampling_rate: 99
      # Please change these values according to the names in '$ sensors'
#        chips: ['thinkpad-isa-0000']
#        features: ['fan1', 'fan2']
    #--- Debug - These providers should only be needed for debugging and introspection purposes
#      cpu.throttling.msr.component.provider.CpuThrottlingMsrComponentProvider:
#        sampling_rate: 99
#      cpu.frequency.sysfs.core.provider.CpuFrequencySysfsCoreProvider:
#        sampling_rate: 99
#      cpu.time.cgroup.container.provider.CpuTimeCgroupContainerProvider:
#        sampling_rate: 99
#      cpu.time.cgroup.system.provider.CpuTimeCgroupSystemProvider:
#        sampling_rate: 99
#      cpu.time.procfs.system.provider.CpuTimeProcfsSystemProvider:
#        sampling_rate: 99
#      disk.io.procfs.system.provider.DiskIoProcfsSystemProvider:
#        sampling_rate: 99
#      network.io.procfs.system.provider.NetworkIoProcfsSystemProvider:
#        sampling_rate: 99
#        remove_virtual_interfaces: True
#      disk.used.statvfs.system.provider.DiskUsedStatvfsSystemProvider:
#        sampling_rate: 99
#      memory.used.procfs.system.provider.MemoryUsedProcfsSystemProvider:
#        sampling_rate: 99
    #--- Cgroup system monitoring - These providers can be used to monitor background processes
#      cpu.utilization.cgroup.system.provider.CpuUtilizationCgroupSystemProvider:
#        sampling_rate: 99
#        cgroups:
#            "org.gnome.Shell@wayland.service":
#                name: "Window Manager incl. X11"
#            "session-2.scope":
#                name: "GNOME Desktop"
#      memory.used.cgroup.system.provider.MemoryUsedCgroupSystemProvider:
#        sampling_rate: 99
#        cgroups:
#            "org.gnome.Shell@wayland.service":
#                name: "Window Manager incl. X11"
#            "session-2.scope":
#                name: "GNOME Desktop"
#      disk.io.cgroup.system.provider.DiskIoCgroupSystemProvider:
#        sampling_rate: 99
#        cgroups:
#            "org.gnome.Shell@wayland.service":
#                name: "Window Manager incl. X11"
#            "session-2.scope":
#                name: "GNOME Desktop"
#      network.io.cgroup.system.provider.NetworkIoCgroupSystemProvider:
#        sampling_rate: 99
#        cgroups:
#            "org.gnome.Shell@wayland.service":
#                name: "Window Manager incl. X11"
#            "session-2.scope":
#                name: "GNOME Desktop"

    #--- Architecture - MacOS
    macos:
    #--- MacOS: On Mac you only need this provider. Please remove all others!
      powermetrics.provider.PowermetricsProvider:
        sampling_rate: 499 # If you set this value too low powermetrics will not be able to accommodate the timing. We recommend no lower than 199 ms
      cpu.utilization.mach.system.provider.CpuUtilizationMachSystemProvider:
        sampling_rate: 99
    #--- Architecture - Common
    common:
#      network.connections.proxy.container.provider.NetworkConnectionsProxyContainerProvider:
##        host_ip: 192.168.1.2 # This only needs to be enabled if automatic detection fails
    #--- Model based - These providers estimate rather than measure. Helpful where measuring is not possible, like in VMs
#      psu.energy.ac.sdia.machine.provider.PsuEnergyAcSdiaMachineProvider:
      #-- This is a default configuration. Please change this to your system!
#        CPUChips: 1
#        TDP: 65
#      psu.energy.ac.xgboost.machine.provider.PsuEnergyAcXgboostMachineProvider:
      #-- This is a default configuration. Please change this to your system!
#        CPUChips: 1
#        HW_CPUFreq: 3200
#        CPUCores: 4
#        CPUThreads: 4
#        TDP: 65
######### The value for memory must be in GB not in GiB
#        HW_MemAmountGB: 16
#        Hardware_Availability_Year: 2011
######### vhost_ratio is the virtualization degree of the machine. For Bare Metal this is 1. For 1 out of 4 VMs this would be 0.25 etc.
#        VHost_Ratio: 1
#
###### DEBUG
#      network.connections.tcpdump.system.provider.NetworkConnectionsTcpdumpSystemProvider:
#        split_ports: True
#--- END


sci:
    # https://github.com/Green-Software-Foundation/sci/blob/main/Software_Carbon_Intensity/Software_Carbon_Intensity_Specification.md

    # The values specific to the machine will be set here. The values that are specific to the
    # software, like R (functional unit), will be set in the usage_scenario.yml

    # EL Expected Lifespan; the anticipated time that the equipment will be installed. Value is in years
    # The number 3.5 comes from a typical developer machine (Pro Laptop - https://dataviz.boavizta.org/terminalimpact)
    EL: 4
    # RS Resource-share; the share of the total available resources of the hardware reserved for use by the software.
    # This ratio is typically 1 with the Green Metrics Tool unless you use a custom distributed orchestrator
    RS: 1
    # TE Total Embodied Emissions; the sum of Life Cycle Assessment (LCA) emissions for all hardware components.
    # Value is in gCO2eq
    # The value has to be identified from vendor datasheets. Here are some example sources:
    # https://dataviz.boavizta.org/manufacturerdata
    # https://tco.exploresurface.com/sustainability/calculator
    # https://www.delltechnologies.com/asset/en-us/products/servers/technical-support/Full_LCA_Dell_R740.pdf
    # The default is the value for a developer machine (Pro Laptop - https://dataviz.boavizta.org/terminalimpact)
    TE: 181000
    # I is the Carbon Intensity at the location of this machine
    # The value can either be a number in gCO2e/kWh or a carbon intensity provider that fetches this number dynamically
    # https://docs.green-coding.io/docs/measuring/carbon-intensity-providers/carbon-intensity-providers-overview/ (TODO)
    # For fixed world-wide values get the number from https://ember-climate.org/insights/research/global-electricity-review-2025/
    # The number worldwide for 2024 is 473
    # The number 334 that comes as default is for Germany from 2024 and comes from https://app.electricitymaps.com/zone/DE/all/yearly
    I: 334
    # N is not technically part of the SCI, but we keep the value here for better clustering.
    # N is the network energy intensity per transferred data. It transforms values like GB to kWh
    # See https://www.green-coding.io/co2-formulas/ for details
    N: 0.04106063

#optimization:
#  ignore:
#    - example_optimization_test

# In order to get the carbon intensity we use electricity maps which requires a token.
# You can get this under https://api-portal.electricitymaps.com/
# This is a free service please note that you need to pay if you want to use this commercially!
#electricity_maps_token: '123'

# Modules API / Frontend
# GMT can selectively activate some API and frontend components. This is asked in the install process and should NOT
# only be changed here as files in different locations are changed too. Please re-run the install process.
activate_scenario_runner: False
activate_eco_ci: False
activate_power_hog: False
activate_carbon_db: False
activate_ai: False

# GMT can activate additional enterprise only functionality
# If you have a subscription insert your token here
ee_token: False