JSON ट्रेस प्रोफ़ाइल

समस्या की शिकायत करें सोर्स देखें

JSON ट्रेस प्रोफ़ाइल से तुरंत यह समझने में मदद मिल सकती है कि Bazel ने कॉल करने के दौरान क्या समय बिताया था.

डिफ़ॉल्ट रूप से, बिल्ड जैसे सभी निर्देशों और क्वेरी के लिए, Bazel command.profile.gz पर ऐसी प्रोफ़ाइल लिखता है. आपके पास यह कॉन्फ़िगर करने का विकल्प है कि प्रोफ़ाइल को --generate_json_trace_profile फ़्लैग के साथ लिखा गया है या नहीं. साथ ही, यह भी कॉन्फ़िगर किया जा सकता है कि --profile फ़्लैग के साथ इसे किस जगह पर लिखा गया है. .gz पर खत्म होने वाली जगहों को GZIP के साथ कंप्रेस किया जाता है. इस फ़ाइल का पाथ प्रिंट करने के लिए, फ़्लैग --experimental_announce_profile_path का इस्तेमाल करें.

टूल

इस प्रोफ़ाइल को chrome://tracing में लोड किया जा सकता है. इसके अलावा, दूसरे टूल की मदद से इसका विश्लेषण करके, इसे प्रोसेस करने के बाद भी ऐसा किया जा सकता है.

chrome://tracing

प्रोफ़ाइल देखने के लिए, Chrome ब्राउज़र टैब में chrome://tracing खोलें. "लोड करें" पर क्लिक करें और (संभावित रूप से कंप्रेस की गई) प्रोफ़ाइल फ़ाइल चुनें. ज़्यादा जानकारी वाले नतीजों के लिए, नीचे बाएं कोने में मौजूद बॉक्स पर क्लिक करें.

प्रोफ़ाइल का उदाहरण:

प्रोफ़ाइल का उदाहरण

पहला डायग्राम. प्रोफ़ाइल का उदाहरण.

नेविगेट करने के लिए, इन कीबोर्ड कंट्रोल का इस्तेमाल किया जा सकता है:

  • "चुनें" मोड के लिए 1 दबाएं. इस मोड में, इवेंट की जानकारी की जांच करने के लिए खास बॉक्स चुने जा सकते हैं (नीचे बायां कोना देखें). खास जानकारी और एग्रीगेट किए गए आंकड़े पाने के लिए एक से ज़्यादा इवेंट चुनें.
  • "पैन" मोड के लिए 2 दबाएं. फिर व्यू को एक जगह से दूसरी जगह ले जाने के लिए, माउस को खींचें और छोड़ें. बाईं/दाईं ओर ले जाने के लिए, a/d का भी इस्तेमाल किया जा सकता है.
  • "ज़ूम" मोड इस्तेमाल करने के लिए, 3 दबाएं. फिर ज़ूम करने के लिए माउस को खींचें. ज़ूम इन/आउट करने के लिए, w/s का भी इस्तेमाल किया जा सकता है.
  • "समय" मोड के लिए 4 दबाएं, जहां आप दो इवेंट के बीच दूरी को माप सकते हैं.
  • सभी कंट्रोल के बारे में जानने के लिए, ? दबाएं.

bazel analyze-profile

Bazel सबकमांड analyze-profile, प्रोफ़ाइल फ़ॉर्मैट का इस्तेमाल करता है. साथ ही, बिल्ड के हर चरण के लिए, अलग-अलग तरह के टास्क से जुड़े कुल आंकड़े प्रिंट करता है. साथ ही, अहम पाथ का विश्लेषण भी करता है.

उदाहरण के लिए, कमांड

$ bazel build --profile=/tmp/profile.gz //path/to:target
...
$ bazel analyze-profile /tmp/profile.gz

इस फ़ॉर्म का आउटपुट मिल सकता है:

INFO: Profile created on Tue Jun 16 08:59:40 CEST 2020, build ID: 0589419c-738b-4676-a374-18f7bbc7ac23, output base: /home/johndoe/.cache/bazel/_bazel_johndoe/d8eb7a85967b22409442664d380222c0

=== PHASE SUMMARY INFORMATION ===

