安定版リリースのドキュメントについては、[バージョニングされたドキュメント] プルダウンを使用してください。デフォルトのビューには HEAD の最新バージョンが表示されます。

このページは Cloud Translation API によって翻訳されました。

ビルドイベントプロトコルに関する用語集

各 BEP イベントタイプには独自のセマンティクスがあり、最低限 build_event_stream.proto に記載されています。以下の用語集では、各イベントタイプについて説明します。

中止

他のイベントとは異なり、Aborted イベントは他のタイプのイベントを「置き換える」イベントのため、Aborted には対応する ID タイプがありません。このイベントは、ビルドが早期に終了し、そのイベント ID が正常に生成されていないことを示します。Aborted には、ビルドが完了しなかった理由を説明する列挙型とわかりやすい説明が含まれています。

たとえば、ユーザーが Bazel を中断したときにビルドでターゲットを評価している場合、BEP には次のようなイベントが含まれます。

{
  "id": {
    "targetCompleted": {
      "label": "//:foo",
      "configuration": {
        "id": "544e39a7f0abdb3efdd29d675a48bc6a"
      }
    }
  },
  "aborted": {
    "reason": "USER_INTERRUPTED"
  }
}

ActionExecuted

ビルド内の特定のアクションの実行に関する詳細を提供します。デフォルトでは、ビルド失敗の根本原因を特定できるように、このイベントは失敗したアクションに対してのみ BEP に含まれています。--build_event_publish_all_actions フラグを設定すると、すべての ActionExecuted イベントを含めることができます。

BuildFinished

コマンドが完了してコマンドの終了コードを含む単一の BuildFinished イベントが送信されます。このイベントは、信頼できる成功/失敗の情報を提供します。

BuildMetadata

--build_metadata フラグの解析された内容が含まれます。このイベントは、外部データ（識別子など）を組み込んで、他のツールとの Bazel の統合をサポートするために存在します。

BuildMetrics

各コマンドの最後に 1 つの BuildMetrics イベントが送信されます。このイベントには、コマンドの実行中にビルドツールの動作を定量化するのに役立つカウンタ/ゲージが含まれます。これらの指標は作業が実際に行われたことを示します。キャッシュ内の再利用された作業はカウントされません。

コマンドの実行中に Java ガベージコレクションが実行されなかった場合、memory_metrics に値が入力されないことがあります。--memory_profile=/dev/null オプションを設定すると、コマンドの最後にガベージコレクタを強制的に実行して memory_metrics にデータを入力できます。

{
  "id": {
    "buildMetrics": {}
  },
  "buildMetrics": {
    "actionSummary": {
      "actionsExecuted": "1"
    },
    "memoryMetrics": {},
    "targetMetrics": {
      "targetsLoaded": "9",
      "targetsConfigured": "19"
    },
    "packageMetrics": {
      "packagesLoaded": "5"
    },
    "timingMetrics": {
      "cpuTimeInMs": "1590",
      "wallTimeInMs": "359"
    }
  }
}

BuildStarted

BEP ストリームの最初のイベントである BuildStarted には、有意義な処理が始まる前のコマンドを記述するメタデータが含まれています。

BuildToolLogs

コマンドの最後に BuildToolLogs イベントが 1 つ送信されます。このイベントには、ビルドツールによって生成されたファイルの URI が含まれ、ビルドツールの動作の把握やデバッグに役立ちます。一部の情報がインラインで入力される場合があります。

{
  "id": {
    "buildToolLogs": {}
  },
  "lastMessage": true,
  "buildToolLogs": {
    "log": [
      {
        "name": "elapsed time",
        "contents": "MC4xMjEwMDA="
      },
      {
        "name": "process stats",
        "contents": "MSBwcm9jZXNzOiAxIGludGVybmFsLg=="
      },
      {
        "name": "command.profile.gz",
        "uri": "file:///tmp/.cache/bazel/_bazel_foo/cde87985ad0bfef34eacae575224b8d1/command.profile.gz"
      }
    ]
  }
}

CommandLine

BEP には、すべてのコマンドライン引数（オプションと解釈されない引数を含む）の表現を含む、複数の CommandLine イベントが含まれます。各 CommandLine イベントの StructuredCommandLineId には、それが伝達する表現を示すラベルがあります。そのようなイベントが BEP に現れます。

