remote/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2026-09-29 21:34:07 +02:00
Code Issues Projects Releases Packages Wiki Activity

Simplified telemetry descriptions in telemetry_registry.py

Browse source 
Told GPT-6 Astra to apply similar simplifications to the ones I used
when I hand-edited other parts of the docs.

Refs #2867
This commit is contained in:
Simon Willison 2026-09-24 11:04:41 -07:00
commit 287e8ba3b2
3 changed files with 105 additions and 167 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/plugin_telemetry.rst
View file

@ -5,7 +5,7 @@ Telemetry for plugin authors
Datasette core emits OpenTelemetry spans and metrics for the work it does itself - see :ref:`internals_telemetry` for what those are and how an operator turns them on. This page is about the other half: instrumenting the work **your plugin** does, so that a plugin's queries, background jobs and custom operations show up in the same traces and the same metrics pipeline, using the same conventions.
Everything here follows one rule inherited from core: **depend on** ``opentelemetry-api`` **only, and never install a provider**. With no SDK installed every span and instrument your plugin creates is a free no-op; whoever runs Datasette decides whether telemetry is collected, sampled or exported. A plugin that installs a ``TracerProvider`` or configures an exporter is making an operator's decision for them.
Depend on ``opentelemetry-api`` only. Providers and exporters are configured by whoever runs Datasette. Without a provider, no telemetry is recorded.
.. _plugin_telemetry_scope: