search

logstash-plugins / logstash-output-webhdfs

Web hdfs output for logstash
Apache License 2.0
28 stars 25 forks source link

Documentation error #9

Closed yachtsman60 closed 7 years ago

yachtsman60 commented 8 years ago

The Usage section states you supply the following configuration. "webhdfs { server => "127.0.0.1:50070" # (required) path => "/user/logstash/dt=%{+YYYY-MM-dd}/logstash-%{+HH}.log" # (required) user => "hue" # (required) }" But the synopsis states that you supply the following configuration. "webhdfs { host => ... path => ... user => ... }" I believe "host" is correct and "server" is incorrect and should be changed to read "host".

markwalkom commented 8 years ago

Good catch, care to make a PR? :D

The link to the doc is https://www.elastic.co/guide/en/logstash/current/plugins-outputs-webhdfs.html

yachtsman60 commented 8 years ago

Done, I think. I am new to GitHub so hope what I have done is correct.

From: markwalkom [mailto:notifications@github.com] Sent: 05 January 2016 23:49 To: logstash-plugins/logstash-output-webhdfs logstash-output-webhdfs@noreply.github.com Cc: yachtsman60 o.houseman@sky.com Subject: Re: [logstash-output-webhdfs] Documentation error (#9)

Good catch, care to make a PR? :D

The link to the doc is https://www.elastic.co/guide/en/logstash/current/plugins-outputs-webhdfs.html

— Reply to this email directly or view it on GitHub https://github.com/logstash-plugins/logstash-output-webhdfs/issues/9#issuecomment-169171591 . https://github.com/notifications/beacon/APzLKq_IoJYKvHLSgn7GHtD50pumsMFFks5pXE3wgaJpZM4G_PZW.gif

yachtsman60 commented 8 years ago

It also already looks to be correct in this file.

https://github.com/logstash-plugins/logstash-output-webhdfs/edit/master/lib/logstash/outputs/webhdfs.rb

From: markwalkom [mailto:notifications@github.com] Sent: 05 January 2016 23:49 To: logstash-plugins/logstash-output-webhdfs logstash-output-webhdfs@noreply.github.com Cc: yachtsman60 o.houseman@sky.com Subject: Re: [logstash-output-webhdfs] Documentation error (#9)

Good catch, care to make a PR? :D

The link to the doc is https://www.elastic.co/guide/en/logstash/current/plugins-outputs-webhdfs.html

— Reply to this email directly or view it on GitHub https://github.com/logstash-plugins/logstash-output-webhdfs/issues/9#issuecomment-169171591 . https://github.com/notifications/beacon/APzLKq_IoJYKvHLSgn7GHtD50pumsMFFks5pXE3wgaJpZM4G_PZW.gif

dstore-dbap commented 8 years ago

@yachtsman60 Thanks for taking the time and filing a pull request! As you already wrote, the doc error was fixed in commit 8e86cf0. Still need to check why the docs at https://www.elastic.co/guide/en/logstash/current/plugins-outputs-webhdfs.html are incorrect.

dstore-dbap commented 8 years ago

@markwalkom Am I right in supposing that the docs get automagically created from the doc section of the source file? Or do I need to update some other file as well?

camypaj commented 8 years ago

Hi @dstore-dbap, I can confirm that the problem is still there in live documentation (I learned the "hard" way). Additionally, I would remove the port from the example, because when I tried including the port, the plugin ended up connecting to "hostname:50070:50070" :)

dstore-dbap commented 8 years ago

@purbon Hi Pere! Do you have any idea or hint as to what will trigger an update of the current documentation at https://www.elastic.co/guide/en/logstash/current/plugins-outputs-webhdfs.html? Just had another issue with a user getting confused with the difference between online doc and current code.

Any help would be absolutley great ;)

dedemorton commented 7 years ago

The docs in current have the correct options now, so I'm closing this.