"original": .rc ファイルをソースとする起動オプションを指定せずに、Bazel が Bazel クライアントから受け取ったとおりにコマンドラインを再構築しました。
"canonical": .rc ファイルが展開され、呼び出しポリシーが適用された有効なコマンドライン。
"tool": --experimental_tool_command_line オプションから入力されます。これは、Bazel をラップするツールのコマンドラインを BEP で伝えるのに役立ちます。これは、直接使用される base64 エンコードの CommandLine バイナリプロトコルバッファメッセージか、解析されても解釈されない文字列です（ツールのオプションが Bazel のオプションと異なる場合があるため）。

設定

Configuration イベントは、ビルドのトップレベルターゲットで使用されるすべての configuration に送信されます。少なくとも 1 つの構成イベントが常に存在します。id は TargetConfigured および TargetComplete のイベント ID によって再利用され、マルチ構成ビルドでこれらのイベントを明確化するために必要です。

{
  "id": {
    "configuration": {
      "id": "a5d130b0966b4a9ca2d32725aa5baf40e215bcfc4d5cdcdc60f5cc5b4918903b"
    }
  },
  "configuration": {
    "mnemonic": "k8-fastbuild",
    "platformName": "k8",
    "cpu": "k8",
    "makeVariable": {
      "COMPILATION_MODE": "fastbuild",
      "TARGET_CPU": "k8",
      "GENDIR": "bazel-out/k8-fastbuild/bin",
      "BINDIR": "bazel-out/k8-fastbuild/bin"
    }
  }
}

ConvenienceSymlinksIdentified

試験運用中:--experimental_convenience_symlinks_bep_event オプションを設定すると、build コマンドによって単一の ConvenienceSymlinksIdentified イベントが生成され、ワークスペース内のシンボリックリンクの管理方法が示されます。これにより、Bazel をリモートで呼び出すツールをビルドしてから、Bazel がローカルで実行されているかのようにローカルワークスペースを調整できます。

{
  "id": {
    "convenienceSymlinksIdentified":{}
  },
  "convenienceSymlinksIdentified": {
    "convenienceSymlinks": [
      {
        "path": "bazel-bin",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out/k8-fastbuild/bin"
      },
      {
        "path": "bazel-genfiles",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out/k8-fastbuild/genfiles"
      },
      {
        "path": "bazel-out",
        "action": "CREATE",
        "target": "execroot/google3/bazel-out"
      }
    ]
  }
}

フェッチ

Fetch オペレーションがコマンド実行の一部として発生したことを示します。他のイベントとは異なり、キャッシュに保存された取得結果が再利用された場合、このイベントは BEP ストリームに表示されません。

NamedSetOfFiles

NamedSetOfFiles イベントは、コマンド評価中に生成されたファイルの depset に一致する構造をレポートします。推移的に含まれる依存関係は NamedSetOfFilesId で識別されます。

ストリームの NamedSetOfFiles イベントの解釈の詳細については、BEP の例のページをご覧ください。

OptionsParsed

1 つの OptionsParsed イベントで、コマンドに適用されるすべてのオプションがリストされ、起動オプションとコマンドオプションが区別されます。また、InvocationPolicy があればそれも含まれます。

{
  "id": {
    "optionsParsed": {}
  },
  "optionsParsed": {
    "startupOptions": [
      "--max_idle_secs=10800",
      "--noshutdown_on_low_sys_mem",
      "--connect_timeout_secs=30",
      "--output_user_root=/tmp/.cache/bazel/_bazel_foo",
      "--output_base=/tmp/.cache/bazel/_bazel_foo/a61fd0fbee3f9d6c1e30d54b68655d35",
      "--deep_execroot",
      "--expand_configs_in_place",
      "--idle_server_tasks",
      "--write_command_log",
      "--nowatchfs",
      "--nofatal_event_bus_exceptions",
      "--nowindows_enable_symlinks",
      "--noclient_debug",
    ],
    "cmdLine": [
      "--enable_platform_specific_config",
      "--build_event_json_file=/tmp/bep.json"
    ],
    "explicitCmdLine": [
      "--build_event_json_file=/tmp/bep.json"
    ],
    "invocationPolicy": {}
  }
}

PatternExpanded

PatternExpanded イベントは、コマンドラインで指定されたパターンに一致するすべてのターゲットのセットを示します。コマンドが正常に完了すると、PatternExpandedId 内のすべてのパターンと PatternExpanded イベントの子内のすべてのターゲットを含む単一のイベントが存在します。パターンがいずれかの test_suite に展開される場合、test_suite に含まれるテストターゲットのセット。解決に失敗したパターンごとに、BEP には追加の Aborted イベントが含まれ、PatternExpandedId でパターンを識別します。

