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 needs clarifying around streaming-api server restarts #1326

Open
lambada opened this issue Nov 15, 2022 · 2 comments
Open

Documentation needs clarifying around streaming-api server restarts #1326

lambada opened this issue Nov 15, 2022 · 2 comments
Labels

Comments

@lambada
Copy link

lambada commented Nov 15, 2022

Steps to reproduce the problem

  1. Read the Upgrading your Instance Documentation at https://docs.joinmastodon.org/admin/upgrading/

    Rarely, the streaming API server is also updated and requires a restart:
    systemctl restart mastodon-streaming
    The streaming API server is updated very rarely, and in most releases, does not require a restart. Restarting the streaming API leads to an increased load on your server as disconnected clients attempt to reconnect or poll the REST API instead, so avoid it whenever you can.

  2. Look at the Release Notes of the last couple of release lines...
    Excluding backports to older versions, The following contain 'Restart all Mastodon processes'
  • 4.0.2
  • 4.0.0
  • 3.5.3
  • 3.5.2
  • 3.5.1
  • 3.5.0
    Whilst, excluding backports, the following releases do not say to 'restart all mastodon processes'
  • 4.0.1 does not, but it doesn't have any regular release notes covering the upgrade steps

Expected behaviour

The release notes should rarely say to update all processess

Actual behaviour

The release notes often say to update all processess

Detailed description

Are the release notes wrong in so often saying to restart 'all' mastodon processes, or should the docs be updated to reflect that restarting mastodon-streaming is perhaps more common than anticipated?

Specifications

Current live docs and release notes.

@lambada lambada added the bug label Nov 15, 2022
@ThisIsMissEm
Copy link
Contributor

@andypiper this should probably be moved to https://github.com/mastodon/documentation instead of the main project repo.

@andypiper
Copy link
Sponsor Member

@renchap could you move this to the documentation repo please? I don't have the ability to do that at present.

@renchap renchap transferred this issue from mastodon/mastodon Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants