kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-04 17:35:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11101 from hashicorp/d/event-stream-ndjson

Browse Source 
Mention the ndjson standard format the event stream uses
This commit is contained in:
Michael Lange
2021-08-31 11:55:00 -07:00
committed by GitHub
parent 9397a9a4df 01cd1485af
commit 5fa91c37d0
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
website/content/api-docs/events.mdx
View File

@@ -11,8 +11,12 @@ The `/event/stream` endpoint is used to stream events generated by Nomad.
## Event Stream
This endpoint streams a servers backlog of events as well as new events as they occur.
The stream will be kept alive until the connection is closed.
This endpoint streams a server's backlog of events as well as new events as they occur.
The stream will be kept alive until the connection is closed. The format of the response
body will be valid [ndjson](http://ndjson.org/). This means splitting the streaming
response at every `\n` character will guarantee each message is a valid JSON object.
Note that each JSON object may include multiple events (high server activity) or no
events (heartbeating to keep the connection open).
| Method | Path | Produces |
| ------ | ------------------ | ------------------ |