{
  "id": {
    "pattern": {
      "pattern":["//base:all"]
    }
  },
  "children": [
    {"targetConfigured":{"label":"//base:foo"}},
    {"targetConfigured":{"label":"//base:foobar"}}
  ],
  "expanded": {
    "testSuiteExpansions": {
      "suiteLabel": "//base:suite",
      "testLabels": "//base:foo_test"
    }
  }
}

進捗状況

進行状況イベントには、コマンドの実行中に Bazel によって生成された標準出力と標準エラーが含まれます。これらのイベントは、論理「親」イベント（特に NamedSetOfFiles）で通知されていないイベントを必要に応じて通知するために、必要に応じて自動生成されます。

TargetComplete

実行フェーズを完了する (target, configuration, aspect) の組み合わせごとに、TargetComplete イベントが BEP に含まれます。このイベントには、ターゲットの成功/失敗と、ターゲットがリクエストした出力グループが含まれます。

{
  "id": {
    "targetCompleted": {
      "label": "//examples/py:bep",
      "configuration": {
        "id": "a5d130b0966b4a9ca2d32725aa5baf40e215bcfc4d5cdcdc60f5cc5b4918903b"
      }
    }
  },
  "completed": {
    "success": true,
    "outputGroup": [
      {
        "name": "default",
        "fileSets": [
          {
            "id": "0"
          }
        ]
      }
    ]
  }
}

TargetConfigured

分析フェーズを完了するターゲットごとに、BEP に TargetConfigured イベントが含まれます。これは、ターゲットの「ルールの種類」属性の信頼できるソースです。ターゲットに適用される構成は、通知されるイベントの子に表示されます。

たとえば、--experimental_multi_cpu オプションを使用してビルドすると、2 つの構成を持つ 1 つのターゲットに対して次のような TargetConfigured イベントが生成されます。

{
  "id": {
    "targetConfigured": {
      "label": "//starlark_configurations/multi_arch_binary:foo"
    }
  },
  "children": [
    {
      "targetCompleted": {
        "label": "//starlark_configurations/multi_arch_binary:foo",
        "configuration": {
          "id": "c62b30c8ab7b9fc51a05848af9276529842a11a7655c71327ade26d7c894c818"
        }
      }
    },
    {
      "targetCompleted": {
        "label": "//starlark_configurations/multi_arch_binary:foo",
        "configuration": {
          "id": "eae0379b65abce68d54e0924c0ebcbf3d3df26c6e84ef7b2be51e8dc5b513c99"
        }
      }
    }
  ],
  "configured": {
    "targetKind": "foo_binary rule"
  }
}

TargetSummary

実行される (target, configuration) ペアごとに、TargetSummary イベントと、構成されたターゲットの実行、その構成されたターゲットに適用されたすべてのアスペクトを含む成功結果の集計が含まれます。

TestResult

テストをリクエストすると、テストの試行、シャード、テストごとに TestResult イベントが送信されます。これにより、BEP コンシューマは、テストに失敗したテストアクションを正確に特定し、各テストアクションのテスト出力（ログ、test.xml ファイルなど）を特定できます。

TestSummary

テストをリクエストすると、テストの (target, configuration) ごとに TestSummary イベントが送信されます。このイベントには、テスト結果の解釈に必要な情報が含まれます。BEP コンシューマがこれらのディメンション間でアーティファクトを区別できるように、テストごとの試行回数、シャード、実行回数が含まれています。各テストの試行回数と実行回数は、FLAKY テストと FAILED テストを区別するために集計 TestStatus を生成する際に考慮されます。

UnstructuredCommandLine

CommandLine とは異なり、このイベントには、すべての .bazelrc ファイルを展開して --config フラグを検討した後に、ビルドツールが検出するような文字列形式で未解析のコマンドラインフラグが含まれます。

UnstructuredCommandLine イベントを使用すると、特定のコマンド実行を正確に再現できます。

WorkspaceConfig

単一の WorkspaceConfig イベントには、実行ルートなど、ワークスペースに関する構成情報が含まれます。

WorkspaceStatus

1 つの WorkspaceStatus イベントには、ワークスペースのステータスコマンドの結果が含まれます。

ビルド イベント プロトコルに関する用語集

中止