Plugin: Disk Usage Report

joeschmoe · 2024-10-14T10:03:58.081Z

I wrote this to figure out where most my space is going for my joplin notes since my notes are near 1gb in size. Thanks to this, I've been able to find and delete notes that consume space that I don't really care about

it creates a note with resources consumed. because I usually delete the note after, and there's no quick way to do this, I added a delete button on the note too. The delete button can be toggled in the settings.

Hope it's useful to someone else too.

joplinapp.org

Joplin Plugin: Joplin Disk Usage

display disk usage of resources for notebooks and notes

screenshot-1952×1048 44 KB

whitewall · 2024-10-14T20:16:31.120Z

Thank you so much for making this. It looks like it will be very useful!

I appreciate not only the work spent creating it but also the work to make it publicly available.

tonni · 2024-10-15T15:39:26.005Z

Many thanks for sharing this plugin. Much appreciated.

SteveShank · 2024-10-16T02:46:22.089Z

I also want to thank you. It is sweet. I have a question, though. Will deleting the note deleting any connected resources?

joeschmoe · 2024-10-16T04:19:12.990Z

it's like normally deleting a note. joplin deletes the resources with some scheduling incase there's an undo.

SteveShank · 2024-10-16T18:35:04.852Z

Then later today I'll get busy cleaning up my database and next week or the week after will empty my trash. Thank you.

badabing2005 · 2024-10-17T23:23:08.378Z

Thanks for the plugin and sharing.
If you don't mind some constructive feedback.

Clicking on it did not react at all, I thought it wasn't working or doing anything, so I switched notebooks and kept on clicking and trying different things to see if it would work. I have thousands of notes by the way, perhaps because of that it takes long.
I ended up with 8 reports so far and still ongoing, so some feedback or a progress indicator would be extremely useful.
Like I said, I have many thousand notes, so unless the disk usage is reverse sorted by size or there is some kind of summary it is impossible to go over the long list and try to spot the big disk consumers. in fact even scrolling through the note stutters, that's because it is so long.

Please don't take this negatively and keep up the good work.
Thanks

joeschmoe · 2024-10-18T01:14:41.527Z

badabing2005:

Clicking on it did not react at all, I thought it wasn't working or doing anything, so I switched notebooks and kept on clicking and trying different things to see if it would work. I have thousands of notes by the way, perhaps because of that it takes long.
I ended up with 8 reports so far and still ongoing, so some feedback or a progress indicator would be extremely useful.

Like I said, I have many thousand notes, so unless the disk usage is reverse sorted by size or there is some kind of summary it is impossible to go over the long list and try to spot the big disk consumers. in fact even scrolling through the note stutters, that's because it is so long.

how do you propose it give you feedback ?
it does do reverse sort by size

badabing2005 · 2024-10-18T01:30:39.172Z

I don't perhaps show a dialog, disable the button until the note is created ...
Anything to indicate that something is happening and not to be clicked again.

I'm not sure how this is reverse sorted by size.

image716×1217 91.9 KB

joeschmoe · 2024-10-18T04:23:52.079Z

badabing2005:

I'm not sure how this is reverse sorted by size.

the notebooks aren't sorted, but the resources are.

joeschmoe · 2024-10-18T05:31:35.926Z

badabing2005:

I'm not sure how this is reverse sorted by size.

I pushed a new version that also sorts the notebooks

ipsum · 2024-10-18T05:59:13.378Z

Thanks for putting in the work for this project. When the Joplin Android app started stalling during syncs I thought of searching the database to see if I'd inadvertently created a freakishly large note that was gumming up the works. But then I got distracted by a shiny object and, well, you know...

Two design suggestions: On the progress meter request perhaps the easiest approach would be to initially create a dummy report with simply "Now searching through the notes..." as its contents and then updating the note once the processing is complete. I don't personally see this as a high priority request, as once someone has used the plugin they'll know what to expect in the future. The slight delay before results appear could also be described in the plugin's description -- useful for those rare individuals who bother to read the instructions before using something.

As to the sorted results issue, I too was somewhat flummoxed by a generated TOC of notebooks that was sorted neither by size nor by name. It wasn't until I read through this thread that I realized the results were sorted by note size within each notebook. The TOC wouldn't have been confusing if I'd only had a few notebooks, but I had 60. I wound up copying the TOC as text, pasting it into an external editor, and then manually looking through the results for the largest notebooks. As someone who regularly monitors disk storage however I'm used to seeing a pie chart with the big picture and then drilling down into the details. So, yeah, a TOC sorted by notebook size would be nice improvement.

All that said, I must reiterate my thanks for creating this plugin. It is a useful addition to the plugin library.

UPDATE: Well, you sure addressed the notebook sorting issue quickly -- while I was composing the response. Nice one!

joeschmoe · 2024-10-18T06:35:15.971Z

ipsum:

create a dummy report with simply "Now searching through the notes..."

I'll see if this is possible since graying out the button isn't. Thanks !

joeschmoe · 2024-10-18T14:52:50.830Z

ipsum:

create a dummy report

I'm doing this in an annoying way, but Joplin is a bit lacking when it comes to refreshing. So there's a flicker as I create a temp note, delete it, and switch back to the current note after the update. But now you can see some waiting text in the next update

LarryN385 · 2024-10-20T00:49:53.635Z

Thank you for this very nice plugin and the work it took to create it.

I can be a bit thick at times so to mention some things I eventually realized

it's the pie chart icon at the top of the right panel that you click on
I found it easiest to position myself in a sub-Notebook I call "Meta Joplin Notes" where I keep my tips on how to use Joplin, etc.
I then rename the Joplin Disk Usage Report to have a colon and the date/time created at the end (if I want to keep before/after reports for reference)
I have a lot of notes and notebooks but not as many as some users I think, so it didn't take long for the report to be created for me. My largest notebook is 32.60 MB
I installed and am using your plugin version 1.3.1
THANKS AGAIN!!!

mzguy · 2024-11-14T15:27:46.197Z

I have a very large database with about 10K notes, many thousands of resources, and more than 10 GB total size. So, I'm the target audience for this plugin!

However, I find it unusable after installing. I would expect the plugin to take a while when running, but it completely froze my Joplin window for several minutes before I gave up. Restarts and safe mode didn't fix it, upon which I realized that attempting to render the disk usage note was causing the freeze. I fortunately was able to delete it without "rendering" it.

Not sure how easily this can be fixed. Perhaps there should be a limit on its size?

joeschmoe · 2024-11-14T16:42:09.311Z

Not sure how easily this can be fixed. Perhaps there should be a limit on its size?

I can see if I can run it completely asynchronously.

github.com/danielb2/joplin-du

locks up joplin when running on large number of notes

opened 04:44PM - 14 Nov 24 UTC

danielb2

> ... I find it unusable after installing. I would expect the plugin to take a w…hile when running, but it completely froze my Joplin window for several minutes before I gave up. Restarts and safe mode didn't fix it, upon which I realized that attempting to render the disk usage note was causing the freeze. I fortunately was able to delete it without "rendering" it. ref: https://discourse.joplinapp.org/t/plugin-disk-usage-report/41359/16

joeschmoe · 2024-11-14T17:34:59.523Z

can you try this one?

org.otherware.joplin-du.jpl (9 KB)