서버 타이밍

2. Server-Timing 헤더 필드

Server-Timing 헤더 필드는 특정 요청-응답 사이클에 대해 하나 이상의 지표와 설명을 전달하는 데 사용됩니다. [RFC5234]의 ABNF(확장된 Backus-Naur Form) 구문에서 Server-Timing 헤더 필드는 다음과 같이 정의됩니다:

Server-Timing             = #server-timing-metric
server-timing-metric      = metric-name *( OWS ";" OWS server-timing-param )
metric-name               = token
server-timing-param       = server-timing-param-name OWS "=" OWS server-timing-param-value
server-timing-param-name  = token
server-timing-param-value = token / quoted-string

[RFC7230]에서 #, *, OWS, token, quoted-string 정의를 참고하십시오.

응답에는 동일한 metric-name을 가진 여러 server-timing-metric 항목이 존재할 수 있으며, 사용자 에이전트는 모든 항목을 처리하고 노출해야 합니다.

사용자 에이전트는 제공된 지표를 임의의 순서로 표시할 수 있습니다. 즉, HTTP 헤더 필드 내의 지표 순서는 중요하지 않습니다.

이 헤더 필드는 미래의 파라미터를 허용하기 위해 확장 가능한 구문으로 정의됩니다. 응답의 Server-Timing 헤더 필드에서 특정 server-timing-param-name을 인식하지 못하는 사용자 에이전트는 해당 토큰을 무시하고 오류 신호 없이 계속 처리해야 합니다.

모호성을 피하기 위해, 개별 server-timing-param-name은 server-timing-metric 내에서 여러 번 나타나지 않아야 합니다. 만약 server-timing-param-name이 여러 번 지정되면 첫 번째 인스턴스만 고려하고, server-timing-param가 불완전하거나 유효하지 않더라도 모든 후속 등장들은 오류 신호 없이 무시하며, server-timing-metric 처리에도 영향을 주지 않습니다. 이 경우만 server-timing-metric 내 파라미터의 순서가 의미를 가집니다.

사용자 에이전트는 server-timing-param-value 뒤에서 다음 server-timing-param 및 현재 server-timing-metric의 끝 전까지 발견된 불필요한 문자를 무시해야 합니다.

사용자 에이전트는 metric-name 뒤에서 첫 server-timing-param 및 다음 server-timing-metric 전까지 발견된 불필요한 문자를 무시해야 합니다.

이 명세는 server-timing-param-names로 "dur"(duration)과 "desc"(description)을 정의합니다. 둘 다 선택 사항입니다.

Server-Timing 헤더 필드 파싱 동작은 문자열 field가 주어졌을 때 다음과 같다:

1. position을 포지션 변수로 지정하고, 처음에는 field의 처음을 가리키게 한다.

2. name을 코드 포인트 시퀀스 수집의 결과로, field에서 U+003B(;)가 아닌 문자들을 position에 따라 수집한다.

3. 앞뒤 ASCII 공백 제거를 name에 대해 수행한다.

4. name이 빈 문자열이면 null을 반환한다.

5. metric을 새 PerformanceServerTiming 객체로 하고, metric name을 name으로 지정한다.

6. params를 빈 순서 있는 맵으로 설정한다.

