fxprofiler 0.1.0__py3-none-any.whl

fxprofiler/__init__.py

@@ -0,0 +1,30 @@
+from fxprofiler.category import Category, CategoryColor
+from fxprofiler.marker import Marker, MarkerTiming
+from fxprofiler.marker_schema import (
+    MarkerFormat,
+    MarkerGraph,
+    MarkerGraphType,
+    MarkerLocation,
+    PIICategory,
+    marker_field,
+)
+from fxprofiler.profile import Profile
+from fxprofiler.thread import Thread
+from fxprofiler.viewer import ProfileServer, show
+
+__all__ = [
+    "Category",
+    "CategoryColor",
+    "Marker",
+    "MarkerTiming",
+    "MarkerFormat",
+    "MarkerGraph",
+    "MarkerGraphType",
+    "MarkerLocation",
+    "PIICategory",
+    "marker_field",
+    "Profile",
+    "Thread",
+    "ProfileServer",
+    "show",
+]

fxprofiler/category.py

@@ -0,0 +1,68 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum
+
+
+class CategoryColor(str, Enum):
+    TRANSPARENT = "transparent"
+    LIGHTBLUE = "lightblue"
+    RED = "red"
+    ORANGE = "orange"
+    BLUE = "blue"
+    GREEN = "green"
+    PURPLE = "purple"
+    YELLOW = "yellow"
+    MAGENTA = "magenta"
+    GREY = "grey"
+    DARKGREY = "darkgrey"
+    INK = "ink"
+    TEAL = "teal"
+
+
+@dataclass(frozen=True)
+class Category:
+    name: str
+    color: CategoryColor
+    subcategories: tuple[str, ...] = ("Other",)
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "subcategories", tuple(self.subcategories))
+
+
+DEFAULT_CATEGORIES: list[Category] = [
+    Category("Other", CategoryColor.GREY),
+    Category("Idle", CategoryColor.TRANSPARENT),
+    Category("Layout", CategoryColor.PURPLE),
+    Category("JavaScript", CategoryColor.YELLOW),
+    Category("GC / CC", CategoryColor.ORANGE),
+    Category("Network", CategoryColor.LIGHTBLUE),
+    Category("Graphics", CategoryColor.GREEN),
+    Category("DOM", CategoryColor.BLUE),
+]
+
+
+class CategoryRegistry:
+    def __init__(self) -> None:
+        self._categories: list[Category] = []
+        self._index_by_key: dict[tuple[str, CategoryColor], int] = {}
+
+    def index_for_category(self, category: Category) -> int:
+        key = (category.name, category.color)
+        index = self._index_by_key.get(key)
+        if index is not None:
+            return index
+        index = len(self._categories)
+        self._categories.append(category)
+        self._index_by_key[key] = index
+        return index
+
+    def to_list(self) -> list[dict]:
+        return [
+            {
+                "name": category.name,
+                "color": category.color.value,
+                "subcategories": list(category.subcategories),
+            }
+            for category in self._categories
+        ]

