Carmen

Carmen（Carbon Measurement Engine）は、クラウドインフラストラクチャとアプリケーションからの炭素排出量を測定するオープンソースツールです。

Carmenは、2つのソースから炭素排出量を測定します:

• インフラストラクチャ: 仮想マシンとクラウドワークロードからのエネルギー消費と炭素排出量を、VM使用状況データ（CSV形式）を使用して測定します。
• アプリケーション: Kubernetesクラスターで実行されている個々のワークロードとポッドからの炭素排出量を、Prometheusメトリクスを使用して測定します。

Carmenは、Grafana、FinOpsダッシュボード、または独自のツールで使用できるCSVレポートを出力します。

入力データ形式

Carmenデーモンは、VM使用状況データをCSV形式で予期しています。ローカルファイルの場合は、config.yamlをCSVがあるパスに指定します。Azure Blob Storageを使用する場合は、config.yamlでストレージアカウントを設定すると、Carmenがデータを直接読み取ります。

必須フィールドは次のとおりです:

Idフィールドはレポートの粒度を制御します。Idの一意の値ごとに、出力で1つのコンポーネントが生成されます。VMごとの設定が一般的ですが、必要なインサイトに応じて、より粗い識別子（サービスごと）またはより細かい識別子を使用できます。

Carmenをパイプラインに追加する

CarmenをCI/CDジョブとして実行し、VM使用状況データから炭素排出量レポートを生成し、パイプラインアーティファクトとして保存できます。

前提条件:

• お使いのRunner環境にPython 3.12、Pip、NPM、Git、lsb-release、およびbashがインストールされていること。
• 必要な形式のローカルCSVファイルとしてのVM使用状況データ。CarmenはAzure Blob Storageからの読み取りもサポートしています。
• 既知のパスにあるconfig.yamlファイル。

Carmenをパイプラインに追加するには:

1. お使いの.gitlab-ci.ymlファイルに、Carmenをインストールし、Carmenに同梱されているサンプルデータに対してデーモンを実行するジョブを追加します:

   carbon-report:
     image: python:3.12
     before_script:
       - apt-get update && apt-get install -y nodejs npm git lsb-release
       - git clone https://github.com/Green-Software-Foundation/if-carmen.git
       - npm install -g "@grnsft/if@1.0.0" "@grnsft/if-plugins@0.3.2" "@grnsft/if-unofficial-plugins@0.3.1"
       - pip install --upgrade pip && pip install -e $CI_PROJECT_DIR/if-carmen
     script:
       - cd $CI_PROJECT_DIR/if-carmen/example-data && carbon-daemon
     artifacts:
       paths:
         - if-carmen/example-data/output/
       expire_in: 1 week

2. パイプラインを実行し、ジョブがアーティファクトにCO2_<date>.csvファイルと、EnergykWhおよびTotalCarbonGramsCO2eq列にゼロ以外の値を生成することを確認します。

3. ローカルのCSVデータを指すconfig.yamlをリポジトリに追加します:

   carmen_daemon:
     source:
       type: local
       file_names:
         - "vm_metrics.csv"
       local:
         source_path: "data/vm-metrics"
     upload:
       type: local
       local:
         upload_path: "./output"

   Azure Blob Storageの場合、source.typeをazureに設定し、Azureストレージアカウントの設定と認証情報を追加します。すべてのオプションについては、Carmen設定を参照してください。

4. お使いのジョブのscriptセクションとartifactsセクションを置き換えます:

   script:
     - mkdir -p $CI_PROJECT_DIR/output
     - cd $CI_PROJECT_DIR && carbon-daemon
   artifacts:
     paths:
       - output/
     expire_in: 1 week

5. パイプラインを再度実行し、出力CO2_<date>.csvに独自のデータが含まれていることを確認します。

結果の表示

Carmenは、コンポーネント（VM）ごとに1行のCSVレポートを日別に生成します。出力ファイルはCO2_<date>.csvの命名パターンに従い、upload.local.upload_pathで設定されたパスに保存されます。

結果を表示するには:

1. お使いのパイプラインに移動します。
2. carbon-reportジョブを選択します。
3. ジョブのアーティファクトの下で、閲覧を選択します。
4. CO2_<date>.csvファイルを開きます。

このレポートには、次のフィールドが含まれています:

アプリケーション測定

Kubernetesクラスター内の個々のワークロードの炭素排出量測定には、CarmenをサイドカーAPIサービスとしてPrometheusとともにデプロイできます。このモードでは、設定可能な間隔でポッドごとのCPUおよびメモリメトリクスをプルすることができます。

このデプロイには、Helm、Prometheus、kube-state-metrics、およびcAdvisorがインストールされたKubernetesクラスターが必要です。詳細については、CarmenリポジトリのCarmen as a Serviceを参照してください。

トラブルシューティング

Carmenを使用する際、次の問題に遭遇する可能性があります。

最初のレポート出力が正しくないように見える

炭素排出量の値が予想外に高いか低いように見えます。

この問題は、実際のVM仕様が提供されなかったため、Carmenがデフォルトのベンチマークハードウェア設定にフォールバックしたときに発生します。

この問題を解決するには、クラウドプロバイダーのAPIから実際のVM仕様を提供してください。

出力にVMごとに1行しか含まれていない

お使いのレポートの行数が予想より少ないです。

この問題は、複数のレコードが同じId値を共有している場合に発生します。

この問題を解決するには、入力CSVのId列を確認してください。Idの一意の値ごとに、出力で1つのコンポーネントが生成されます。

Carmenが出力を生成しない

carbon-daemonの実行後、出力ディレクトリが空です。

この問題は、Impact Frameworkがグローバルにインストールされていないか、またはconfig.yamlパスがcarbon-daemonを実行するディレクトリから解決できない場合に発生する可能性があります。

この問題を解決するには、次の手順に従います:

• @grnsft/ifがインストールされており、アクセス可能であることを確認します: if-run --version
• config.yaml内のパスが作業ディレクトリから解決することを確認します。

測定値は日次合計のみに集計される

時間ごとまたは日中の炭素排出量が必要です。

Carmenは日次合計のみに集計します。時間単位の解像度は既知の制限事項です。