ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-02-21 18:06:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add usage example repo to documentation

Browse Source 
Change-type: patch
Signed-off-by: Cameron Diver <cameron@balena.io>
This commit is contained in:
Cameron Diver 2019-08-21 15:09:09 +01:00
parent 48bccd34db
commit da0534b3c8
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/API.md
View File

@ -1204,18 +1204,18 @@ Show journal logs from `unit` only, equivalent to
`journalctl --unit=<unit>`.
##### format
Added in supervisor version v10.3.0
The format which will be streamed from journalctl, formats
are described here:
https://www.freedesktop.org/software/systemd/man/journalctl.html#-o
Fields should be provided via POST body in JSON format.
From an application container (with systemd installed):
From an application container:
```
$ curl -X POST -H "Content-Type: application/json" --data '{"follow":true,"all":true}' "$BALENA_SUPERVISOR_ADDRESS/v2/journal-logs?apikey=$BALENA_SUPERVISOR_API_KEY" | systemd-journal-remote - -o log.journal
$ curl -X POST -H "Content-Type: application/json" --data '{"follow":true,"all":true}' "$BALENA_SUPERVISOR_ADDRESS/v2/journal-logs?apikey=$BALENA_SUPERVISOR_API_KEY" > log.journal
```
The `log.journal` file can then be viewed with
```
journalctl --file log.journal -f
```
An example project using this endpoint can be found
[in this repository](https://github.com/balena-io-playground/device-cloud-logging).