Difference between revisions of "Baloo/Debugging"

(Added general testing procedure)
m (Formatting)
Line 64: Line 64:
 
== General testing procedure ==
 
== General testing procedure ==
  
This procedure should provide you a cozy method to check if baloo is experiencing issues as well as files to attach to your bug reports. It assumes you have a single file that has failed indexing for whatever reason.
+
This procedure should provide you a cozy method to check if '''baloo''' is experiencing issues as well as files to attach to your bug reports. It assumes you have a single file that has failed indexing for whatever reason.
  
* Open two Konsole windows and tile one to the left (A) and the other to the right (B);
+
* Open two '''Konsole''' windows and tile one to the left (A) and the other to the right (B);
* On Konsole A, run <tt>balooctl monitor | tee -a baloomon.txt</tt> and leave it running, this should leave a log of a full index by the end of this procedure;
+
* On '''Konsole''' A, run <code>balooctl monitor | tee -a baloomon.txt</code> and leave it running, this should leave a log of a full index by the end of this procedure;
* On Konsole B, run <tt>balooctl status</tt>
+
* On '''Konsole''' B, run <code>balooctl status</code>
  
 
You should get output like the following if everything has already been indexed and one file failed:
 
You should get output like the following if everything has already been indexed and one file failed:
 +
{{Output|1=<nowiki>
 
Baloo File Indexer is running
 
Baloo File Indexer is running
 
Indexer state: Idle
 
Indexer state: Idle
Line 77: Line 78:
 
Files failed to index: 1
 
Files failed to index: 1
 
Current size of index is 10,00 MiB
 
Current size of index is 10,00 MiB
 +
</nowiki>}}
  
* If you do have a failed file, run <tt>balooctl failed | tee -a baloofailed.txt</tt> to show which file has failed on your terminal and append it to a file named baloofailed.txt. Then, manually check the file path and run <tt>balooshow /path/to/faulty/file | tee -a baloofailed.txt</tt> to append the debug information about the file;
+
* If you do have a failed file, run <code>balooctl failed | tee -a baloofailed.txt</code> to show which file has failed on your terminal and append it to a file named <tt>baloofailed.txt</tt>. Then, manually check the file path and run <code>balooshow /path/to/faulty/file | tee -a baloofailed.txt</code> to append the debug information about the file;
  
* On Konsole B, run <tt>balooctl purge</tt>;
+
* On '''Konsole''' B, run <code>balooctl purge</code>;
  
 
* See if there's anything on Konsole A running the monitor tool that seems suspicious, like if it's staggering at the failing file;
 
* See if there's anything on Konsole A running the monitor tool that seems suspicious, like if it's staggering at the failing file;
  
* By the end, on Konsole B, run <tt>balooctl status</tt> again, and on Konsole A cancel the monitoring with Ctrl+C.
+
* By the end, on Konsole B, run <code>balooctl status</code> again, and on Konsole A cancel the monitoring with <keycap>Ctrl+C</keycap>.
  
Is the file still failing to index? Then the issue is consistently reproducible, please report it over bugs.kde.org.
+
Is the file still failing to index? Then the issue is consistently reproducible, please report it over https://bugs.kde.org.
  
If the file is now indexing correctly, then it's not a consistently reproducible issue, but this might still indicate something to be worked on, requiring further reporting steps. Please report the issue over bugs.kde.org and follow any instructions the developers might ask of you.
+
If the file is now indexing correctly, then it's not a consistently reproducible issue, but this might still indicate something to be worked on, requiring further reporting steps. Please report the issue over https://bugs.kde.org and follow any instructions the developers might ask of you.
  
 
Remember to attach the generated files on your bug report!
 
Remember to attach the generated files on your bug report!
  
{{Note | If you have manually enabled the new systemd initialization, then you may also use <nowiki>journalctl -u plasma-baloorunner --output=cat > baloojournal.txt</nowiki> to create a log file of baloo.}}
+
{{Note | If you have manually enabled the new systemd initialization, then you may also use <nowiki>journalctl --unit plasma-baloorunner --output=cat > baloojournal.txt</nowiki> to create a log file of baloo.}}

Revision as of 04:04, 12 January 2021

Baloo is responsible for searching through files. Given that every system is quite different, and many different files can have different results, there can be some issues with Baloo. This page aims at helping you debug what exactly is going on and how to report the issue appropriately.

If you're in doubt, and not sure what is going on, please just file a bug and provide whatever information you feel may be appropriate. The developers will ask for more information and provide steps for you to follow.

Baloo is consuming too much CPU / RAM / Disk IO ?

