Skip to content

Commit

Permalink
Merge dec1bf5 into backport/fix_ndjson_urls/wildly-clever-anemone
Browse files Browse the repository at this point in the history
  • Loading branch information
hc-github-team-nomad-core authored Oct 28, 2024
2 parents c8a1c83 + dec1bf5 commit 60518e8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion command/agent/event_endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func (s *HTTPServer) EventStream(resp http.ResponseWriter, req *http.Request) (i
if _, err := io.Copy(output, bytes.NewReader(res.Event.Data)); err != nil {
return CodedError(500, err.Error())
}
// Each entry is its own new line according to ndjson.org
// Each entry is its own new line according to https://github.com/ndjson/ndjson-spec
// append new line to each entry
fmt.Fprint(output, "\n")
}
Expand Down
8 changes: 4 additions & 4 deletions website/content/api-docs/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The `/event/stream` endpoint is used to stream events generated by Nomad.

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).
body will be valid [ndjson](https://github.com/ndjson/ndjson-spec). 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 |
| ------ | ------------------ | ------------------ |
Expand Down

0 comments on commit 60518e8

Please sign in to comment.