Output¶

Choosing output methods¶

Use the output_methods parameter to select where emissions data is sent. It takes a list of OutputMethod enum values:

from codecarbon import EmissionsTracker, OutputMethod

tracker = EmissionsTracker(
    output_methods=[OutputMethod.CSV, OutputMethod.API],
)

Available values: CSV, API, LOGGER, PROMETHEUS, LOGFIRE, BOAMPS. It can also be set in the config file as a comma-separated string, e.g. output_methods=csv,api. HTTP output is enabled separately via the emissions_endpoint parameter.

CSV¶

The package has an in-built logger that logs data into a CSV file named emissions.csv in the output_dir, provided as an input parameter (defaults to the current directory), for each experiment tracked across projects.

Prometheus¶

Prometheus is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are observed.

CodeCarbon exposes all its metrics with the suffix codecarbon_.

Current version uses pushgateway mode. If your pushgateway server needs auth, set your environment variables PROMETHEUS_USERNAME and PROMETHEUS_PASSWORD so CodeCarbon can push the metrics.

How to test locally¶

Deploy a local version of Prometheus + Prometheus Pushgateway:

docker-compose up

Run your EmissionsTracker as usual, with save_to_prometheus=True:

from codecarbon import OfflineEmissionsTracker

tracker = OfflineEmissionsTracker(
    project_name="my_project",
    country_iso_code="USA",
    save_to_prometheus=True,
)
tracker.start()
# Your code here
tracker.stop()

Go to localhost:9090. Search for codecarbon_ to see all metrics.

Logfire¶

Logfire is an observability platform.

CodeCarbon exposes all its metrics with the suffix codecarbon_.

How to use it¶

Run your EmissionsTracker as usual, with save_to_logfire=True:

from codecarbon import OfflineEmissionsTracker

tracker = OfflineEmissionsTracker(
    project_name="my_project",
    country_iso_code="USA",
    save_to_logfire=True,
)
tracker.start()
# Your code here
tracker.stop()

The first time it will ask you to log in to Logfire. Once you log in and set the default Logfire project, the metrics will appear following the format codecarbon_*.

BoAmps¶

BoAmps is a standardized JSON format for reporting AI and ML energy consumption.

How to use it¶

Run your EmissionsTracker as usual, adding OutputMethod.BOAMPS to output_methods:

from codecarbon import OfflineEmissionsTracker, OutputMethod

tracker = OfflineEmissionsTracker(
    project_name="my_project",
    country_iso_code="USA",
    output_methods=[OutputMethod.CSV, OutputMethod.BOAMPS],
)
tracker.start()
# Your code here
tracker.stop()

CodeCarbon writes a final report named boamps_report_<run_id>.json in output_dir.

If you need to enrich the report with task metadata, datasets, or publisher information, use BoAmpsOutput directly through output_handlers or start from examples/boamps_output.py.

Sample output:

{
  "header": {
    "formatVersion": "0.1",
    "formatVersionSpecificationUri": "https://github.com/Boavizta/BoAmps/tree/main/model",
    "reportId": "79e4408f-ec31-476f-a2c5-8ca7f53e6cc7",
    "reportDatetime": "2026-04-09 23:07:42"
  },
  "measures": [
    {
      "measurementMethod": "codecarbon",
      "version": "3.2.6",
      "averageUtilizationCpu": 0.6,
      "powerConsumption": 6.515418096322266e-05,
      "measurementDuration": 7.052794550996623,
      "measurementDateTime": "2026-04-09 23:07:42"
    }
  ],
  "system": {
    "os": "Linux-6.17.0-19-generic-x86_64-with-glibc2.42"
  },
  "software": {
    "language": "python",
    "version": "3.12.12"
  },
  "infrastructure": {
    "infraType": "onPremise",
    "components": [
      {
        "componentName": "Intel(R) Core(TM) Ultra 7 265H",
        "componentType": "cpu",
        "nbComponent": 8
      },
      {
        "componentType": "ram",
        "nbComponent": 1,
        "memorySize": 30.052967071533203
      }
    ]
  },
  "environment": {
    "country": "France",
    "latitude": 48.6,
    "longitude": 2.3
  }
}

HTTP Output¶

The HTTP Output allows calling a webhook with emission data when the tracker is stopped. Use the emissions_endpoint parameter to specify your endpoint.

CodeCarbon API¶

You can send all your data to the CodeCarbon API so you have your historical data in one place. By default, nothing is sent to the API. Use save_to_api=True and configure your API credentials.

Logger Output¶

See Collecting emissions to a logger.