codeant-ai-for-open-source[bot] commented on code in PR #32487: URL: https://github.com/apache/superset/pull/32487#discussion_r3619096406
########## docs/admin_docs/configuration/event-logging.mdx: ########## @@ -50,13 +50,34 @@ Superset can be configured to log events to [StatsD](https://github.com/statsd/s if desired. Most endpoints hit are logged as well as key events like query start and end in SQL Lab. -To setup StatsD logging, it’s a matter of configuring the logger in your `superset_config.py`. -If not already present, you need to ensure that the `statsd`-package is installed in Superset's python environment. +By default, Superset also collects gunicorn [metrics](https://gunicorn.org/instrumentation/). +To enable these, the following environment variables should be set: Review Comment: **Suggestion:** The documentation says gunicorn metrics are collected "by default," but the startup script only enables statsd flags when `SERVER_STATSD_HOST` is set. This mismatch can mislead users into expecting metrics without configuration; update the wording to state metrics are optional and require those environment variables. [comment mismatch] <details> <summary><b>Severity Level:</b> Major ⚠️</summary> ```mdx - ⚠️ Admin docs misrepresent gunicorn metrics default behavior. - ⚠️ Operators may expect metrics without setting env vars. - ⚠️ Confusing guidance around StatsD and gunicorn setup. ``` </details> <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Open the documentation file `docs/admin_docs/configuration/event-logging.mdx` and navigate to lines 49–60 in the event logging section. 2. At line 53, observe the statement: `By default, Superset also collects gunicorn [metrics](https://gunicorn.org/instrumentation/).`, which asserts gunicorn metrics are collected without additional configuration. 3. At line 54, immediately following, observe: `To enable these, the following environment variables should be set:`, followed by the `SERVER_STATSD_*` variables, which implies metrics are not actually enabled until these are configured. 4. This internal contradiction in the same file (lines 53–60) demonstrates that the docs simultaneously claim metrics are enabled “by default” and yet require explicit environment variables, misleading readers about the real behavior of gunicorn metrics collection. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=5b613334560f4782b436228e737d82fd&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=5b613334560f4782b436228e737d82fd&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** docs/admin_docs/configuration/event-logging.mdx **Line:** 53:54 **Comment:** *Comment Mismatch: The documentation says gunicorn metrics are collected "by default," but the startup script only enables statsd flags when `SERVER_STATSD_HOST` is set. This mismatch can mislead users into expecting metrics without configuration; update the wording to state metrics are optional and require those environment variables. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F32487&comment_hash=bbfca229fb81d258bf10fb3672a583cf4b34b7c4bbab728d26335e65ec674ef4&reaction=like'>👍</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F32487&comment_hash=bbfca229fb81d258bf10fb3672a583cf4b34b7c4bbab728d26335e65ec674ef4&reaction=dislike'>👎</a> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