7. position이 field의 끝에 도달할 때까지:

   1. position을 1 더한다.

   2. paramName을 코드 포인트 시퀀스 수집의 결과로, field에서 U+003D(=)가 아닌 문자들을 position에서 수집한다.

   3. 앞뒤 ASCII 공백 제거를 paramName에 대해 수행한다.

   4. paramName이 빈 문자열이거나 params[paramName]이 존재하면, continue한다.

   5. position을 1 더한다.

   6. paramValue를 빈 문자열로 설정한다.

   7. ASCII 공백 건너뛰기를 field에서 position에 대해 수행한다.

   8. 만약 field의 position 위치의 코드 포인트가 U+0022(")라면:

      1. paramValue를 HTTP quoted string 수집 결과로 설정한다, field와 position, 그리고 extract-value flag가 설정된 상태로 수행한다.

      2. 코드 포인트 시퀀스 수집을 field에서 U+003B(;)가 아닌 문자에 대해 position에서 수행한다. 결과는 사용하지 않는다.

   9. 그 외의 경우:

      1. rawParamValue를 코드 포인트 시퀀스 수집 결과로, field에서 U+003B(;)가 아닌 문자들을 position에서 수집한다.

      2. paramValue를 공백 제거를 rawParamValue에 대해 수행한 결과로 설정한다.

8. Set metric의 params를 params로 설정한다.

9. metric을 반환한다.

3. PerformanceServerTiming 인터페이스

[Exposed=(Window,Worker)]
interface PerformanceServerTiming {
  readonly attribute DOMString name;
  readonly attribute DOMHighResTimeStamp duration;
  readonly attribute DOMString description;
  [Default] object toJSON();
};

toJSON이 호출되면, [WEBIDL]의 기본 toJSON 단계를 실행한다.

3.1. name 속성

name getter 단계는 this의 metric name을 반환하도록 한다.

3.2. duration 속성

duration getter 단계는 다음을 수행한다:

1. this의 params["dur"]이 존재하지 않으면, 0을 반환한다.

2. dur을 this의 params["dur"]을 부동 소수점 숫자 값 파싱 규칙을 사용하여 파싱한 결과로 한다.

3. dur이 오류이면 0을, 그렇지 않으면 dur을 반환한다.

duration 속성은 DOMHighResTimeStamp이므로, 보통 밀리초 단위의 duration을 나타낸다. 하지만 실제로 강제할 수 없기 때문에, duration 속성은 임의의 시간 단위를 나타낼 수 있으며, 밀리초 단위로 표현하는 것이 권장된다.

3.3. description 속성

description getter 단계는 this의 params["desc"]이 존재한다면 반환하고, 그렇지 않으면 빈 문자열을 반환한다.

PerformanceServerTiming 객체는 연관된 문자열 metric name을 가지며, 처음에는 빈 문자열로 설정된다.

PerformanceServerTiming 객체는 연관된 ordered map params를 가지며, 처음에는 비어 있다.

3.4. PerformanceResourceTiming 인터페이스 확장

PerformanceResourceTiming 인터페이스(이 명세가 부분적으로 확장하는)는 [RESOURCE-TIMING]에서 정의된다.

[Exposed=(Window,Worker)]
partial interface PerformanceResourceTiming {
  readonly attribute FrozenArray<PerformanceServerTiming> serverTiming;
};

3.5. serverTiming 속성

serverTiming getter 단계는 다음과 같다:

1. entries를 새로운 목록으로 한다.

2. 각각의 field에 대하여 this의 timing info의 server-timing headers에서:

   1. metric을 해석한 field의 결과로 한다.

   2. 만약 metric이 null이 아니라면, append metric을 entries에 추가한다.

3. entries를 반환한다.

5. IANA 고려사항

영구 메시지 헤더 필드 레지스트리는 다음 등록 항목으로 업데이트되어야 합니다 ([RFC3864]):

5.1. Server-Timing 헤더 필드

헤더 필드 이름

Server-Timing

적용 프로토콜

http

상태

standard

작성자/변경 컨트롤러

W3C

명세 문서

이 명세 (See Server-Timing 헤더 필드)

> GET /resource HTTP/1.1
> Host: example.com

< HTTP/1.1 200 OK
< Server-Timing: miss, db;dur=53, app;dur=47.2
< Server-Timing: customView, dc;desc=atl
< Server-Timing: cache;desc="Cache Read";dur=23.2
< Trailer: Server-Timing
< (... snip response body ...)
< Server-Timing: total;dur=123.4

// serverTiming 항목은 'navigation'과 'resource' entry에서 사용될 수 있음
for (const entryType of ['navigation', 'resource']) {
  for (const {name: url, serverTiming} of performance.getEntriesByType(entryType)) {
    // serverTiming 배열 반복
    for (const {name, duration, description} of serverTiming) {
      // "느린" 항목만 관심 있음
      if (duration > 200) {
        console.info('느린 server-timing 항목 =',
          JSON.stringify({url, entryType, name, duration, description}, null, 2))
      }
    }
  }
}