logstash-plugins / logstash-output-elastic_app_search

Apache License 2.0
0 stars 9 forks source link

Improve documentation/error handling around use of `host` and `url` #21

Open robbavey opened 3 years ago

robbavey commented 3 years ago

When using this plugin, either host or url is required for the plugin to be able to connect to an appsearch instance.

The documentation for the individual configuration states that host is used with Elastic Appsearch managed service, and that url is used with self-managed Elastic Appsearch, but this is not surfaced earlier in the documentation, either explicitly or in an example configuration, which would likely prove helpful here.

Additionally, the error message surfaced to the user when they supply a configuration containing neither a host nor url setting is not helpful, providing no actionable information for the user:

[2020-10-19T17:42:17,378][ERROR][logstash.agent           ] Failed to execute action {:id=>:main, :action_type=>LogStash::ConvergeResult::FailedAction, :message=>"Could not execute action: PipelineAction::Create<main>, action_result: false", :backtrace=>nil}
ppf2 commented 3 years ago

I previously created a documentation PR related to this, would be great to get a review: https://github.com/logstash-plugins/logstash-output-elastic_app_search/pull/19 thx!

robbavey commented 3 years ago

cc @karenzone - the PR above created/linked by @ppf2 has some more additional information that will be helpful to users too