fxprofiler/marker.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+import dataclasses
+from dataclasses import dataclass
+from enum import IntEnum
+from typing import ClassVar
+
+from fxprofiler.category import Category
+from fxprofiler.marker_schema import _FIELD_METADATA_KEY, MarkerGraph, MarkerLocation
+
+
+class MarkerPhase(IntEnum):
+    INSTANT = 0
+    INTERVAL = 1
+    INTERVAL_START = 2
+    INTERVAL_END = 3
+
+
+@dataclass(frozen=True)
+class MarkerTiming:
+    phase: MarkerPhase
+    start: float | None
+    end: float | None
+
+    @classmethod
+    def instant(cls, time: float) -> "MarkerTiming":
+        return cls(MarkerPhase.INSTANT, time, None)
+
+    @classmethod
+    def interval(cls, start: float, end: float) -> "MarkerTiming":
+        return cls(MarkerPhase.INTERVAL, start, end)
+
+    @classmethod
+    def interval_start(cls, time: float) -> "MarkerTiming":
+        return cls(MarkerPhase.INTERVAL_START, time, None)
+
+    @classmethod
+    def interval_end(cls, time: float) -> "MarkerTiming":
+        return cls(MarkerPhase.INTERVAL_END, None, time)
+
+
+@dataclass
+class Marker:
+    type_name: ClassVar[str]
+    category: ClassVar[Category | None] = None
+    locations: ClassVar[tuple[MarkerLocation, ...]] = (
+        MarkerLocation.MARKER_CHART,
+        MarkerLocation.MARKER_TABLE,
+    )
+    chart_label: ClassVar[str | None] = None
+    tooltip_label: ClassVar[str | None] = None
+    table_label: ClassVar[str | None] = None
+    description: ClassVar[str | None] = None
+    graphs: ClassVar[tuple[MarkerGraph, ...]] = ()
+
+    def field_values(self) -> dict:
+        values = {}
+        for field in dataclasses.fields(self):
+            if _FIELD_METADATA_KEY in field.metadata:
+                values[field.name] = getattr(self, field.name)
+        return values

