bazelbuild/bazel

Documentation issue: Debugging remote cache hits for remote execution

Open

#12,770 opened on Jan 4, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,465 forks)batch import
P3help wantedteam-Documentationteam-Remote-Exectype: documentation (cleanup)

Repository metrics

Stars
 (25,384 stars)
PR merge metrics
 (Avg merge 22d 20h) (77 merged PRs in 30d)

Description

Documentation URL: https://docs.bazel.build/versions/master/remote-execution-caching-debug.html

This piece of documentation still references the old flag --execution_log_binary_file which requires additional steps to build a parser in the Bazel source tree and convert the binary files into a human readable format. Is there a reason why this guide does not reference the new flag --execution_log_json_file which produces human readable JSON output right away? An additional benefit to JSON output would be that it is easier to manipulate with tools like jq.

Contributor guide

Research direction
Update the documentation page to reference execution log json file instead of execution log binary file. Verify the new flag's availability and describe its benefits (e.g., human readable JSON, easier manipulation with jq).
Tech stack
None
Domain
documentationdevops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90