Files
sglang/scripts/convert_otel_2_perfetto.py

376 lines
12 KiB
Python

import argparse
import bisect
import json
import time
from collections import defaultdict
from pathlib import Path
from typing import Any, Dict, Iterable, List, Tuple
parser = argparse.ArgumentParser(
description="Convert SGLang OTEL trace files to Perfetto format.",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
)
parser.add_argument(
"-i",
"--input",
dest="input_file",
required=True,
type=str,
help="Path to the input OTEL trace file (JSON or JSONL format).",
)
parser.add_argument(
"-o",
"--output",
dest="output_file",
type=str,
default="sglang_trace_perfetto.json",
help="Path to the output Perfetto JSON file.",
)
parser.add_argument(
"-f", "--torch-file", dest="torch_file", help="specify torch profile file"
)
args = parser.parse_args()
perfetto_data = None
if args.torch_file:
with open(args.torch_file, "r", encoding="utf-8") as file:
perfetto_data = json.load(file)
baseline = perfetto_data["baseTimeNanoseconds"]
else:
baseline = 0
def id_generator():
i = 0
while True:
yield i
i += 1
relation_id_gen = id_generator()
class SpanLayoutContainer:
def __init__(self):
self.intervals = []
def check_overlap(self, start, end):
idx = bisect.bisect_left(self.intervals, (start, float("-inf")))
if idx > 0:
prev_start, prev_end = self.intervals[idx - 1]
if prev_end > start:
return True
if idx < len(self.intervals):
next_start, next_end = self.intervals[idx]
if next_start < end:
return True
return False
def insert_span(self, start, end):
bisect.insort_left(self.intervals, (start, end))
def new_metadata_level1(name: str, pid):
return {
"name": "process_name",
"ph": "M",
"pid": pid,
"args": {"name": name},
}
def new_metadata_level2(name: str, pid, slot_seq):
return {
"name": "thread_name",
"ph": "M",
"pid": pid,
"tid": slot_seq,
"args": {"name": name},
}
def __find_line(graph, trans_graph_status, slot_meta_data, pid, start, end):
if pid in trans_graph_status:
line = trans_graph_status[pid]
if start == end:
return line
# check conflict
if not graph[pid][line].check_overlap(start, end):
return line
if pid not in graph:
line = 1
graph[pid] = {line: SpanLayoutContainer()}
trans_graph_status[pid] = line
slot_meta_data.append(new_metadata_level2("slot", pid, line))
return line
for line in graph[pid]:
if not graph[pid][line].check_overlap(start, end):
trans_graph_status[pid] = line
return line
new_line = len(graph[pid]) + 1
graph[pid][new_line] = SpanLayoutContainer()
trans_graph_status[pid] = new_line
slot_meta_data.append(new_metadata_level2("slot", pid, new_line))
return new_line
OtelSpan = Dict[str, Any]
def load_otel_data(path: str | Path):
p = Path(path)
with p.open("rt", encoding="utf-8") as f:
first = f.read(1)
f.seek(0)
if first == "[":
data = json.load(f) # JSON array
else:
data = [json.loads(line) for line in f if line.strip()] # JSONL
return data
def extract_all_otel_spans(otel_data):
otel_spans = []
for line_data in otel_data:
for resource_spans in line_data["resourceSpans"]:
for scope_spans in resource_spans["scopeSpans"]:
for span in scope_spans["spans"]:
if "attributes" in span:
attributes_dict = {
attr.get("key"): next(
iter(attr.get("value", {}).values()), None
)
for attr in span["attributes"]
}
span["attributes"] = attributes_dict
else:
span["attributes"] = {}
otel_spans.append(span)
return otel_spans
def build_otel_span_tree(otel_spans):
span_id_map = {span["spanId"]: span for span in otel_spans}
for span in otel_spans:
span["child"] = []
bootstrap_room_spans = []
for span in otel_spans:
span_id = span["spanId"]
parent_span_id = span.get("parentSpanId", "")
if parent_span_id == "":
# check if root span is a request span
attrs = span.get("attributes", {})
bootstrap_room_spans.append(span)
elif parent_span_id in span_id_map:
parent_span = span_id_map[parent_span_id]
parent_span["child"].append(span)
link_spans = []
if "links" in span:
for link in span["links"]:
link_span = span_id_map.get(link["spanId"])
if link_span:
link_spans.append(link_span)
span["links"] = link_spans
return bootstrap_room_spans
def generate_perfetto_span(otel_bootstrap_room_spans, thread_meta_data):
for bootstrap_room_span in otel_bootstrap_room_spans:
bootstrap_room = bootstrap_room_span["attributes"]["bootstrap_room"]
bootstrap_room_span["spans"] = []
for node_req_span in bootstrap_room_span["child"]:
rid = node_req_span["attributes"]["rid"]
for thread_span in node_req_span["child"]:
pid = int(thread_span["attributes"]["pid"])
thread_name = f'{thread_span["attributes"]["host_id"][:8]}:{thread_span["attributes"]["thread_label"]}'
if "tp_rank" in thread_span["attributes"]:
thread_name += f"-TP{thread_span['attributes']['tp_rank']}"
if pid not in thread_meta_data:
thread_meta_data[pid] = new_metadata_level1(thread_name, pid)
for span in thread_span["child"]:
span["attributes"]["bootstrap_room"] = bootstrap_room
span["attributes"]["rid"] = rid
span["host_id"] = thread_span["attributes"]["host_id"]
span["pid"] = pid
span["startTimeUnixNano"] = int(span["startTimeUnixNano"])
span["endTimeUnixNano"] = int(span["endTimeUnixNano"])
ts = span["startTimeUnixNano"]
dur = span["endTimeUnixNano"] - ts
perfetto_span = {
"ph": "X",
"name": span.get("name", "unknown"),
"cat": "sglang",
"ts": (ts - baseline) / 1000.0,
"dur": (dur - 1000) / 1000.0,
"pid": pid,
"tid": 0,
"args": span["attributes"],
}
span["perfetto_span"] = perfetto_span
bootstrap_room_span["spans"].append(span)
def generate_perfetto_span_layout(otel_bootstrap_room_spans, slot_meta_data):
for bootstrap_room_span in otel_bootstrap_room_spans:
bootstrap_room_span["spans"] = sorted(
bootstrap_room_span["spans"], key=lambda x: int(x["startTimeUnixNano"])
)
otel_bootstrap_room_spans = sorted(
otel_bootstrap_room_spans, key=lambda x: int(x["spans"][0]["startTimeUnixNano"])
)
graph = {}
for bootstrap_room_span in otel_bootstrap_room_spans:
req_thread_status = {}
for span in bootstrap_room_span["spans"]:
line = __find_line(
graph,
req_thread_status,
slot_meta_data,
span["perfetto_span"]["pid"],
span["startTimeUnixNano"],
span["endTimeUnixNano"],
)
graph[span["perfetto_span"]["pid"]][line].insert_span(
span["startTimeUnixNano"], span["endTimeUnixNano"]
)
span["perfetto_span"]["tid"] = line
def generate_perfetto_events(otel_bootstrap_room_spans):
for bootstrap_room_span in otel_bootstrap_room_spans:
for span in bootstrap_room_span["spans"]:
span["perfetto_events"] = []
if "events" in span:
for event in span["events"]:
attributes_dict = {
attr.get("key"): next(
iter(attr.get("value", {}).values()), None
)
for attr in event["attributes"]
}
perfetto_event = {
"ph": "i",
"cat": "sglang",
"ts": (int(event["timeUnixNano"]) - baseline) / 1000.0,
"pid": span["perfetto_span"]["pid"],
"tid": span["perfetto_span"]["tid"],
"name": event.get("name", "unknown"),
"args": attributes_dict,
}
span["perfetto_events"].append(perfetto_event)
def generate_perfetto_links(otel_bootstrap_room_spans):
for bootstrap_room_span in otel_bootstrap_room_spans:
for span in bootstrap_room_span["spans"]:
span["perfetto_links"] = []
if "links" in span:
for link_span in span["links"]:
if "correlation" in link_span["perfetto_span"]["args"]:
id = link_span["perfetto_span"]["args"]["correlation"]
else:
id = next(relation_id_gen)
link_span["perfetto_span"]["args"]["correlation"] = id
perfetto_start_node = {
"ph": "s",
"id": id,
"pid": link_span["perfetto_span"]["pid"],
"tid": link_span["perfetto_span"]["tid"],
"ts": link_span["perfetto_span"]["ts"],
"cat": "ac2g",
"name": "ac2g",
}
perfetto_end_node = {
"ph": "f",
"id": id,
"pid": span["perfetto_span"]["pid"],
"tid": span["perfetto_span"]["tid"],
"ts": span["perfetto_span"]["ts"],
"cat": "ac2g",
"name": "ac2g",
"bp": "e",
}
span["perfetto_links"].append(perfetto_start_node)
span["perfetto_links"].append(perfetto_end_node)
def gather_all_perfetto_elems(
otel_bootstrap_room_spans, thread_meta_data, slot_meta_data
):
elems = []
elems.extend(thread_meta_data.values())
elems.extend(slot_meta_data)
for bootstrap_room_span in otel_bootstrap_room_spans:
for span in bootstrap_room_span["spans"]:
elems.append(span["perfetto_span"])
elems.extend(span["perfetto_events"])
elems.extend(span["perfetto_links"])
return elems
def write_json(perfetto_elems):
global perfetto_data
if args.torch_file:
perfetto_data["traceEvents"].extend(perfetto_elems)
filered_data = [
item
for item in perfetto_data["traceEvents"]
if item.get("cat") != "gpu_user_annotation"
]
perfetto_data["traceEvents"] = filered_data
else:
perfetto_data = perfetto_elems
with open(args.output_file, "w", encoding="utf-8") as file:
json.dump(perfetto_data, file, ensure_ascii=False, indent=4)
def main():
start_time = time.time()
otel_data = load_otel_data(args.input_file)
otel_spans = extract_all_otel_spans(otel_data)
otel_bootstrap_room_spans = build_otel_span_tree(otel_spans)
thread_meta_data = {}
generate_perfetto_span(otel_bootstrap_room_spans, thread_meta_data)
slot_meta_data = []
generate_perfetto_span_layout(otel_bootstrap_room_spans, slot_meta_data)
generate_perfetto_events(otel_bootstrap_room_spans)
generate_perfetto_links(otel_bootstrap_room_spans)
perfetto_elems = gather_all_perfetto_elems(
otel_bootstrap_room_spans, thread_meta_data, slot_meta_data
)
write_json(perfetto_elems)
end_time = time.time()
execution_time = end_time - start_time
print(f"\nConversion finished successfully!")
print(f"Output written to: {args.output_file}")
print(f"Execution time: {execution_time * 1000:.4f} ms")
if __name__ == "__main__":
main()