Total launch phase time         1.070 s   12.95%
Total init phase time           0.299 s    3.62%
Total loading phase time        0.878 s   10.64%
Total analysis phase time       1.319 s   15.98%
Total preparation phase time    0.047 s    0.57%
Total execution phase time      4.629 s   56.05%
Total finish phase time         0.014 s    0.18%
------------------------------------------------
Total run time                  8.260 s  100.00%

Critical path (4.245 s):
       Time Percentage   Description
    8.85 ms    0.21%   _Ccompiler_Udeps for @local_config_cc// compiler_deps
    3.839 s   90.44%   action 'Compiling external/com_google_protobuf/src/google/protobuf/compiler/php/php_generator.cc [for host]'
     270 ms    6.36%   action 'Linking external/com_google_protobuf/protoc [for host]'
    0.25 ms    0.01%   runfiles for @com_google_protobuf// protoc
     126 ms    2.97%   action 'ProtoCompile external/com_google_protobuf/python/google/protobuf/compiler/plugin_pb2.py'
    0.96 ms    0.02%   runfiles for //tools/aquery_differ aquery_differ

Bazel इन्वोकेशन ऐनालाइज़र

ओपन सोर्स Bazel Invocation Analyzer टूल में एक प्रोफ़ाइल फ़ॉर्मैट इस्तेमाल किया जाता है. साथ ही, यह बिल्ड की परफ़ॉर्मेंस को बेहतर बनाने के सुझावों को प्रिंट भी करता है. यह विश्लेषण इसके सीएलआई का इस्तेमाल करके या https://analyzer.engflow.com पर किया जा सकता है.

jq

JSON डेटा के लिए, jq, sed जैसा होता है. लोकल ऐक्शन एक्ज़ीक्यूशन में, सैंडबॉक्स बनाने की पूरी अवधि को एक्सट्रैक्ट करने के लिए, jq के इस्तेमाल का उदाहरण:

$ zcat $(../bazel-6.0.0rc1-linux-x86_64 info output_base)/command.profile.gz | jq '.traceEvents | .[] | select(.name == "sandbox.createFileSystem") | .dur'
6378
7247
11850
13756
6555
7445
8487
15520
[...]

प्रोफ़ाइल की जानकारी

प्रोफ़ाइल में कई पंक्तियां हैं. आम तौर पर, ज़्यादातर पंक्तियां Bazel थ्रेड और उनसे जुड़े इवेंट को दिखाती हैं, लेकिन कुछ खास पंक्तियां भी शामिल की जाती हैं.

प्रोफ़ाइल बनाते समय, Bazel के लागू किए गए वर्शन के हिसाब से खास लाइनें शामिल होती हैं. इन लाइनों को अलग-अलग फ़्लैग की मदद से, पसंद के मुताबिक बनाया जा सकता है.

पहली इमेज में एक प्रोफ़ाइल दिखाई गई है, जिसे Bazel v5.3.1 का इस्तेमाल करके बनाया गया है. इसमें ये पंक्तियां शामिल हैं:

  • action count: दिखाता है कि फ़्लाइट में एक साथ कितनी कार्रवाइयां की गई थीं. वास्तविक मान देखने के लिए उस पर क्लिक करें. क्लीन बिल्ड में --jobs की वैल्यू तक जाना चाहिए.
  • CPU usage (Bazel): बिल्ड के हर सेकंड के लिए, यह दिखाता है कि Bazel के लिए कितने सीपीयू (CPU) इस्तेमाल किए गए थे. एक कोर की वैल्यू 100% व्यस्त होने का मतलब है.
  • Critical Path: ज़रूरी पाथ पर हर कार्रवाई के लिए एक ब्लॉक दिखाता है.
  • Main Thread: Bazel का मुख्य थ्रेड. इससे यह बेहतर तरीके से समझा जा सकता है कि बैज़ल क्या कर रहा है. उदाहरण के लिए, "Launch Blaze", "evaluateTargetPatterns", और "runAnalysisFace".
  • Garbage Collector: इसमें, कूड़ा इकट्ठा करने की छोटी और बड़ी पाबंदियां दिखाई जाती हैं.

परफ़ॉर्मेंस से जुड़ी सामान्य समस्याएं