fxprofiler/marker_schema.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum
+
+from fxprofiler.category import CategoryColor
+
+_FIELD_METADATA_KEY = "fxprofiler.marker_field"
+
+
+class MarkerFormat(str, Enum):
+    URL = "url"
+    FILE_PATH = "file-path"
+    SANITIZED_STRING = "sanitized-string"
+    STRING = "string"
+    UNIQUE_STRING = "unique-string"
+    FLOW_ID = "flow-id"
+    TERMINATING_FLOW_ID = "terminating-flow-id"
+    DURATION = "duration"
+    TIME = "time"
+    SECONDS = "seconds"
+    MILLISECONDS = "milliseconds"
+    MICROSECONDS = "microseconds"
+    NANOSECONDS = "nanoseconds"
+    BYTES = "bytes"
+    PERCENTAGE = "percentage"
+    INTEGER = "integer"
+    DECIMAL = "decimal"
+    HEXADECIMAL = "hexadecimal"
+    PID = "pid"
+    TID = "tid"
+    LIST = "list"
+
+
+class MarkerLocation(str, Enum):
+    MARKER_CHART = "marker-chart"
+    MARKER_TABLE = "marker-table"
+    TIMELINE_OVERVIEW = "timeline-overview"
+    TIMELINE_MEMORY = "timeline-memory"
+    TIMELINE_IPC = "timeline-ipc"
+    TIMELINE_FILEIO = "timeline-fileio"
+    TIMELINE_NETWORK = "timeline-network"
+    TIMELINE_SCREENSHOTS = "timeline-screenshots"
+
+
+class MarkerGraphType(str, Enum):
+    BAR = "bar"
+    LINE = "line"
+    LINE_FILLED = "line-filled"
+
+
+class PIICategory(str, Enum):
+    URL = "url"
+    EXTENSION_ID = "extension-id"
+    PREFERENCE_VALUE = "preference-value"
+    PRIVATE_BROWSING = "private-browsing"
+
+
+@dataclass(frozen=True)
+class MarkerGraph:
+    key: str
+    type: MarkerGraphType
+    color: CategoryColor | None = None
+
+    def to_dict(self) -> dict:
+        result: dict = {"key": self.key, "type": self.type.value}
+        if self.color is not None:
+            result["color"] = self.color.value
+        return result
+
+
+def marker_field(
+    *,
+    label: str,
+    format: MarkerFormat,
+    hidden: bool = False,
+    contains_pii: list[PIICategory] | None = None,
+    default=None,
+):
+    """Declare a dataclass field on a Marker subclass that is also a schema field."""
+    import dataclasses
+
+    metadata = {
+        _FIELD_METADATA_KEY: {
+            "label": label,
+            "format": format,
+            "hidden": hidden,
+            "contains_pii": tuple(contains_pii) if contains_pii else (),
+        }
+    }
+    if default is None:
+        return dataclasses.field(metadata=metadata)
+    return dataclasses.field(default=default, metadata=metadata)
+
+
+@dataclass(frozen=True)
+class MarkerSchemaField:
+    key: str
+    label: str
+    format: MarkerFormat
+    hidden: bool = False
+    contains_pii: tuple[PIICategory, ...] = ()
+
+    def to_dict(self) -> dict:
+        result: dict = {
+            "key": self.key,
+            "label": self.label,
+            "format": self.format.value,
+        }
+        if self.hidden:
+            result["hidden"] = True
+        if self.contains_pii:
+            result["containsPII"] = [category.value for category in self.contains_pii]
+        return result
+
+
+@dataclass(frozen=True)
+class MarkerSchema:
+    type_name: str
+    locations: tuple[MarkerLocation, ...]
+    fields: tuple[MarkerSchemaField, ...]
+    chart_label: str | None = None
+    tooltip_label: str | None = None
+    table_label: str | None = None
+    description: str | None = None
+    graphs: tuple[MarkerGraph, ...] = ()
+
+    def to_dict(self) -> dict:
+        result: dict = {
+            "name": self.type_name,
+            "display": [location.value for location in self.locations],
+            "fields": [field.to_dict() for field in self.fields],
+        }
+        if self.chart_label is not None:
+            result["chartLabel"] = self.chart_label
+        if self.tooltip_label is not None:
+            result["tooltipLabel"] = self.tooltip_label
+        if self.table_label is not None:
+            result["tableLabel"] = self.table_label
+        if self.description is not None:
+            result["description"] = self.description
+        if self.graphs:
+            result["graphs"] = [graph.to_dict() for graph in self.graphs]
+        return result
+
+
+def schema_from_marker_class(marker_class: type) -> MarkerSchema:
+    import dataclasses
+
+    fields: list[MarkerSchemaField] = []
+    for dataclass_field in dataclasses.fields(marker_class):
+        info = dataclass_field.metadata.get(_FIELD_METADATA_KEY)
+        if info is None:
+            continue
+        fields.append(
+            MarkerSchemaField(
+                key=dataclass_field.name,
+                label=info["label"],
+                format=info["format"],
+                hidden=info["hidden"],
+                contains_pii=info["contains_pii"],
+            )
+        )
+
+    return MarkerSchema(
+        type_name=marker_class.type_name,
+        locations=tuple(
+            getattr(
+                marker_class,
+                "locations",
+                (MarkerLocation.MARKER_CHART, MarkerLocation.MARKER_TABLE),
+            )
+        ),
+        fields=tuple(fields),
+        chart_label=getattr(marker_class, "chart_label", None),
+        tooltip_label=getattr(marker_class, "tooltip_label", None),
+        table_label=getattr(marker_class, "table_label", None),
+        description=getattr(marker_class, "description", None),
+        graphs=tuple(getattr(marker_class, "graphs", ())),
+    )

fxprofiler/profile.py

