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

Provide friendlier message for missing consumer startup #570

Open
jchristgit opened this issue May 2, 2024 · 0 comments
Open

Provide friendlier message for missing consumer startup #570

jchristgit opened this issue May 2, 2024 · 0 comments

Comments

@jchristgit
Copy link
Collaborator

Currently we emit the following message when no consumer was detected:

No consumers were running nor did any start up in time for shard session
startup. Is a consumer started as part of your supervision tree?

While this isn't bad, I think we would benefit from making this a bit more
user-friendly. For instance, people that are new to Elixir might not know how
to start the consumer as part of the supervision tree, or might have skipped
the docs for it by accident. Reading the README, we also currently only show
that you need to 1. install nostrum and 2. configure a bot token, but no
mention is made of having to configure the consumer. (I will open a separate
ticket for this)

We should update this message to be more clear and point to the README or
another example on how to properly start the consumer. For example:

No consumers were running nor did any start up in time for shard session startup.
nostrum's consumers receive events from the Discord Gateway, if no consumer is running, your bot will not receive any events.
Make sure that your application is starting a consumer as part of your supervision tree.
The documentation explains how to do this: https://hexdocs.pm/nostrum/intro.html#setup
If you're still unsure, feel free to ask for help on Discord: https://discord.gg/2Bgn8nW

Would be happy for other thoughts on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant