Server-Timing header

// A single metric
Server-Timing: <timing-metric>

// Multiple metrics as a comma-separated list
Server-Timing: <timing-metric>, …, <timing-metricN>

Ein <timing-metric> hat einen Namen und kann eine optionale Dauer und eine optionale Beschreibung enthalten. Zum Beispiel:

// A metric with a name only
Server-Timing: missedCache

// A metric with a duration
Server-Timing: cpu;dur=2.4

// A metric with a description and duration
Server-Timing: cache;desc="Cache Read";dur=23.2

// Two metrics with duration values
Server-Timing: db;dur=53, app;dur=47.2

<timing-metric>

Eine durch Kommas getrennte Liste von einer oder mehreren Metriken mit den folgenden Komponenten, die durch Semikolon getrennt sind:

<name>

Ein Namenstoken (keine Leerzeichen oder Sonderzeichen) für die Metrik, die implementierungsspezifisch oder vom Server definiert ist, wie cacheHit.

<duration> Optional

Eine Dauer als die Zeichenkette dur, gefolgt von =, gefolgt von einem Wert, wie dur=23.2.

<description> Optional

Eine Beschreibung als die Zeichenkette desc, gefolgt von =, gefolgt von einem Wert als Token oder als zitierte Zeichenkette, wie desc=prod oder desc="DB lookup".

Namen und Beschreibungen sollten so kurz wie möglich gehalten werden (zum Beispiel durch die Verwendung von Abkürzungen und das Weglassen optionaler Werte), um den HTTP-Daten-Overhead zu minimieren.

Der Server-Timing-Header kann potenziell sensible Informationen über Anwendungen und Infrastruktur preisgeben. Entscheiden Sie, welche Metriken gesendet werden sollen, wann sie gesendet werden sollen und wer sie sehen darf, basierend auf dem Anwendungsfall. Zum Beispiel können Sie entscheiden, nur authentifizierten Benutzern Metriken anzuzeigen und in öffentlichen Antworten nichts zu zeigen.

Zusätzlich zur Anzeige der Server-Timing-Header-Metriken in den Entwicklerwerkzeugen des Browsers ermöglicht die PerformanceServerTiming-Schnittstelle Tools, Metriken automatisch aus JavaScript zu sammeln und zu verarbeiten. Diese Schnittstelle ist auf den gleichen Ursprung beschränkt, aber Sie können den Timing-Allow-Origin-Header verwenden, um die Domänen anzugeben, die Zugriff auf die Server-Metriken haben dürfen. Die Schnittstelle ist nur in sicheren Kontexten (HTTPS) in einigen Browsern verfügbar.

Die Komponenten des Server-Timing-Headers werden wie folgt auf die PerformanceServerTiming-Eigenschaften abgebildet:

• "name" -> PerformanceServerTiming.name
• "dur" -> PerformanceServerTiming.duration
• "desc" -> PerformanceServerTiming.description

Die folgende Antwort enthält eine Metrik custom-metric mit einer Dauer von 123.45 Millisekunden und einer Beschreibung von "My custom metric":

Server-Timing: custom-metric;dur=123.45;desc="My custom metric"

In der folgenden Antwort wird der Trailer-Header verwendet, um anzuzeigen, dass ein Server-Timing-Header dem Antwortkörper folgen wird. Eine Metrik custom-metric mit einer Dauer von 123.4 Millisekunden wird gesendet.

HTTP/1.1 200 OK
Transfer-Encoding: chunked
Trailer: Server-Timing

--- response body ---
Server-Timing: custom-metric;dur=123.4

• PerformanceServerTiming
• Trailer-Header