Skip to content

Commit

Permalink
Improve the log-development setting documentation (#491)
Browse files Browse the repository at this point in the history
* Add `log-development` documentation to `config.yaml`

* Improve `--help` output for `--log-development`

* Add changelog entry
  • Loading branch information
pajlada committed Jun 11, 2023
1 parent a2021b3 commit 3d1df57
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- Breaking: Remove the `/twitchemotes/` endpoints. See [issue 332](https://github.com/Chatterino/api/issues/332) for more information. (#465)
- Fix: We do some more YouTube video ID parsing to ensure broken links (such as `youtube.com/watch?v=foobar?feature=share`) still return the actual video ID, since this is how the browser operates. (#488)
- Dev: Document the `log-development` setting. (#491)

## 2.0.2

Expand Down
4 changes: 4 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,7 @@

# Cache duration for Wikipedia article links
#wikipedia-article-cache-duration: 1h

# Enables much more verbose logging, useful for debugging.
# This makes all log messages include a stack trace to see where they were called from.
#log-development: false
2 changes: 1 addition & 1 deletion pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func init() {
pflag.Duration("youtube-channel-cache-duration", 48*time.Hour, "Cache timeout for youtube channels")
pflag.Duration("youtube-video-cache-duration", 48*time.Hour, "Cache timeout for youtube videos")
pflag.String("log-level", "info", "Log level")
pflag.Bool("log-development", false, "Enable development logging for warnings and above, this includes stack traces")
pflag.Bool("log-development", false, "Enables much more verbose logging, useful for debugging. This makes all log messages include a stack trace to see where they were called from.")
pflag.String("discord-token", "", "Discord token")
pflag.String("twitch-client-id", "", "Twitch client ID")
pflag.String("twitch-client-secret", "", "Twitch client secret")
Expand Down

0 comments on commit 3d1df57

Please sign in to comment.