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

Add documentation to rest_listen_uri #1847

Closed
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@Spitfire1900

Spitfire1900 commented Feb 22, 2016

rest_listen_uri is also applicable to collectors connecting to the server. The collectors send PUT hearbeat messages to the server's rest interface. (as of v1.3.3 and collector v0.4.2)

@lennartkoopmann

This comment has been minimized.

Member

lennartkoopmann commented Feb 22, 2016

Thank you!

I suggest changing it to:

If you are using Graylog Collectors to send logs, this address is also used to receive heartbeat messages and must be reachable by all collectors.

@bernd can you confirm that this is correct?

@joschi

This comment has been minimized.

Contributor

joschi commented Feb 22, 2016

This is also mentioned in the Graylog Collector documentation and there's even a troubleshooting item about this very issue: http://docs.graylog.org/en/1.3/pages/collector.html#unable-to-send-heartbeat

I'd prefer not to "pollute" the Graylog server config file with Graylog Collector specifics.

@lennartkoopmann

This comment has been minimized.

Member

lennartkoopmann commented Feb 22, 2016

IMO it is only one line and if it can avoid having to search for the FAQ in the first place I'd vote for including it.

@Spitfire1900

This comment has been minimized.

Spitfire1900 commented Feb 22, 2016

The unable to send heartbeat information is there but best case the configuration script that comes with the package should contain the information necessary to setup services. (barring the documentation site goes down or offline)

@lennartkoopmann 's addition is more descriptive but wordy, how about just:

This address is also used to receive heartbeat messages and must be reachable by all collectors.

?

@lennartkoopmann

This comment has been minimized.

Member

lennartkoopmann commented Feb 22, 2016

@Spitfire1900 The reason I suggested something more wordy was to make sure that people don't have to go on reading if they are not using collectors. Imagine reading this as someone who is not familiar with Graylog collectors yet. What do you think?

@Spitfire1900

This comment has been minimized.

Spitfire1900 commented Feb 22, 2016

@lennartkoopmann I can trim 24 characters and still retain the appropriate level of context.

When using Graylog Collectors, this address is used to receive heartbeat messages and must be reachable by all collectors.

@lennartkoopmann

This comment has been minimized.

Member

lennartkoopmann commented Feb 22, 2016

I like it! @joschi?

@joschi joschi closed this in b688452 Feb 23, 2016

@joschi

This comment has been minimized.

Contributor

joschi commented Feb 23, 2016

@Spitfire1900 Thanks! I've made the change with a slightly different wording and without changing the first line.

@joschi joschi self-assigned this Feb 23, 2016

@Spitfire1900 Spitfire1900 deleted the Spitfire1900:rest_listen_uri-documentation branch Feb 23, 2016

@Spitfire1900 Spitfire1900 restored the Spitfire1900:rest_listen_uri-documentation branch Feb 23, 2016

mariussturm added a commit that referenced this pull request Feb 25, 2016

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