mirror of
https://github.com/simonw/datasette.git
synced 2026-09-04 15:44:08 +02:00
37 lines
1.3 KiB
Python
37 lines
1.3 KiB
Python
|
"""
|
||
|
|
Render the span reference in ``internals.rst`` from
|
||
|
|
``datasette/telemetry_registry.py``.
|
||
|
|
|
||
|
|
Driven by cog, and ``cog --check docs/*.rst`` runs in CI - so adding a span
|
||
|
|
without documenting it, or documenting one that no longer exists, is a build
|
||
|
|
failure rather than something a reader discovers later.
|
||
|
|
"""
|
||
|
|
|
||
|
|
|
||
|
|
def _attribute_lines(cog, attributes):
|
||
|
|
if not attributes:
|
||
|
|
cog.out(" No attributes.\n\n")
|
||
|
|
return
|
||
|
|
cog.out(" Attributes:\n\n")
|
||
|
|
for attribute in attributes:
|
||
|
|
suffix = " *(optional)*" if attribute.optional else ""
|
||
|
|
cog.out(f" - ``{attribute}``{suffix} - {attribute.description}\n")
|
||
|
|
cog.out("\n")
|
||
|
|
|
||
|
|
|
||
|
|
def spans(cog):
|
||
|
|
from opentelemetry.trace import SpanKind
|
||
|
|
|
||
|
|
from datasette.telemetry_registry import SPANS
|
||
|
|
|
||
|
|
cog.out("\n")
|
||
|
|
for span in SPANS:
|
||
|
|
title = f"{span}*" if span.prefix else str(span)
|
||
|
|
cog.out(f"``{title}``\n")
|
||
|
|
cog.out(f" {span.description}\n\n")
|
||
|
|
# INTERNAL is the default and the overwhelming majority of spans -
|
||
|
|
# printing it on every one would be noise. Only the exceptional case,
|
||
|
|
# a real database call, is worth calling out.
|
||
|
|
if span.kind != SpanKind.INTERNAL:
|
||
|
|
cog.out(f" Kind: ``{span.kind.name}``.\n\n")
|
||
|
|
_attribute_lines(cog, span.attributes)
|