@@ -0,0 +1,229 @@
+from __future__ import annotations
+
+import contextlib
+import json
+import os
+import threading
+import time
+
+from fxprofiler.category import DEFAULT_CATEGORIES, Category, CategoryRegistry
+from fxprofiler.marker import Marker, MarkerTiming
+from fxprofiler.marker_schema import (
+    MarkerFormat,
+    MarkerSchema,
+    schema_from_marker_class,
+)
+from fxprofiler.strings import StringTable
+from fxprofiler.thread import Thread, _MarkerRow
+
+GECKO_PROFILE_VERSION = 24
+PREPROCESSED_PROFILE_VERSION = 75
+
+_UNIQUE_STRING_FORMATS = {MarkerFormat.UNIQUE_STRING}
+_FLOW_FORMATS = {MarkerFormat.FLOW_ID, MarkerFormat.TERMINATING_FLOW_ID}
+
+
+def _empty_table(columns: list[str]) -> dict:
+    table = {column: [] for column in columns}
+    table["length"] = 0
+    return table
+
+
+class Profile:
+    def __init__(
+        self, product: str, start_time_ms_since_epoch: float, interval_ms: float = 1.0
+    ) -> None:
+        self.product = product
+        self.start_time = start_time_ms_since_epoch
+        self.interval = interval_ms
+        self.strings = StringTable()
+        self.categories = CategoryRegistry()
+        for category in DEFAULT_CATEGORIES:
+            self.categories.index_for_category(category)
+        self._schemas_by_type_name: dict[str, MarkerSchema] = {}
+        self.threads: list[Thread] = []
+        self._clock_anchor = time.perf_counter()
+
+    def now_ms(self) -> float:
+        """Milliseconds elapsed since this Profile was constructed, measured with a
+        monotonic clock so it is safe to use for marker timing.
+        """
+        return (time.perf_counter() - self._clock_anchor) * 1000.0
+
+    def add_thread(
+        self,
+        name: str,
+        pid: int | str | None = None,
+        tid: int | str | None = None,
+        start_time: float = 0.0,
+        end_time: float | None = None,
+        is_main: bool = False,
+    ) -> Thread:
+        """pid/tid default to the current process id and the calling thread's id."""
+        thread = Thread(
+            name=name,
+            pid=str(pid if pid is not None else os.getpid()),
+            tid=str(tid if tid is not None else threading.get_ident()),
+            start_time=start_time,
+            end_time=end_time,
+            is_main=is_main,
+        )
+        self.threads.append(thread)
+        return thread
+
+    @contextlib.contextmanager
+    def thread(
+        self,
+        name: str,
+        pid: int | str | None = None,
+        tid: int | str | None = None,
+        is_main: bool = False,
+    ):
+        """Adds a thread and records its real start/end time as the block runs.
+
+        pid/tid default to the current process id and the calling thread's id.
+        """
+        thread = self.add_thread(
+            name, pid, tid, start_time=self.now_ms(), is_main=is_main
+        )
+        try:
+            yield thread
+        finally:
+            thread.end_time = self.now_ms()
+
+    def _schema_for(self, marker_class: type) -> MarkerSchema:
+        schema = self._schemas_by_type_name.get(marker_class.type_name)
+        if schema is None:
+            schema = schema_from_marker_class(marker_class)
+            self._schemas_by_type_name[marker_class.type_name] = schema
+        return schema
+
+    def _encode_field_value(self, format: MarkerFormat, value):
+        if format in _UNIQUE_STRING_FORMATS:
+            return self.strings.index_for_string(str(value))
+        if format in _FLOW_FORMATS:
+            return self.strings.index_for_string(f"{int(value):016x}")
+        return value
+
+    def add_marker(
+        self,
+        thread: Thread,
+        name: str,
+        timing: MarkerTiming,
+        marker: Marker,
+        category: Category | None = None,
+    ) -> None:
+        schema = self._schema_for(type(marker))
+        resolved_category = category or type(marker).category or DEFAULT_CATEGORIES[0]
+        category_index = self.categories.index_for_category(resolved_category)
+        name_index = self.strings.index_for_string(name)
+
+        fields_by_key = {field.key: field for field in schema.fields}
+        data = {"type": schema.type_name}
+        for key, value in marker.field_values().items():
+            data[key] = self._encode_field_value(fields_by_key[key].format, value)
+
+        thread._append_marker_row(
+            _MarkerRow(
+                name_index=name_index,
+                start=timing.start,
+                end=timing.end,
+                phase=timing.phase,
+                category_index=category_index,
+                data=data,
+            )
+        )
+
+    @contextlib.contextmanager
+    def measure(
+        self,
+        thread: Thread,
+        name: str,
+        marker: Marker,
+        category: Category | None = None,
+    ):
+        """Records an interval marker for the block's real duration."""
+        start = self.now_ms()
+        try:
+            yield
+        finally:
+            end = self.now_ms()
+            self.add_marker(
+                thread, name, MarkerTiming.interval(start, end), marker, category
+            )
+
+    def to_dict(self) -> dict:
+        return {
+            "meta": {
+                "interval": self.interval,
+                "startTime": self.start_time,
+                "processType": 0,
+                "product": self.product,
+                "stackwalk": 0,
+                "version": GECKO_PROFILE_VERSION,
+                "preprocessedProfileVersion": PREPROCESSED_PROFILE_VERSION,
+                "symbolicated": True,
+                "categories": self.categories.to_list(),
+                "markerSchema": [
+                    schema.to_dict() for schema in self._schemas_by_type_name.values()
+                ],
+            },
+            "libs": [],
+            "shared": {
+                "stackTable": _empty_table(["frame", "prefixOffset"]),
+                "frameTable": _empty_table(
+                    [
+                        "flags",
+                        "address",
+                        "lib",
+                        "category",
+                        "subcategory",
+                        "func",
+                        "nativeSymbol",
+                        "innerWindowID",
+                        "line",
+                        "column",
+                        "originalLocation",
+                    ]
+                ),
+                "funcTable": _empty_table(
+                    [
+                        "flags",
+                        "name",
+                        "resource",
+                        "source",
+                        "lineNumber",
+                        "columnNumber",
+                        "originalLocation",
+                    ]
+                ),
+                "resourceTable": _empty_table(["name", "host", "type"]),
+                "nativeSymbols": _empty_table(
+                    ["libIndex", "address", "name", "functionSize"]
+                ),
+                "stringArray": self.strings.to_list(),
+                "sources": _empty_table(
+                    [
+                        "id",
+                        "filename",
+                        "startLine",
+                        "startColumn",
+                        "sourceMapURL",
+                        "content",
+                        "generatedSource",
+                    ]
+                ),
+                "sourceLocationTable": _empty_table(["source", "line", "column"]),
+            },
+            "threads": [thread.to_dict() for thread in self.threads],
+            "pages": [],
+            "profilerOverhead": [],
+            "counters": [],
+        }
+
+    def to_json(self) -> str:
+        return json.dumps(self.to_dict())
+
+    def write_json(self, path: str) -> None:
+        with open(path, "w") as f:
+            f.write(self.to_json())

