Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display info on repo usage/space remaining #629

Open
prettymuchbryce opened this issue Feb 6, 2018 · 5 comments
Open

Display info on repo usage/space remaining #629

prettymuchbryce opened this issue Feb 6, 2018 · 5 comments
Labels
effort/days Estimated to take multiple days, but less than a week exp/intermediate Prior experience is likely helpful help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design

Comments

@prettymuchbryce
Copy link

prettymuchbryce commented Feb 6, 2018

Is there any interest in some UI which displays how much space is remaining in the repo? I currently don't see this information available from anywhere within the UI.

We could use the /api/v0/stats/repo API to display some sort of bar for RepoSize / StorageMax.

@lidel
Copy link
Member

lidel commented Feb 14, 2018

Yup, actually, it is currently being designed! Status widget will be initially introduced in IPFS Desktop, but will eventually also land in WebUI (when we get back to refreshing it).

See initial mockup of such "stats gauge" at: ipfs/ipfs-gui#12 (comment) (last one).
FYI there are even more mockups for various parts of new UI Kit at ipfs/ipfs-gui#7 (comment) (note this is not final, just work in progress :))

@lidel lidel added the revamp label Jun 20, 2018
@olizilla olizilla added help wanted Seeking public contribution on this issue exp/intermediate Prior experience is likely helpful and removed revamp labels Sep 25, 2018
@olizilla
Copy link
Member

It'd be great to show the repo stats.

A good solution for this will need to take into account that the StorageMax value is a guide that indicates when ipfs should run GC on the repo to try and free some space. StorageMax is not a hard limit and if GC isn't enabled, it's entirely possible the reported RepoSize could exceed the StorageMax value, so we should visualise it in a way that shows that clearly with StorageMax as a threshold rather than a max value.

StorageMax A soft upper limit for the size of the ipfs repository's datastore. With StorageGCWatermark, is used to calculate whether to trigger a gc run (only if --enable-gc flag is set).

https://github.com/ipfs/go-ipfs/blob/1e0d53fe3cb32be903d768495fd0526002a03c63/docs/config.md#datastore

@olizilla olizilla changed the title repo stats Show repo stats Sep 28, 2018
@olizilla
Copy link
Member

Comment from @lidel in #887 (comment)


Here's an idea: replace CountryChart with a "StorageChart" – a pie chart composed from various sources:

  • RepoSize vs StorageMax from ipfs stats repo --size-only
  • CumulativeSize('/') from ipfs files stat / --size (and maybe lazy-loaded ipfs files stat / --size --with-local which is expensive)

How is this useful?

  • If GC is ON: You see actual size of your repo, available space etc.
    • Each segment could be clickable (cursor: help) and open docs explaining IPFS concepts (opportunity to improve docs, as we don't have "ipfs repository" on the concepts page yet)
    • Could be a good opportunity to identify missing APIs to make it even more useful.
  • If GC is OFF: People may have GC disabled but not know it. We could compare (StorageMax&RepoSize) and if RepoSize is bigger, use it as 100% and display the chunk over StorageMax in red. Clicking on it or hovering could display information about GC (how it works, how to enable it).

I would like to hear your thoughts on this.

@andrasfuchs
Copy link

@olizilla I agree, your suggestion would be more practical than the one we have now on the Status page.

I'm a newbie to IPFS, so I don't know if the following stats are available in IPFS or even possible to get, but I think it would be great to show these somewhere (probably on the Files page):

  • How much of my content (the files/folders pinned by me) was downloaded from my node
  • How many times were those files/folders pinned by others
  • How many of those others who have the files (the other seeders) are currently online
  • How many times were my IPNS entries accessed

@jessicaschilling
Copy link
Contributor

Related: ipfs/ipfs-gui#39 -- adding controls for node start/stop, bandwidth/size management.

@jessicaschilling jessicaschilling changed the title Show repo stats Display info on repo usage/space remaining Apr 8, 2020
@jessicaschilling jessicaschilling added effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design labels Apr 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/days Estimated to take multiple days, but less than a week exp/intermediate Prior experience is likely helpful help wanted Seeking public contribution on this issue kind/enhancement A net-new feature or improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/design-front-end Front-end implementation of UX/UI work topic/design-ux UX strategy, research, not solely visual design
Projects
No open projects
Status: Needs Grooming
Development

No branches or pull requests

5 participants