Health Check Response Format for HTTP APIs
draft-inadarei-api-health-check-05
|
Document |
Type |
|
Active Internet-Draft (individual)
|
|
Author |
|
Irakli Nadareishvili
|
|
Last updated |
|
2020-11-18
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
pdf
htmlized (tools)
htmlized
bibtex
|
Stream |
Stream state |
|
(No stream defined) |
|
Consensus Boilerplate |
|
Unknown
|
|
RFC Editor Note |
|
(None)
|
IESG |
IESG state |
|
I-D Exists
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
Network Working Group I. Nadareishvili
Internet-Draft 18 November 2020
Intended status: Informational
Expires: 22 May 2021
Health Check Response Format for HTTP APIs
draft-inadarei-api-health-check-05
Abstract
This document proposes a service health check response format for
HTTP APIs.
Note to Readers
*RFC EDITOR: please remove this section before publication*
The issues list for this draft can be found at
https://github.com/inadarei/rfc-healthcheck/issues
(https://github.com/inadarei/rfc-healthcheck/issues).
The most recent draft is at https://inadarei.github.io/rfc-
healthcheck/ (https://inadarei.github.io/rfc-healthcheck/).
Recent changes are listed at https://github.com/inadarei/rfc-
healthcheck/commits/master (https://github.com/inadarei/rfc-
healthcheck/commits/master).
See also the draft's current status in the IETF datatracker, at
https://datatracker.ietf.org/doc/draft-inadarei-api-health-check/
(https://datatracker.ietf.org/doc/draft-inadarei-api-health-check/).
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
Nadareishvili Expires 22 May 2021 [Page 1]
Internet-Draft Health Check Response Format for HTTP AP November 2020
This Internet-Draft will expire on 22 May 2021.
Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Simplified BSD License text
as described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Notational Conventions . . . . . . . . . . . . . . . . . . . 3
3. API Health Response . . . . . . . . . . . . . . . . . . . . . 4
3.1. status . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.2. version . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.3. releaseId . . . . . . . . . . . . . . . . . . . . . . . . 5
3.4. notes . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.5. output . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.6. checks . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.7. links . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.8. serviceId . . . . . . . . . . . . . . . . . . . . . . . . 5
3.9. description . . . . . . . . . . . . . . . . . . . . . . . 5
4. The Checks Object . . . . . . . . . . . . . . . . . . . . . . 6
4.1. componentId . . . . . . . . . . . . . . . . . . . . . . . 7
4.2. componentType . . . . . . . . . . . . . . . . . . . . . . 7
4.3. observedValue . . . . . . . . . . . . . . . . . . . . . . 7
4.4. observedUnit . . . . . . . . . . . . . . . . . . . . . . 7
4.5. status . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.6. affectedEndpoints . . . . . . . . . . . . . . . . . . . . 8
4.7. time . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.8. output . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.9. links . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.10. Additional Keys . . . . . . . . . . . . . . . . . . . . . 9
5. Example Output . . . . . . . . . . . . . . . . . . . . . . . 9
6. Security Considerations . . . . . . . . . . . . . . . . . . . 11
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
8. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 12
9. Creating and Serving Health Responses . . . . . . . . . . . . 13
10. Consuming Health Check Responses . . . . . . . . . . . . . . 13
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
Nadareishvili Expires 22 May 2021 [Page 2]
Show full document text