fxprofiler/strings.py

@@ -0,0 +1,16 @@
+class StringTable:
+    def __init__(self) -> None:
+        self._strings: list[str] = []
+        self._index_by_string: dict[str, int] = {}
+
+    def index_for_string(self, value: str) -> int:
+        index = self._index_by_string.get(value)
+        if index is not None:
+            return index
+        index = len(self._strings)
+        self._strings.append(value)
+        self._index_by_string[value] = index
+        return index
+
+    def to_list(self) -> list[str]:
+        return list(self._strings)

fxprofiler/thread.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from fxprofiler.marker import MarkerPhase
+
+
+@dataclass
+class _MarkerRow:
+    name_index: int
+    start: float | None
+    end: float | None
+    phase: MarkerPhase
+    category_index: int
+    data: dict
+
+
+class Thread:
+    def __init__(
+        self,
+        name: str,
+        pid: str,
+        tid: str,
+        start_time: float = 0.0,
+        end_time: float | None = None,
+        is_main: bool = False,
+    ) -> None:
+        self.name = name
+        self.pid = pid
+        self.tid = tid
+        self.start_time = start_time
+        self.end_time = end_time
+        self.is_main = is_main
+        self._marker_rows: list[_MarkerRow] = []
+
+    def _append_marker_row(self, row: _MarkerRow) -> None:
+        self._marker_rows.append(row)
+
+    def _markers_to_dict(self) -> dict:
+        markers = {
+            "data": [],
+            "name": [],
+            "startTime": [],
+            "endTime": [],
+            "phase": [],
+            "category": [],
+            "length": len(self._marker_rows),
+        }
+        for row in self._marker_rows:
+            markers["data"].append(row.data)
+            markers["name"].append(row.name_index)
+            markers["startTime"].append(row.start if row.start is not None else 0.0)
+            markers["endTime"].append(row.end if row.end is not None else 0.0)
+            markers["phase"].append(int(row.phase))
+            markers["category"].append(row.category_index)
+        return markers
+
+    def to_dict(self) -> dict:
+        return {
+            "processType": "default",
+            "processStartupTime": 0,
+            "processShutdownTime": self.end_time,
+            "registerTime": self.start_time,
+            "unregisterTime": self.end_time,
+            "pausedRanges": [],
+            "name": self.name,
+            "isMainThread": self.is_main,
+            "pid": self.pid,
+            "tid": self.tid,
+            "showMarkersInTimeline": True,
+            "samples": {
+                "weightType": "samples",
+                "weight": None,
+                "stack": [],
+                "time": [],
+                "length": 0,
+            },
+            "markers": self._markers_to_dict(),
+        }