The Baloo Project is responsible for many different parts of KDE. The developers need to know exactly which component is problematic. It would be best if you checked what the offending process is called.

KSysGuard and Plasma System Monitor should be able to tell CPU, RAM and disk usage for baloo processes, but KSysGuard requires you to manually add disk usage columns.

baloo_file

This process is responsible for scheduling the indexing of files and save the name of the file. If this process is consuming too much CPU or Disk IO, it's probably due to the initial indexing. Based on your hard drive speed, baloo_file is able to do somewhere between 100 to 1000 files per second. Depending on how many files you have, it could take a couple of minutes. It would be best to just wait for a couple of minutes.

You can check which files are currently being scanned with balooctl monitor and the current indexing status with balooctl status.

If you feel that you have been waiting for quite some time, and the baloo_file process is still consuming too much CPU or disk IO, please file a bug.


balooshow

The BalooShow tool is used to print debug information about a file.

   $ balooshow /home/vishesh/file.jpg
   4 /home/vishesh/file.jpg
           Width: 713
           Height: 955
           Photo X Dimension: 713
           Photo X Dimension: 955 

Please run this tool on the file which is not being found. It should print information similar to what is being printed above. If no information is printed, then please check the following

  1. The file is not in the list of exclude folders
  2. The baloo_file process is running.

Find by filename

balooshow -x displays additional information, including the terms that Dolphin's Find > by Filename search matches. For example,

 $ balooshow -x path/to/日本国_déjà_γενεος.txt`
 ...
 File Name Terms: Fdeja Ftxt Fγενεος deja txt γενεος

If you type more than one character in the Dolphin file browser's find by Filename field, it searches these terms anchored at the start, thus searching for "de", "γε", etc. should return this file.

baloosearch

The Baloosearch tool can be used to perform simple searches.

 $ baloosearch fire
   77040 /home/vishesh/kde5/src/qt5/qtimageformats/tests/shared/images/mng/fire.mng
   237751 /home/vishesh/Videos/Catching Fire Epic Review Special Edition.mp4
   237788 /home/vishesh/Videos/The Hunger Games Catching Fire (2013) [1080p]
   237790 /home/vishesh/Videos/fire.mp4
   53907 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/html/MediaController.cpp
   54051 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/html/HTMLMediaElement.cpp
   52257 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/platform/ThreadTimers.cpp
   52867 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/loader/NavigationScheduler.cpp
   53568 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/html/track/TrackListBase.cpp
   52255 /home/vishesh/kde5/src/qt5/qtwebkit/Source/WebCore/platform/Timer.cpp

You should try searching for the file with this command.

If the file is not found even though it is indexed, then please file a bug with the exact search term, and the relevant words in the file.

General testing procedure

This procedure should provide you a cozy method to check if baloo is experiencing issues as well as files to attach to your bug reports. It assumes you have a single file that has failed indexing for whatever reason.

  • Open two Konsole windows and tile one to the left (A) and the other to the right (B);
  • On Konsole A, run balooctl monitor | tee -a baloomon.txt and leave it running, this should leave a log of a full index by the end of this procedure;
  • On Konsole B, run balooctl status

You should get output like the following if everything has already been indexed and one file failed:

Baloo File Indexer is running
Indexer state: Idle
Total files indexed: 1.000
Files waiting for content indexing: 0
Files failed to index: 1
Current size of index is 10,00 MiB
  • If you do have a failed file, run balooctl failed | tee -a baloofailed.txt to show which file has failed on your terminal and append it to a file named baloofailed.txt. Then, manually check the file path and run balooshow /path/to/faulty/file | tee -a baloofailed.txt to append the debug information about the file;
  • On Konsole B, run balooctl purge;
  • See if there's anything on Konsole A running the monitor tool that seems suspicious, like if it's staggering at the failing file;
  • By the end, on Konsole B, run balooctl status again, and on Konsole A cancel the monitoring with Ctrl+C.

Is the file still failing to index? Then the issue is consistently reproducible, please report it over https://bugs.kde.org.

If the file is now indexing correctly, then it's not a consistently reproducible issue, but this might still indicate something to be worked on, requiring further reporting steps. Please report the issue over https://bugs.kde.org and follow any instructions the developers might ask of you.

Remember to attach the generated files on your bug report!

Note
If you have manually enabled the new systemd initialization, then you may also use journalctl --unit plasma-baloorunner --output=cat > baloojournal.txt to create a log file of baloo.

This page was last edited on 12 January 2021, at 04:04. Content is available under Creative Commons License SA 4.0 unless otherwise noted.