परफ़ॉर्मेंस प्रोफ़ाइलों का विश्लेषण करते समय, इन चीज़ों पर ध्यान दें:

  • विश्लेषण का धीमा चरण (runAnalysisPhase), खास तौर पर इंंक्रीमेंटल बिल्ड में होता है. यह किसी नियम को लागू करने में गड़बड़ी का संकेत हो सकता है. उदाहरण के लिए, ऐसा नियम जो जानकारी को फ़्लैट करता है. ज़्यादा टारगेट, जटिल मैक्रो या बार-बार इस्तेमाल होने वाले ग्लॉब की वजह से, पैकेज लोड होने की स्पीड धीमी हो सकती है.
  • धीमी कार्रवाइयां, खास तौर पर ज़रूरी पाथ पर होने वाली धीमी कार्रवाइयां. बड़ी कार्रवाइयों को कई छोटी-छोटी कार्रवाइयों में बांटा जा सकता है. इसके अलावा, उनकी रफ़्तार बढ़ाने के लिए, उनकी डिपेंडेंसी कम की जा सकती है. साथ ही, सामान्य तौर पर बहुत ज़्यादा ज़्यादा नॉन-PROCESS_TIME (जैसे कि REMOTE_SETUP या FETCH) की जांच करें.
  • बॉटलनेक, यानी कि कुछ थ्रेड व्यस्त हैं, जबकि अन्य सभी निष्क्रिय / परिणाम की इंतज़ार कर रहे हैं (इमेज 1 में 22 और 29 सेकंड के आस-पास देखें). इसे ऑप्टिमाइज़ करने के लिए नियम लागू करने की प्रक्रिया को छूना होगा या Bazel को एक जैसा अनुभव देना होगा. ऐसा तब भी हो सकता है, जब जीसी की संख्या असामान्य हो.

प्रोफ़ाइल फ़ाइल का फ़ॉर्मैट

टॉप लेवल ऑब्जेक्ट में मेटाडेटा (otherData) और ट्रेस करने वाला असल डेटा (traceEvents) शामिल है. मेटाडेटा में ज़्यादा जानकारी शामिल है, जैसे कि शुरू करने का आईडी और Bazel को शुरू करने की तारीख.

उदाहरण:

{
  "otherData": {
    "build_id": "101bff9a-7243-4c1a-8503-9dc6ae4c3b05",
    "date": "Wed Oct 26 08:22:35 CEST 2022",
    "profile_finish_ts": "1677666095162000",
    "output_base": "/usr/local/google/_bazel_johndoe/573d4be77eaa72b91a3dfaa497bf8cd0"
  },
  "traceEvents": [
    {"name":"thread_name","ph":"M","pid":1,"tid":0,"args":{"name":"Critical Path"}},
    ...
    {"cat":"build phase marker","name":"Launch Blaze","ph":"X","ts":-1306000,"dur":1306000,"pid":1,"tid":21},
    ...
    {"cat":"package creation","name":"foo","ph":"X","ts":2685358,"dur":784,"pid":1,"tid":246},
    ...
    {"name":"thread_name","ph":"M","pid":1,"tid":11,"args":{"name":"Garbage Collector"}},
    {"cat":"gc notification","name":"minor GC","ph":"X","ts":825986,"dur":11000,"pid":1,"tid":11},
    ...
    {"cat":"action processing","name":"Compiling foo/bar.c","ph":"X","ts":54413389,"dur":357594,"pid":1,"args":{"mnemonic":"CppCompile"},"tid":341},
 ]
}

ट्रेस इवेंट में टाइमस्टैंप (ts) और कुल समय (dur) माइक्रोसेकंड में दिए जाते हैं. कैटगरी (cat), ProfilerTask की Enum वैल्यू में से एक है. ध्यान दें कि अगर कुछ इवेंट बहुत छोटे हैं और एक-दूसरे के करीब हैं, तो उन्हें एक साथ मर्ज कर दिया जाता है. अगर आपको इवेंट मर्ज होने से रोकना है, तो --noslim_json_profile को पास करें.

Chrome ट्रेस इवेंट फ़ॉर्मैट की खास बातें भी देखें.