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

Feature: system status #5743

Merged
merged 20 commits into from Mar 4, 2024
Merged

Feature: system status #5743

merged 20 commits into from Mar 4, 2024

Conversation

shamoon
Copy link
Member

@shamoon shamoon commented Feb 12, 2024

Proposed change

Seems like a useful but hopefully unobtrusive little thing to have. Im not totally certain about some of the methods for retrieving environment etc. but I got expected results when testing myself. Would be good to check that, false-positive errors (or false negatives) would suck.

No rush on this, happy to iterate.

Screenshot 2024-02-13 at 11 53 09 PM Screenshot 2024-02-13 at 11 54 45 PM Screenshot 2024-02-15 at 11 24 29 PM Screenshot 2024-02-13 at 11 35 05 PM Screenshot 2024-02-12 at 11 17 54 AM Screenshot 2024-02-13 at 11 56 51 PM

Closes #5704

Type of change

  • Bug fix: non-breaking change which fixes an issue.
  • New feature / Enhancement: non-breaking change which adds functionality. Please read the important note above.
  • Breaking change: fix or feature that would cause existing functionality to not work as expected.
  • Documentation only.
  • Other. Please explain:

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have included testing coverage for new code in this PR, for backend and / or front-end changes.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@shamoon shamoon requested review from a team as code owners February 12, 2024 21:17
@paperless-ngx-secretary paperless-ngx-secretary bot added backend frontend non-trivial Requires approval by several team members labels Feb 12, 2024
@shamoon shamoon added this to the Next Release milestone Feb 12, 2024
@github-actions github-actions bot added the enhancement New feature label Feb 12, 2024
src/documents/views.py Fixed Show fixed Hide fixed
Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.99%. Comparing base (23ceb2a) to head (42d9da1).

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #5743      +/-   ##
==========================================
+ Coverage   96.97%   96.99%   +0.02%     
==========================================
  Files         408      412       +4     
  Lines       16249    16376     +127     
  Branches     1180     1185       +5     
==========================================
+ Hits        15757    15884     +127     
  Misses        492      492              
Flag Coverage Δ
backend 95.74% <100.00%> (+0.03%) ⬆️
frontend 98.49% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shamoon shamoon marked this pull request as draft February 12, 2024 21:30
@shamoon shamoon marked this pull request as ready for review February 13, 2024 08:50
@noseshimself
Copy link

If possible, please add the underlying file system, too.

@shamoon
Copy link
Member Author

shamoon commented Feb 13, 2024

It displays the info for the /media/ storage.

@noseshimself
Copy link

It displays the info for the /media/ storage.

The size/free space info. I would really like to know (see my feature request 8-) ) whether the file system has certain features (e. g. external attributes) (or whether it was a good choice -- I know someone running on exFAT...). That would be good to know for you, too, if you decide to add a button "click here and copy it into a JSON structure to paste into a bug report" later.

@shamoon
Copy link
Member Author

shamoon commented Feb 13, 2024

Given most users are running inside docker I’m not sure how much of that is available to the python backend. In general the goal here is not to be a comprehensive stack inspector, just to alert the user of potential problems and the basics of their setup.

@Gendra13
Copy link

Would it make sense to include the status of the search index as well as the classification model?

@shamoon
Copy link
Member Author

shamoon commented Feb 14, 2024

Would it make sense to include the status of the search index as well as the classification model?

Great idea

Screenshot 2024-02-13 at 4 40 39 PM Screenshot 2024-02-13 at 4 40 30 PM

@shamoon shamoon force-pushed the feature-system-status branch 2 times, most recently from 840caef to ab9b5d5 Compare February 14, 2024 06:50
@shamoon shamoon removed this from the Next Release milestone Mar 1, 2024
src/documents/views.py Outdated Show resolved Hide resolved
src/documents/tests/test_api_status.py Show resolved Hide resolved
@shamoon
Copy link
Member Author

shamoon commented Mar 4, 2024

Thanks stumpy. Yea my thing with this one is a little unsure how it will behave in some environments (looking at you nixOS), may need some iterating...

@shamoon shamoon enabled auto-merge (squash) March 4, 2024 17:15
@shamoon shamoon added this to the Next Release milestone Mar 4, 2024
@shamoon shamoon merged commit f6084ac into dev Mar 4, 2024
30 checks passed
@shamoon shamoon deleted the feature-system-status branch March 4, 2024 17:26
philipcristiano added a commit to philipcristiano/nixos-cluster-config that referenced this pull request Mar 5, 2024
Copy link
Contributor

github-actions bot commented Apr 4, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns. See our contributing guidelines for more details.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backend enhancement New feature frontend non-trivial Requires approval by several team members
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants