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

Update JSON logs documentation to include 'error' field #301

Merged
merged 4 commits into from
Jan 21, 2025
Merged

Update JSON logs documentation to include 'error' field #301

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3e855e
Update JSON logs documentation to include 'error' field
markphelps Jan 20, 2025
198f4fe
chore: Update observability.mdx
markphelps Jan 20, 2025
95be4b3
chore: Update observability.mdx
markphelps Jan 20, 2025
faccd1b
chore: Update observability.mdx
markphelps Jan 20, 2025
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
10 changes: 8 additions & 2 deletions configuration/observability.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@

Flipt writes logs to STDOUT in two formats:

- JSON
- Console
- [JSON](#json)
- [Console](#console)

The format can be configured via the `log.encoding` configuration option.

Expand Down Expand Up @@ -98,6 +98,12 @@
}
```

#### Log Key Descriptions

- `L`: Level (log level). Possible values include: debug, info, warn, error, fatal, and panic.
- `T`: Timestamp. The timestamp is in ISO 8601 format, widely used for representing date and time. It includes the date, time, and time zone information. For example, "2024-01-20T21:59:49-05:00" represents the date and time in the Eastern Time Zone (UTC-5).

Check warning on line 104 in configuration/observability.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'SO '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'SO '", "location": {"path": "configuration/observability.mdx", "range": {"start": {"line": 104, "column": 40}}}, "severity": "WARNING"}
- `M`: Message. The message describes the log event. It can include information about the operation, errors encountered, or other relevant details.

### Console

```text
Expand Down
Loading