fxprofiler/viewer.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+import http.server
+import secrets
+import threading
+import webbrowser
+from urllib.parse import quote
+
+from fxprofiler.profile import Profile
+
+
+def build_profiler_url(
+    profile_url: str, profiler_origin: str = "https://profiler.firefox.com"
+) -> str:
+    return f"{profiler_origin}/from-url/{quote(profile_url, safe='')}/"
+
+
+def _make_handler(
+    token: str, payload: bytes
+) -> type[http.server.BaseHTTPRequestHandler]:
+    expected_path = f"/{token}/profile.json"
+
+    class Handler(http.server.BaseHTTPRequestHandler):
+        def do_GET(self) -> None:
+            if self.path != expected_path:
+                self.send_response(404)
+                self.end_headers()
+                return
+            self.send_response(200)
+            self.send_header("Content-Type", "application/json")
+            self.send_header("Content-Length", str(len(payload)))
+            self.send_header("Access-Control-Allow-Origin", "*")
+            self.end_headers()
+            self.wfile.write(payload)
+
+        def log_message(self, format: str, *args) -> None:
+            pass
+
+    return Handler
+
+
+class ProfileServer:
+    def __init__(self, payload: bytes, host: str = "127.0.0.1", port: int = 0) -> None:
+        self.token = secrets.token_urlsafe(16)
+        handler = _make_handler(self.token, payload)
+        self._httpd = http.server.ThreadingHTTPServer((host, port), handler)
+        self._thread: threading.Thread | None = None
+
+    @property
+    def port(self) -> int:
+        return self._httpd.server_address[1]
+
+    @property
+    def profile_url(self) -> str:
+        return f"http://127.0.0.1:{self.port}/{self.token}/profile.json"
+
+    def start(self) -> None:
+        self._thread = threading.Thread(target=self._httpd.serve_forever, daemon=True)
+        self._thread.start()
+
+    def shutdown(self) -> None:
+        self._httpd.shutdown()
+        self._httpd.server_close()
+        if self._thread is not None:
+            self._thread.join()
+
+
+def show(
+    profile: Profile,
+    profiler_origin: str = "https://profiler.firefox.com",
+    open_browser=webbrowser.open,
+) -> ProfileServer:
+    server = ProfileServer(profile.to_json().encode("utf-8"))
+    server.start()
+    open_browser(build_profiler_url(server.profile_url, profiler_origin))
+    return server

