299299 < div class ="pytorch-left-menu-search ">
300300
301301 < div class ="version ">
302- < a href ='https://pytorch.org/docs/versions.html '> main (2.7.0a0+git2f40f78 ) ▼</ a >
302+ < a href ='https://pytorch.org/docs/versions.html '> main (2.7.0a0+git84ba9c6 ) ▼</ a >
303303 </ div >
304304 < div id ="searchBox ">
305305 < div class ="searchbox " id ="googleSearchBox ">
@@ -650,10 +650,14 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
650650< span class ="n "> LOG_ENV_VAR</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_LOGS"</ span >
651651< span class ="n "> LOG_OUT_ENV_VAR</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_LOGS_OUT"</ span >
652652< span class ="n "> LOG_FORMAT_ENV_VAR</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_LOGS_FORMAT"</ span >
653+ < span class ="n "> LOG_TRACE_ID_FILTER</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_LOGS_TRACE_ID_FILTER"</ span >
653654< span class ="n "> TRACE_ENV_VAR</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_TRACE"</ span >
655+ < span class ="n "> DTRACE_ENV_VAR</ span > < span class ="o "> =</ span > < span class ="s2 "> "TORCH_DTRACE"</ span >
654656
655657< span class ="n "> LOG_TRACE_HANDLER</ span > < span class ="p "> :</ span > < span class ="n "> Optional</ span > < span class ="p "> [</ span > < span class ="s2 "> "LazyTraceHandler"</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
656658
659+ < span class ="n "> GET_DTRACE_STRUCTURED</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span >
660+
657661
658662< span class ="nd "> @dataclass</ span >
659663< span class ="k "> class</ span > < span class ="nc "> LogRegistry</ span > < span class ="p "> :</ span >
@@ -1391,9 +1395,12 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
13911395
13921396< span class ="c1 "> # apply custom formats to artifacts when necessary</ span >
13931397< span class ="k "> class</ span > < span class ="nc "> TorchLogsFormatter</ span > < span class ="p "> (</ span > < span class ="n "> logging</ span > < span class ="o "> .</ span > < span class ="n "> Formatter</ span > < span class ="p "> ):</ span >
1394- < span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="o "> *</ span > < span class ="p "> ,</ span > < span class ="n "> trace</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
1398+ < span class ="k "> def</ span > < span class ="fm "> __init__</ span > < span class ="p "> (</ span >
1399+ < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="o "> *</ span > < span class ="p "> ,</ span > < span class ="n "> trace</ span > < span class ="p "> :</ span > < span class ="nb "> bool</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ,</ span > < span class ="n "> trace_id_filter</ span > < span class ="p "> :</ span > < span class ="n "> Optional</ span > < span class ="p "> [</ span > < span class ="nb "> set</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ]]</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span >
1400+ < span class ="p "> ):</ span >
13951401 < span class ="nb "> super</ span > < span class ="p "> ()</ span > < span class ="o "> .</ span > < span class ="fm "> __init__</ span > < span class ="p "> ()</ span >
13961402 < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _is_trace</ span > < span class ="o "> =</ span > < span class ="n "> trace</ span >
1403+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _trace_id_filter</ span > < span class ="o "> =</ span > < span class ="n "> trace_id_filter</ span >
13971404
13981405 < span class ="k "> def</ span > < span class ="nf "> format</ span > < span class ="p "> (</ span > < span class ="bp "> self</ span > < span class ="p "> ,</ span > < span class ="n "> record</ span > < span class ="p "> ):</ span >
13991406 < span class ="n "> artifact_name</ span > < span class ="o "> =</ span > < span class ="nb "> getattr</ span > < span class ="p "> (</ span > < span class ="n "> logging</ span > < span class ="o "> .</ span > < span class ="n "> getLogger</ span > < span class ="p "> (</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> name</ span > < span class ="p "> ),</ span > < span class ="s2 "> "artifact_name"</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span >
@@ -1451,6 +1458,12 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
14511458
14521459 < span class ="n "> filepath</ span > < span class ="o "> =</ span > < span class ="n "> make_module_path_relative</ span > < span class ="p "> (</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> pathname</ span > < span class ="p "> )</ span >
14531460
1461+ < span class ="k "> if</ span > < span class ="p "> (</ span >
1462+ < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _trace_id_filter</ span >
1463+ < span class ="ow "> and</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> traceid</ span > < span class ="o "> .</ span > < span class ="n "> strip</ span > < span class ="p "> ()</ span > < span class ="ow "> not</ span > < span class ="ow "> in</ span > < span class ="bp "> self</ span > < span class ="o "> .</ span > < span class ="n "> _trace_id_filter</ span >
1464+ < span class ="p "> ):</ span >
1465+ < span class ="k "> return</ span > < span class ="s2 "> ""</ span >
1466+
14541467 < span class ="n "> prefix</ span > < span class ="o "> =</ span > < span class ="p "> (</ span >
14551468 < span class ="sa "> f</ span > < span class ="s2 "> "</ span > < span class ="si "> {</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> rankprefix</ span > < span class ="si "> }{</ span > < span class ="n "> shortlevel</ span > < span class ="si "> }{</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> asctime</ span > < span class ="si "> }</ span > < span class ="s2 "> .</ span > < span class ="si "> {</ span > < span class ="nb "> int</ span > < span class ="p "> (</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> msecs</ span > < span class ="w "> </ span > < span class ="o "> *</ span > < span class ="w "> </ span > < span class ="mi "> 1000</ span > < span class ="p "> )</ span > < span class ="si "> :</ span > < span class ="s2 "> 06d</ span > < span class ="si "> }</ span > < span class ="s2 "> </ span > < span class ="si "> {</ span > < span class ="n "> record</ span > < span class ="o "> .</ span > < span class ="n "> process</ span > < span class ="si "> }</ span > < span class ="s2 "> "</ span >
14561469 < span class ="sa "> f</ span > < span class ="s2 "> "</ span > < span class ="si "> {</ span > < span class ="n "> filepath</ span > < span class ="si "> }</ span > < span class ="s2 "> :"</ span >
@@ -1473,8 +1486,13 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
14731486
14741487< span class ="k "> def</ span > < span class ="nf "> _default_formatter</ span > < span class ="p "> ():</ span >
14751488 < span class ="n "> fmt</ span > < span class ="o "> =</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> environ</ span > < span class ="o "> .</ span > < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> LOG_FORMAT_ENV_VAR</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span >
1489+ < span class ="n "> trace_id_filter</ span > < span class ="o "> =</ span > < span class ="p "> {</ span >
1490+ < span class ="n "> item</ span > < span class ="o "> .</ span > < span class ="n "> strip</ span > < span class ="p "> ()</ span >
1491+ < span class ="k "> for</ span > < span class ="n "> item</ span > < span class ="ow "> in</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> environ</ span > < span class ="o "> .</ span > < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> LOG_TRACE_ID_FILTER</ span > < span class ="p "> ,</ span > < span class ="s2 "> ""</ span > < span class ="p "> )</ span > < span class ="o "> .</ span > < span class ="n "> split</ span > < span class ="p "> (</ span > < span class ="s2 "> ","</ span > < span class ="p "> )</ span >
1492+ < span class ="k "> if</ span > < span class ="n "> item</ span > < span class ="o "> .</ span > < span class ="n "> strip</ span > < span class ="p "> ()</ span >
1493+ < span class ="p "> }</ span >
14761494 < span class ="k "> if</ span > < span class ="n "> fmt</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
1477- < span class ="k "> return</ span > < span class ="n "> TorchLogsFormatter</ span > < span class ="p "> ()</ span >
1495+ < span class ="k "> return</ span > < span class ="n "> TorchLogsFormatter</ span > < span class ="p "> (</ span > < span class =" n " > trace_id_filter </ span > < span class =" o " > = </ span > < span class =" n " > trace_id_filter </ span > < span class =" p " > )</ span >
14781496 < span class ="k "> else</ span > < span class ="p "> :</ span >
14791497 < span class ="k "> if</ span > < span class ="n "> fmt</ span > < span class ="ow "> in</ span > < span class ="p "> (</ span > < span class ="s2 "> "short"</ span > < span class ="p "> ,</ span > < span class ="s2 "> "basic"</ span > < span class ="p "> ):</ span >
14801498 < span class ="n "> fmt</ span > < span class ="o "> =</ span > < span class ="n "> logging</ span > < span class ="o "> .</ span > < span class ="n "> BASIC_FORMAT</ span >
@@ -1542,6 +1560,8 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
15421560
15431561
15441562< span class ="k "> def</ span > < span class ="nf "> _init_logs</ span > < span class ="p "> (</ span > < span class ="n "> log_file_name</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
1563+ < span class ="k "> global</ span > < span class ="n "> GET_DTRACE_STRUCTURED</ span >
1564+
15451565 < span class ="n "> _reset_logs</ span > < span class ="p "> ()</ span >
15461566 < span class ="n "> _update_log_state_from_env</ span > < span class ="p "> ()</ span >
15471567
@@ -1588,6 +1608,11 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
15881608 < span class ="c1 "> # Setup handler for the special trace_log, with different default</ span >
15891609 < span class ="c1 "> # configuration</ span >
15901610 < span class ="n "> trace_dir_name</ span > < span class ="o "> =</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> environ</ span > < span class ="o "> .</ span > < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> TRACE_ENV_VAR</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> )</ span >
1611+
1612+ < span class ="k "> if</ span > < span class ="n "> dtrace_dir_name</ span > < span class ="o "> :=</ span > < span class ="n "> os</ span > < span class ="o "> .</ span > < span class ="n "> environ</ span > < span class ="o "> .</ span > < span class ="n "> get</ span > < span class ="p "> (</ span > < span class ="n "> DTRACE_ENV_VAR</ span > < span class ="p "> ,</ span > < span class ="kc "> None</ span > < span class ="p "> ):</ span >
1613+ < span class ="n "> GET_DTRACE_STRUCTURED</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span >
1614+ < span class ="n "> trace_dir_name</ span > < span class ="o "> =</ span > < span class ="n "> dtrace_dir_name</ span >
1615+
15911616 < span class ="c1 "> # This handler may remove itself if trace_dir_name is None and we are not</ span >
15921617 < span class ="c1 "> # actually in an FB environment. This allows us to defer actually</ span >
15931618 < span class ="c1 "> # initializing it until we actually need to log anything. This is</ span >
@@ -1857,9 +1882,6 @@ <h1>Source code for torch._logging._internal</h1><div class="highlight"><pre>
18571882 < span class ="n "> add_structured_logging_overhead</ span > < span class ="p "> (</ span > < span class ="n "> structured_logging_overhead_s</ span > < span class ="p "> )</ span >
18581883
18591884
1860- < span class ="n "> GET_DTRACE_STRUCTURED</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span >
1861-
1862-
18631885< span class ="k "> def</ span > < span class ="nf "> dtrace_structured</ span > < span class ="p "> (</ span >
18641886 < span class ="n "> name</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span >
18651887 < span class ="c1 "> # NB: metadata expected to be dict so adding more info is forward compatible</ span >
0 commit comments