search

Islandora-Collaboration-Group / ISLE

Islandora Enterprise (ISLE) is a community project that addresses two of the most significant pain-points in Islandora: installation and maintenance.
https://Islandora-Collaboration-Group.github.io/ISLE/
GNU General Public License v3.0
32 stars 34 forks source link

Tailing fedoragsearch logs: path needs correction #425

Open dwk2 opened 3 years ago

dwk2 commented 3 years ago

Issue description

The helpful message to user contains an incorrect path. Below is the correct path.

For an issue, describe steps to reproduce the issue

ISLE 7, version 1.4.2. Docker status: containers are UP.

Steps:

  1. docker exec -it isle-fedora-ld bash
  2. cd /utility_scripts/
  3. ./updateSolrIndex.sh
  4. Command line displays the following helpful message (see "actual result", below)
What's the expected result?
What's the actual result?

Additional details / screenshots

20210507-0077

g7morris commented 3 years ago

Hi @dwk2

Thanks for the issue post and having reviewed perhaps the issue is that end-users should not expect output from the /usr/local/tomcat/logs/fedoragsearch.daily.logs? Technically the current message is correct as those are three different logs.

Please note that there is output to /usr/local/tomcat/logs/fgs-update-foxml.out and /usr/local/tomcat/logs/fgs-update-foxml.err as the utility script describes output here https://github.com/Islandora-Collaboration-Group/isle-fedora/blob/main/rootfs/utility_scripts/updateSolrIndex.sh#L11 These are ephemeral for the duration of the index. This output contains key information to the re-index process and can be used for debugging.

For more historical context, as of version 1.2, changes to this file in the Fedora Docker image https://github.com/Islandora-Collaboration-Group/isle-fedora/blob/main/rootfs/etc/confd/templates/gsearch/log4j.xml.tpl indicate that there is no output to a physical file unless the ISLE user overrides this setting via a config change to the Docker image or rebuilds the image.

Also as an aside, ISLE endusers can also change output levels in all *.envs here https://github.com/Islandora-Collaboration-Group/ISLE/blob/main/production.env#L221 but they'd still need to use a tool like TICK or to run docker-compose logs -f fedora to view the changed output while the utility process was still running.

The fedoragsearch.daily.log doesn't necessarily always contain this information though there is a degree of overlap as it does contain information about all objects being indexed, transforms etc which can be quite lengthy and granular in nature and context. In non-ISLE systems, I refer to them as server killers as they can grow to amazing sizes if left unchecked. Granted the information within them can be valuable for certain audiences but a decision was made early on to not use it for the default utility scripts (which are made up files for the output) given it could confuse endusers if a problem arose or complicate storage capacity. We needed light-weight no frills output that endusers could find easily.

Hoping I didn't miss the point of this issue, my apologies if I went off into the woods here. Perhaps my response / added context is what is actually missing for ISLE users per se?

Thanks, Gavin

dwk2 commented 3 years ago

Great information! TY! I think the issue here that I ran into is from the perspective of an ISLE user and when I saw (helpful!) text that said You can watch log file 'tail -f /usr/local/tomcat/logs/fgs-update-foxml.*' as the process runs. I figured that running that tail command should show me the output I wanted... Thus, my suggestion to simply change the path to one that provides output. Does that help clarify? Thanks for your attention to this (and so many other things, too). - David

g7morris commented 3 years ago

hi @dwk2 I'm not sure what we are clarifying at this point. The command indicates that there is a process running and that there is output. It may not be the output that you were expecting per se, so perhaps the documentation should be changed to say something like tailing /usr/local/tomcat/logs/fgs-update-foxml will show you output that the process is running or has completed with a possible example. If you are looking for more output these steps may be required e.g. using tick or docker-compose logs -f I'm not planning on updating documentation for the next round per se so perhaps this is something you and @marksandford could review please?

dwk2 commented 3 years ago

Sure - I'll consult w/ Mark. Thanks, David

On Tue, May 11, 2021 at 10:58 AM Gavin Morris @.***> wrote:

hi @dwk2 https://github.com/dwk2 I'm not sure what we are clarifying at this point. The command indicates that there is a process running and that there is output. It may not be the output that you were expecting per se, so perhaps the documentation should be changed to say something like tailing /usr/local/tomcat/logs/fgs-update-foxml will show you output that the process is running or has completed with a possible example. If you are looking for more output these steps may be required e.g. using tick or docker-compose logs -f I'm not planning on updating documentation for the next round per se so perhaps this is something you and @marksandford https://github.com/marksandford could review please?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Islandora-Collaboration-Group/ISLE/issues/425#issuecomment-838626301, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZQJX5LH3OOSRJAUJCNK63TNFAX5ANCNFSM44K4U7RQ .