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

Added documentation for fedmsg-hub #491

Closed
wants to merge 4 commits into from
Closed

Added documentation for fedmsg-hub #491

wants to merge 4 commits into from

Conversation

cha-ku
Copy link
Contributor

@cha-ku cha-ku commented Nov 3, 2017

#455 Added documentation to get all messages from fedmsg-hub after restart.

@codecov
Copy link

codecov bot commented Nov 3, 2017

Codecov Report

Merging #491 into develop will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #491   +/-   ##
========================================
  Coverage    60.95%   60.95%           
========================================
  Files           30       30           
  Lines         1939     1939           
  Branches       325      325           
========================================
  Hits          1182     1182           
  Misses         670      670           
  Partials        87       87

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0211e43...7eac7d5. Read the comment docs.

Copy link
Member

@jeremycline jeremycline left a comment

Choose a reason for hiding this comment

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

Hey, thanks for the pull request!

I've left a few comments inline. If you could squash your commits and write a commit message that includes fixes #455 as well as a more specific subject line that would be great.

@@ -215,13 +215,23 @@ Start the ``fedmsg-hub`` daemon, which will pick up the datanommer plugin,
which will in turn read in that connection string, start listening for
messages, and store them all in the db.


Copy link
Member

Choose a reason for hiding this comment

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

This whitespace change is unnecessary

::

$ sudo systemctl start fedmsg-hub
$ sudo systemctl enable fedmsg-hub

You can check ``journalctl --follow`` for logs.

Since fedmsg-hub stores the timestamp of the last message it had received
Copy link
Member

Choose a reason for hiding this comment

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

I think this would fit better in the subscribing documentation in the consumer section. Add a sub-section called "Message Replay" or something and include this.

Additionally, the first sentence is a fragment sentence. Something like:

"fedmsg-hub stores the timestamp of the last message it has received in a file in the /var/run/fedmsg/status/fedmsg-hub/. It uses this to replay messages it missed from the datagrepper service. To disable this functionality:"

@cha-ku cha-ku closed this Nov 15, 2017
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