fxprofiler-0.1.0.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: fxprofiler
+Version: 0.1.0
+Summary: Create marker-only performance profiles in the Firefox Profiler.
+License-Expression: MPL-2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# fxprofiler
+
+Create marker-only performance profiles in the Firefox Profiler. The [profiling](https://docs.python.org/3/library/profiling.html)
+module allows for sampling based profiling, but no markers. Unfortunately it's not possible
+yet to do both sampling and markers in Python together. This package is designed for
+manually instrumenting python code with deterministic tracing markers or spans.
+
+## Define a marker type
+
+A simple Text marker can be created to create an Instant marker at a specific point
+in time.
+
+```python
+from dataclasses import dataclass
+from fxprofiler import Marker, MarkerFormat, marker_field
+
+
+@dataclass
+class TextMarker(Marker):
+    type_name = "Text"
+    chart_label = "{marker.data.text}"
+    table_label = "{marker.name} - {marker.data.text}"
+
+    text: str = marker_field(label="Contents", format=MarkerFormat.UNIQUE_STRING)
+```
+
+Additional information can be collected through the `marker_field` mechannism.
+
+```python
+from dataclasses import dataclass
+from fxprofiler import (
+    Category,
+    CategoryColor,
+    Marker,
+    MarkerFormat,
+    MarkerGraph,
+    MarkerGraphType,
+    marker_field,
+)
+
+
+@dataclass
+class AllocationMarker(Marker):
+    type_name = "custom"
+    category = Category("Graphics", CategoryColor.GREEN)
+    description = "Tracks a single allocation event."
+    tooltip_label = "Allocation - {marker.data.url}"
+    graphs = (MarkerGraph(key="latency_ms", type=MarkerGraphType.LINE),)
+
+    event_name: str = marker_field(
+        label="Event name", format=MarkerFormat.UNIQUE_STRING
+    )
+    allocation_size: int = marker_field(
+        label="Allocation size", format=MarkerFormat.BYTES
+    )
+    url: str = marker_field(label="URL", format=MarkerFormat.URL)
+    latency_ms: float = marker_field(label="Latency", format=MarkerFormat.DURATION)
+```
+
+## Building a profile
+
+In order to add markers, a full profile must be built. The profiles follow a thread and
+process model. Even if your system has a different abstraction, you can fit your data
+into these groupings. Threads are grouped by pid in the profiler UI. You can create
+synthetic PIDs to group threads.
+
+```python
+from fxprofiler import Profile, MarkerTiming
+
+profile = Profile(product="My Script", start_time_ms_since_epoch=0.0)
+thread = profile.add_thread("Main Thread", pid=1, tid=1, is_main=True)
+
+profile.add_marker(
+    thread, "startup", MarkerTiming.instant(0.0), TextMarker(text="App launched")
+)
+profile.add_marker(
+    thread,
+    "allocate",
+    MarkerTiming.interval(5.0, 42.0),
+    AllocationMarker(
+        event_name="alloc",
+        allocation_size=512_000,
+        url="https://example.com/",
+        latency_ms=12.3,
+    ),
+)
+```
+
+## Context managers for timing
+
+`measure()` records an interval marker for the duration of the context block.
+
+```python
+with profile.measure(thread, "render", TextMarker(text="Rendered frame")):
+    render_frame()
+```
+
+`thread()` adds a thread that is alive for the duration of the context block.
+
+```python
+import threading
+
+
+def worker(profile):
+    with profile.thread("Worker") as thread:
+        with profile.measure(thread, "task", TextMarker(text="task")):
+            do_work()
+
+
+threading.Thread(target=worker, args=(profile,)).start()
+```
+
+## Interval-start / interval-end pairs
+
+If markers involve a duration, the API supports adding them with two different markers.
+
+```python
+profile.add_marker(
+    thread, "fetch", MarkerTiming.interval_start(2.0), TextMarker(text="fetch started")
+)
+# ... later, possibly after the end time wasn't known yet when the marker started ...
+profile.add_marker(
+    thread, "fetch", MarkerTiming.interval_end(30.0), TextMarker(text="fetch finished")
+)
+```
+
+## Writing and opening a profile
+
+When integrating into your app, the profile can be saved and then served directly.
+
+```python
+profile.write_json("profile.json")
+```
+
+```python
+from fxprofiler import show
+
+server = show(profile)
+input("Press Enter to stop serving...\n")
+server.shutdown()
+```
+
+## Examples
+
+Runnable scripts that open profiles live in `examples/`:
+
+```sh
+task example -- markers
+```
+
+## Development
+
+All of the tasks can be run through [Taskfile](https://taskfile.dev/).
+
+## Releasing
+
+Describe the release under `## Unreleased` in `CHANGELOG.md`, then run:
+
+```sh
+task publish -- patch   # or minor / major
+```

fxprofiler-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+fxprofiler/__init__.py,sha256=dqTR27l_BJG8So8SQlKUYmuccvnTIfjHBgxxTojNJNo,656
+fxprofiler/category.py,sha256=1BcIiuJ0wbulyGDJpSCE7i7hZjdPhJYsRxaFK9aKrzo,1877
+fxprofiler/marker.py,sha256=kWMUtLavixlbCkzDYfpkiY4A4ffhzVIkR9jPh_FsWR8,1738
+fxprofiler/marker_schema.py,sha256=myReDr1wOkVDj9JUCEocdZmjuSKMcX7C7HzzguLw1K4,5211
+fxprofiler/profile.py,sha256=y3IjjT93SNfheqZhBuM8xvyzgpse0Cb-WvK-GbvTP5c,7701
+fxprofiler/strings.py,sha256=FH7ohgaSxg6ArMNEfy_1sjGvUUSFVaYLPpfz2LdCzzg,505
+fxprofiler/thread.py,sha256=pNrAE7IiRjXfAt61mNyHuo5q-2gWESj9QMK0Yp6qPgI,2245
+fxprofiler/viewer.py,sha256=KA8WNYjWB8a1ZhdGkLjWz2yPs4JhigJUuWS3XwVAs40,2317
+fxprofiler-0.1.0.dist-info/licenses/LICENSE,sha256=INpOi7a-Tfo5Tc2Spx5F-qN9TKyy8rB_gn2mEnjcDQ4,15538
+fxprofiler-0.1.0.dist-info/METADATA,sha256=QBHYV8H9x-B48n1lwAgZSa-qrCxaviRevP4Hvz1WLIo,4567
+fxprofiler-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+fxprofiler-0.1.0.dist-info/top_level.txt,sha256=nWhDDOh5fJht03FJhkEB1mRikwNft8eMbiSKEFwjQ40,11
+fxprofiler-0.1.0.dist-info/RECORD,,

fxprofiler-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fxprofiler-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,364 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+---------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+--------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+-----------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+---------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+6. Disclaimer of Warranty
+---------------------------
+
+Covered Software is provided under this License on an "as is" basis,
+without warranty of any kind, either expressed, implied, or statutory,
+including, without limitation, warranties that the Covered Software is
+free of defects, merchantable, fit for a particular purpose or
+non-infringing. The entire risk as to the quality and performance of the
+Covered Software is with You. Should any Covered Software prove
+defective in any respect, You (not any Contributor) assume the cost of
+any necessary servicing, repair, or correction. This disclaimer of
+warranty constitutes an essential part of this License. No use of any
+Covered Software is authorized under this License except under this
+disclaimer.
+
+7. Limitation of Liability
+----------------------------
+
+Under no circumstances and under no legal theory, whether tort
+(including negligence), contract, or otherwise, shall any Contributor,
+or anyone who distributes Covered Software as permitted above, be
+liable to You for any direct, indirect, special, incidental, or
+consequential damages of any character including, without limitation,
+damages for lost profits, loss of goodwill, work stoppage, computer
+failure or malfunction, or any and all other commercial damages or
+losses, even if such party shall have been informed of the possibility
+of such damages. This limitation of liability shall not apply to
+liability for death or personal injury resulting from such party's
+negligence to the extent applicable law prohibits such limitation. Some
+jurisdictions do not allow the exclusion or limitation of incidental or
+consequential damages, so this exclusion and limitation may not apply to
+You.
+
+8. Litigation
+---------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+------------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+------------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+---------------------------------------------
+
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+-------------------------------------------------------------
+
+    This Source Code Form is "Incompatible With Secondary Licenses", as
+    defined by the Mozilla Public License, v. 2.0.

fxprofiler-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fxprofiler