Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs for xk6-loki log formats #6134

Merged
merged 1 commit into from
Jun 1, 2022
Merged

Update docs for xk6-loki log formats #6134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/sources/clients/k6/log-generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,19 @@ is used.

## Log format

`xk6-loki` can emit log lines in six distinct formats. The label `format` of a stream defines the format of its log lines.
`xk6-loki` can emit log lines in seven distinct formats. The label `format` of
a stream defines the format of its log lines.

* Apache common (`apache_common`)
* Apache combined (`apache_combined`)
* Apache error (`apache_error`)
* [BSD syslog](https://datatracker.ietf.org/doc/html/rfc3164) (`rfc3164`)
* [Syslog](https://datatracker.ietf.org/doc/html/rfc5424) (`rfc5424`)
* JSON (`json`)
* [logfmt](https://pkg.go.dev/github.com/kr/logfmt) (`logfmt`)

Under the hood, the extension uses the library [flog](https://github.com/mingrammer/flog) for generating log lines.
Under the hood, the extension uses a fork the library
[flog](https://github.com/mingrammer/flog) for generating log lines.

## Labels

Expand All @@ -83,7 +86,7 @@ Under the hood, the extension uses the library [flog](https://github.com/mingram
| name | type | cardinality |
| --------- | -------- | --------------- |
| instance | fixed | 1 per k6 worker |
| format | fixed | 6 |
| format | fixed | 7 |
| os | fixed | 3 |
| namespace | variable | >100 |
| app | variable | >100 |
Expand Down