Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 24 additions & 20 deletions airflow-core/docs/core-concepts/multi-team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1063,26 +1063,24 @@ Dags, and global components emit the same metrics without a ``team_name`` tag.
When Multi-Team mode is disabled, metrics are emitted with no ``team_name`` tag whatsoever, exactly
as they have always been emitted for a single-team Airflow environment.

The ``team_name`` tag is applied to metrics across the following components:

- **Triggerer**: heartbeat, capacity, blocked-main-thread, trigger-queue delay, and trigger-outcome metrics
(for example, ``triggerer_heartbeat``, ``triggers.running``, ``triggers.succeeded``,
``triggers.blocked_main_thread``, ``triggerer.trigger_queue_delay``).
- **Executors**: executor slot gauges and scheduler-observed executor heartbeat timing (for example,
``executor.open_slots``, ``executor.queued_tasks``, ``scheduler.executor_heartbeat_duration``).
- **Scheduler**: pool slot gauges for team-scoped pools plus task- and asset-scheduling counters (for
example, ``pool.open_slots``, ``scheduler.tasks.killed_externally``, ``asset.triggered_dagruns``).
- **Dag runs**: dag run timing and lifecycle metrics (for example, ``dagrun.duration.<state>``,
``dagrun.first_task_scheduling_delay``, ``dag.callback_exceptions``).
- **Task instances**: task start, finish, and outcome counters (for example, ``ti.start``, ``ti.finish``,
``ti_successes``, ``ti_failures``).
- **Dag processing**: per-file parsing and callback metrics (for example, ``dag_processing.processes``,
``dag_processing.processor_timeouts``, ``dag_processing.callback_only_count``).
- **Callbacks**: callback execution counters (``callback_success`` / ``callback_failure``, optionally
prefixed).
- **Connection tests**: per-request worker and reaper metrics for team-owned connection tests (for
example, ``connection_test.success``, ``connection_test.failed``, ``connection_test.hook_duration``,
``connection_test.reaped``). Instance-wide connection-test queue gauges remain untagged.
The ``team_name`` tag is applied to metrics across the following components. The metrics named are
examples only, not a complete list:

- **Triggerer**: heartbeat, capacity, blocked-main-thread, trigger-queue delay, and trigger-outcome
metrics (``triggerer_heartbeat``, ``triggers.running``, etc.).
- **Executors**: executor slot gauges and scheduler-observed executor heartbeat timing
(``executor.open_slots``, ``executor.queued_tasks``, etc.).
- **Scheduler**: pool slot gauges for team-scoped pools plus task- and asset-scheduling counters
(``pool.open_slots``, ``scheduler.tasks.killed_externally``, etc.).
- **Dag runs**: dag run timing and lifecycle metrics (``dagrun.duration.<state>``,
``dagrun.first_task_scheduling_delay``, etc.).
- **Task instances**: task start, finish, and outcome counters (``ti.start``, ``ti.finish``, etc.).
- **Dag processing**: per-file parsing and callback metrics (``dag_processing.processes``,
``dag_processing.processor_timeouts``, etc.).
- **Callbacks**: callback execution counters (``callback_<state>``, optionally prefixed).
- **Connection tests**: per-request worker and reaper metrics for team-owned connection tests
(``connection_test.success``, ``connection_test.failed``, etc.). Instance-wide connection-test queue
gauges remain untagged.

.. note::

Expand All @@ -1091,6 +1089,12 @@ The ``team_name`` tag is applied to metrics across the following components:
``executor.*`` slot gauges from the base executor. Check individual provider change logs for the
minimum Airflow version that includes ``team_name`` tagging.

.. note::

This list is not exhaustive and may lag behind the code. Use it to see which areas of Airflow
carry the ``team_name`` tag; the metric emission sites in the Airflow source are the
authoritative reference for individual metric names.

Important Considerations
------------------------

Expand Down