빌드 이벤트 프로토콜 용어집

문제 신고 소스 보기

각 BEP 이벤트 유형에는 자체 시맨틱이 있으며 최소한 build_event_stream.proto에 문서화됩니다. 다음 용어집에서는 각 이벤트 유형을 설명합니다.

취소됨

다른 이벤트와 달리 Aborted에는 상응하는 ID 유형이 없습니다. Aborted 이벤트가 다른 유형의 이벤트를 대체하기 때문입니다. 이 이벤트는 빌드가 조기에 종료되었으며 빌드가 표시되는 이벤트 ID가 정상적으로 생성되지 않았음을 나타냅니다. Aborted에는 빌드가 완료되지 않은 이유를 설명하는 enum 및 사용자 친화적인 설명이 포함됩니다.

예를 들어 사용자가 Bazel을 중단할 때 빌드가 타겟을 평가하는 경우 Bazel에는 다음과 같은 이벤트가 포함됩니다.

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

ActionExecuted

빌드에서 특정 작업의 실행에 관한 세부정보를 제공합니다. 기본적으로 이 이벤트는 빌드 실패의 근본 원인을 식별할 수 있도록 실패한 작업에 대해서만 BEP에 포함됩니다. 사용자는 모든 ActionExecuted 이벤트를 포함하도록 --build_event_publish_all_actions 플래그를 설정할 수 있습니다.

BuildFinished

명령어가 완료되고 명령어의 종료 코드를 포함한 단일 BuildFinished 이벤트가 전송됩니다. 이 이벤트는 신뢰할 수 있는 성공/실패 정보를 제공합니다.

BuildMetadata

--build_metadata 플래그의 파싱된 콘텐츠를 포함합니다. 이 이벤트는 외부 데이터 (예: 식별자)를 연결하여 Bazel과 다른 도구와의 통합을 지원하기 위해 존재합니다.

BuildMetrics

모든 명령어의 끝에 단일 BuildMetrics 이벤트가 전송되며 여기에는 명령어 실행 중에 빌드 도구의 동작을 수치화하는 데 유용한 카운터/게이지가 포함됩니다. 이러한 측정항목은 실제로 완료된 작업을 나타내며 재사용되는 캐시된 작업은 계산하지 않습니다.

명령어 실행 중에 자바 가비지 컬렉션이 없으면 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

빌드 도구 동작을 이해하거나 디버깅하는 데 도움이 될 수 있는 빌드 도구에서 생성된 파일의 URI를 포함하여 명령어 끝에 단일 BuildToolLogs 이벤트가 전송됩니다. 일부 정보가 인라인으로 포함될 수 있습니다.

{
  "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 클라이언트에서 수신한 명령줄을 재구성했습니다.
  • "canonical": .rc 파일이 확장되고 호출 정책이 적용된 효과적인 명령줄입니다.
  • "tool": --experimental_tool_command_line 옵션에서 채워집니다. 이는 BEP를 통해 Bazel을 래핑하는 도구의 명령줄을 전달하는 데 유용합니다. 이는 직접 사용되는 base64로 인코딩된 CommandLine 바이너리 프로토콜 버퍼 메시지이거나 파싱되지만 해석되지 않는 문자열일 수 있습니다 (도구 옵션이 Bazel의 옵션과 다를 수 있기 때문).

구성

Configuration 이벤트는 빌드의 최상위 대상에 사용되는 모든 configuration에 대해 전송됩니다. 항상 하나 이상의 구성 이벤트가 존재합니다. idTargetConfiguredTargetComplete 이벤트 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"
      }
    ]
  }
}

가져오기

가져오기 작업이 명령어 실행의 일부로 발생했음을 나타냅니다. 다른 이벤트와 달리, 캐시된 가져오기 결과가 재사용되면 이 이벤트는 BEP 스트림에 표시되지 않습니다.

NamedSetOfFiles

NamedSetOfFiles 이벤트는 명령어 평가 중에 생성된 파일의 depset와 일치하는 구조를 보고합니다. 전이적으로 포함된 depset은 NamedSetOfFilesId에 의해 식별됩니다.

스트림의 NamedSetOfFiles 이벤트 해석에 대한 자세한 내용은 BEP 예시 페이지를 참조하세요.

OptionsParsed

단일 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에는 패턴을 식별하는 PatternExpandedId가 있는 추가 Aborted 이벤트가 포함됩니다.

{
  "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

분석 단계를 완료한 각 타겟의 경우 TargetConfigured 이벤트가 BEP에 포함됩니다. 대상의 '규칙 종류' 속성에 대한 신뢰할 수 있는 소스입니다. 대상에 적용된 구성은 이벤트의 공지된 하위 요소에 표시됩니다.

예를 들어 --experimental_multi_cpu 옵션을 사용하여 빌드하면 구성이 두 개인 단일 타겟에 다음과 같은 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 이벤트가 전송됩니다. BP 소비자가 이러한 측정기준에서 아티팩트를 구별할 수 있도록 테스트당 시도 횟수, 샤드, 실행 횟수가 포함됩니다. FAILED 테스트와 FLAKY 테스트를 구분하기 위해 집계 TestStatus를 생성하는 동안 테스트당 시도 및 실행을 고려합니다.

UnstructuredCommandLine

CommandLine과 달리 이 이벤트는 모든 .bazelrc 파일을 펼치고 --config 플래그를 고려한 후 빌드 도구에서 확인한 것과 같이 파싱되지 않은 명령줄 플래그를 문자열 형식으로 전달합니다.

UnstructuredCommandLine 이벤트를 사용하여 지정된 명령어 실행을 정확하게 재현할 수 있습니다.

WorkspaceConfig

단일 WorkspaceConfig 이벤트에는 실행 루트와 같이 작업공간과 관련된 구성 정보가 포함됩니다.

WorkspaceStatus

단일 WorkspaceStatus 이벤트는 작업공간 상태 명령어의 결과를 포함합니다.