Skip to content

Add documentation for the environment variables dramatiq uses - #720

Merged
LincolnPuzey merged 3 commits into
Bogdanp:masterfrom
LincolnPuzey:env_var_docs
Jul 1, 2025
Merged

LincolnPuzey merged 3 commits into
Bogdanp:masterfrom
LincolnPuzey:env_var_docs

Conversation

@LincolnPuzey

Copy link
Copy Markdown
Collaborator

I figured this would be good to have for visibility/awareness of these.

Comment thread docs/source/reference.rst Outdated
- The number of messages to prefetch from the delay queue for each worker.
* - ``dramatiq_dead_message_ttl``
- 604800000 (One week)
- The maximum amount of time a message can be in the dead queue for the RabbitMQ Broker (in milliseconds).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The maximum amount of time a message can be in the dead queue for the RabbitMQ Broker (in milliseconds).
- The maximum amount of time a message can be in the dead letter queue for the RabbitMQ Broker (in milliseconds).

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Fixed

Comment thread docs/source/reference.rst Outdated
Comment on lines +265 to +267
* - ``dramatiq_prom_lock``
- tempfile.gettempdir()/dramatiq-prometheus.lock
- The path to the file to use to race Exposition servers against one another.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know much about Prometheus but this env var is assigned to the LOCK_PATH global which is then never used.

I'd say let's elide it here and sort it out separately (from my investigation - it was unused since 1ff83f5, though there was a change to getenv in #577).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LOCK_PATH removal here #722

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, have removed it from this PR

@synweap15 synweap15 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@LincolnPuzey
LincolnPuzey merged commit 731d858 into Bogdanp:master Jul 1, 2025
@LincolnPuzey
LincolnPuzey deleted the env_var_docs branch July 1, 2025 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants