[Bug 19542] New: Koha should display Elasticsearch information in the about page
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Bug ID: 19542 Summary: Koha should display Elasticsearch information in the about page Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: About Assignee: koha-bugs@lists.koha-community.org Reporter: tomascohen@gmail.com QA Contact: testopia@bugs.koha-community.org -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |tomascohen@gmail.com |ity.org | -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org QA Contact|testopia@bugs.koha-communit |nick@bywatersolutions.com |y.org | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Patch complexity|--- |Small patch Status|NEW |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #1 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 68861 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68861&action=edit Bug 19542: Add a check for ES configuration health This patch adds a new statuc function to Koha::SearchEngine::ElasticSearch which is instended to replace most of get_elasticsearch_params. This function reads the configuration from C4::Context->config('elasticsearch') and raises relevant exceptions when mandatory entries are missing. Its behaviour is covered by tests. To test: - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Sign off :-D -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #2 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 68862 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68862&action=edit Bug 19542: Add Elasticsearch information in the 'About' page This patch adds Elasticsearch related information to the 'About' page. The information is gathered and displayed only when the 'SearchEngine' syspref is set to 'Elasticsearch'. It displays configured nodes, and the status: - Running - Not running In case it is running, it displays the defined indices and the document count on each. If there are configuration problems, exceptions are catch and a convenient warning message is displayed. To test: - Apply this patches - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Have ES configured in your koha-conf.xml file (by default in kohadevbox) - Set the 'SearchEngine' syspref to 'Elasticsearch' - Comment out pieces of the elasticsearch-specific entries (server, index_name, the whole elasticsearch block). Reload on each change. => SUCCESS: Warning messages are displayed and make sense in the context of your changes. ----> the rest of the tests require having ES running on the dev env. This can be easily achieved by creating the kohadevbox using: $ KOHA_ELASTICSEARCH=1 vagrant up - Stop the 'elasticsearch' service: $ sudo service elasticsearch stop - Reload about.pl => SUCCESS: The configured nodes are displayed, and the status is 'not running' - Start the 'elasticsearch' service: $ sudo service elasticsearch start - Reload about.pl => SUCCESS: The configured nodes are displayed, the status is 'running' and created indices info is displayed, along with the document count on each index. - Sign off :-D -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #3 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 68863 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68863&action=edit Screenshot: running ES -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #4 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 68864 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68864&action=edit Screenshot: ES stopped -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 David Bourgault <david.bourgault@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 David Bourgault <david.bourgault@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #68861|0 |1 is obsolete| | --- Comment #5 from David Bourgault <david.bourgault@inlibro.com> --- Created attachment 68935 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68935&action=edit Bug 19542: Add a check for ES configuration health This patch adds a new statuc function to Koha::SearchEngine::ElasticSearch which is instended to replace most of get_elasticsearch_params. This function reads the configuration from C4::Context->config('elasticsearch') and raises relevant exceptions when mandatory entries are missing. Its behaviour is covered by tests. To test: - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Sign off :-D Signed-off-by: David Bourgault <david.bourgault@inlibro.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 David Bourgault <david.bourgault@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #68862|0 |1 is obsolete| | --- Comment #6 from David Bourgault <david.bourgault@inlibro.com> --- Created attachment 68936 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=68936&action=edit Bug 19542: Add Elasticsearch information in the 'About' page This patch adds Elasticsearch related information to the 'About' page. The information is gathered and displayed only when the 'SearchEngine' syspref is set to 'Elasticsearch'. It displays configured nodes, and the status: - Running - Not running In case it is running, it displays the defined indices and the document count on each. If there are configuration problems, exceptions are catch and a convenient warning message is displayed. To test: - Apply this patches - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Have ES configured in your koha-conf.xml file (by default in kohadevbox) - Set the 'SearchEngine' syspref to 'Elasticsearch' - Comment out pieces of the elasticsearch-specific entries (server, index_name, the whole elasticsearch block). Reload on each change. => SUCCESS: Warning messages are displayed and make sense in the context of your changes. ----> the rest of the tests require having ES running on the dev env. This can be easily achieved by creating the kohadevbox using: $ KOHA_ELASTICSEARCH=1 vagrant up - Stop the 'elasticsearch' service: $ sudo service elasticsearch stop - Reload about.pl => SUCCESS: The configured nodes are displayed, and the status is 'not running' - Start the 'elasticsearch' service: $ sudo service elasticsearch start - Reload about.pl => SUCCESS: The configured nodes are displayed, the status is 'running' and created indices info is displayed, along with the document count on each index. - Sign off :-D Signed-off-by: David Bourgault <david.bourgault@inlibro.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |barton@bywatersolutions.com --- Comment #7 from Nick Clemens <nick@bywatersolutions.com> --- *** Bug 18431 has been marked as a duplicate of this bug. *** -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #68935|0 |1 is obsolete| | Attachment #68936|0 |1 is obsolete| | --- Comment #8 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 69615 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69615&action=edit Bug 19542: Add a check for ES configuration health This patch adds a new statuc function to Koha::SearchEngine::ElasticSearch which is instended to replace most of get_elasticsearch_params. This function reads the configuration from C4::Context->config('elasticsearch') and raises relevant exceptions when mandatory entries are missing. Its behaviour is covered by tests. To test: - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Sign off :-D Signed-off-by: David Bourgault <david.bourgault@inlibro.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #9 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 69616 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69616&action=edit Bug 19542: Add Elasticsearch information in the 'About' page This patch adds Elasticsearch related information to the 'About' page. The information is gathered and displayed only when the 'SearchEngine' syspref is set to 'Elasticsearch'. It displays configured nodes, and the status: - Running - Not running In case it is running, it displays the defined indices and the document count on each. If there are configuration problems, exceptions are catch and a convenient warning message is displayed. To test: - Apply this patches - Run: $ kshell k$ prove t/Koha/SearchEngine/Elasticsearch.t => SUCCESS: Tests pass! - Have ES configured in your koha-conf.xml file (by default in kohadevbox) - Set the 'SearchEngine' syspref to 'Elasticsearch' - Comment out pieces of the elasticsearch-specific entries (server, index_name, the whole elasticsearch block). Reload on each change. => SUCCESS: Warning messages are displayed and make sense in the context of your changes. ----> the rest of the tests require having ES running on the dev env. This can be easily achieved by creating the kohadevbox using: $ KOHA_ELASTICSEARCH=1 vagrant up - Stop the 'elasticsearch' service: $ sudo service elasticsearch stop - Reload about.pl => SUCCESS: The configured nodes are displayed, and the status is 'not running' - Start the 'elasticsearch' service: $ sudo service elasticsearch start - Reload about.pl => SUCCESS: The configured nodes are displayed, the status is 'running' and created indices info is displayed, along with the document count on each index. - Sign off :-D Signed-off-by: David Bourgault <david.bourgault@inlibro.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #10 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 69617 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69617&action=edit Bug 19542 - QA Followup: Remove debug warn -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Failed QA --- Comment #11 from Nick Clemens <nick@bywatersolutions.com> --- Ah, QA test tools complain of POD coverage for Exceptions -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #12 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Created attachment 69699 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69699&action=edit Bug 19542: Use comma to separate indices Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #13 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 18.05, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |m.de.rooy@rijksmuseum.nl --- Comment #14 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- --- a/Koha/SearchEngine/Elasticsearch.pm +++ b/Koha/SearchEngine/Elasticsearch.pm @@ -22,6 +22,7 @@ use base qw(Class::Accessor); [...] +use Search::Elasticsearch; Hmm Can't locate Search/Elasticsearch.pm in @INC (you may need to install the Search::Elasticsearch module) (@INC contains: /usr/share/koha/masterclone /usr/share/koha/rma/lib /usr/share/koha/qa-tools /etc/perl /usr/local/lib/x86_64-linux-gnu/perl/5.20.2 /usr/local/share/perl/5.20.2 /usr/lib/x86_64-linux-gnu/perl5/5.20 /usr/share/perl5 /usr/lib/x86_64-linux-gnu/perl/5.20 /usr/share/perl/5.20 /usr/local/lib/site_perl .) at /usr/share/koha/masterclone/Koha/SearchEngine/Elasticsearch.pm line 33. BEGIN failed--compilation aborted at /usr/share/koha/masterclone/Koha/SearchEngine/Elasticsearch.pm line 33. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #15 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 69730 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69730&action=edit Bug 19542: (QA follow-up) Remove module Resolve: Can't locate Search/Elasticsearch.pm in @INC (you may need to install the Search::Elasticsearch module) By removing the module Search::Elasticsearch. Test plan: [1] Check if module compiles now [2] Running updatedatabase now passes Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #69730|0 |1 is obsolete| | --- Comment #16 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 69731 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69731&action=edit Bug 19542: (QA follow-up) Remove module Resolve: Can't locate Search/Elasticsearch.pm in @INC (you may need to install the Search::Elasticsearch module) By removing the module Search::Elasticsearch. Test plan: [1] Check if module compiles now [2] Running updatedatabase now passes Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 --- Comment #17 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Removing != commenting ;) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #69731|0 |1 is obsolete| | --- Comment #18 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Comment on attachment 69731 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=69731 Bug 19542: (QA follow-up) Remove module Removing this patch, since it is not a complete fix. But I still think this needs attention.. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|--- |FIXED Status|Pushed to Master |RESOLVED --- Comment #19 from Nick Clemens <nick@bywatersolutions.com> --- Awesome work all! Enhancement, skipping for 17.11 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19542 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |20061 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20061 [Bug 20061] koha-common is not pulling libsearch-elasticsearch-perl -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org