diff --git a/CHANGELOG.md b/CHANGELOG.md index 4cf7e4b4..5a2d8148 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/config.yaml b/config.yaml index 04ca59e6..8c9a33b1 100644 --- a/config.yaml +++ b/config.yaml @@ -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 diff --git a/pkg/config/config.go b/pkg/config/config.go index a6d26661..209ced26 100644 --- a/pkg/config/config.go +++ b/pkg/config/config.go @@ -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")