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.

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

documentation: Missing dogslow information #3182

Closed
surli opened this issue Nov 6, 2019 · 3 comments
Closed

documentation: Missing dogslow information #3182

surli opened this issue Nov 6, 2019 · 3 comments
Assignees
Labels
documentation Improvements or additions to the documentation. help wanted Extra attention is needed.
Milestone

Comments

@surli
Copy link
Contributor

surli commented Nov 6, 2019

I'm currently preparing an upgrade of Weblate and I'm reviewing the changes on the settings.py, and I discovered some references to dogslow in it, but there's very info in the documentation about it.
Only mention I found is in https://docs.weblate.org/en/latest/debugging.html#performance-issues (with a broken link btw :)), and it seems to say that it's optional?
However the settings-sample shows that there is a middleware for Dogslow:

MIDDLEWARE = [
    "weblate.middleware.ProxyMiddleware",
    "dogslow.WatchdogMiddleware",

A log handler for it too:

"dogslow": {
            "level": "WARNING",
            "class": "sentry_sdk.integrations.logging.EventHandler",
        },
[...]
"dogslow": {"level": "WARNING", "handlers": ["dogslow"]},

and some variable that are not documented in https://docs.weblate.org/en/latest/admin/config.html

# Logging slow requests
DOGSLOW_LOG_TO_SENTRY = bool(SENTRY_DSN)
DOGSLOW_LOGGER = "dogslow"
DOGSLOW_TIMER = 60

Could be nice to improve a bit the doc about it.
And since I'm not using sentry, I guess I won't be able to use dogslow: should I comment out the middleware / remove the log handlers, etc?

@nijel
Copy link
Member

nijel commented Nov 6, 2019

It's still optional, it's just enabled in example configuration. Without Sentry, it still logs slow request, so it is useful even without it. But you're right that the docs on this is missing.

@nijel nijel added documentation Improvements or additions to the documentation. help wanted Extra attention is needed. labels Nov 6, 2019
@nijel nijel added this to the 3.10 milestone Nov 6, 2019
@surli
Copy link
Contributor Author

surli commented Nov 6, 2019

Ok, thanks for the info!

@nijel nijel closed this as completed in 45fef42 Nov 17, 2019
@nijel
Copy link
Member

nijel commented Nov 17, 2019

Thank you for your report, the issue you have reported has just been fixed.

  • In case you see a problem with the fix, please comment on this issue.
  • In case you see similar problem, please open separate issue.
  • If you are happy with the outcome, consider supporting Weblate by donating.

@nijel nijel self-assigned this Nov 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to the documentation. help wanted Extra attention is needed.
Projects
None yet
Development

No branches or pull requests

2 participants