Link into docs for the logs and compressed-logs formats.

This commit is contained in:
Michael Kaye 2022-01-21 11:52:45 +00:00
parent e5a067b4b9
commit 108594b531

View file

@ -68,11 +68,17 @@ logs.)
* `id`: textual identifier for the logs. Used as the filename, as above. * `id`: textual identifier for the logs. Used as the filename, as above.
* `lines`: log data. Newlines should be encoded as `\n`, as normal in JSON). * `lines`: log data. Newlines should be encoded as `\n`, as normal in JSON).
A summary of the current log file formats that are uploaded for `log` and
`compressed-log` is [available](docs/submitted_reports.md).
* `compressed-log`: a gzipped logfile. Decompressed and then treated the same as * `compressed-log`: a gzipped logfile. Decompressed and then treated the same as
`log`. `log`.
Compressed logs are not supported for the JSON upload encoding. Compressed logs are not supported for the JSON upload encoding.
A summary of the current log file formats that are uploaded for `log` and
`compressed-log` is [available](docs/submitted_reports.md).
* `file`: an arbitrary file to attach to the report. Saved as-is to disk, and * `file`: an arbitrary file to attach to the report. Saved as-is to disk, and
a link is added to the github issue. The filename must be in the format a link is added to the github issue. The filename must be in the format
`name.ext`, where `name` contains only alphanumerics, `-` or `_`, and `ext` `name.ext`, where `name` contains only alphanumerics, `-` or `_`, and `ext`