tphakala / birdnet-go

Realtime BirdNET soundscape analyzer
Other
137 stars 14 forks source link

feat: Add initial retention policy #121

Closed isZumpo closed 2 months ago

isZumpo commented 2 months ago

As mentioned, I wanted to give the simple retention policy a try. Anything is better than nothing as my raspberry keeps running out of space otherwise. I am still trying out this change locally and might make some more changes to it. However, I thought it could still be a good idea to open up this pull request to get some feedback on the idea itself and the code.

The simple retention policy works by every minute, querying the database for clips older than minEvictionHours, for these clips, it will then remove those for species that have more than minClipsPerSpecies. Always removing the oldest clips first.

I am a bit uncertain of where to place all the logic. Right now I jammed it into the realtime.go and interface.go, but there might be better places to put it? In addition, it has to be decided if this is a feature which should be enabled by default or not. In addition, the spectrogram images are currently saved to the clips folder too, I wonder if it might be better to move them to some other cached directory?

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent update introduces a system for monitoring and automatically deleting clips based on a retention policy. This involves initializing the monitoring process, determining which clips qualify for deletion, and executing the removal process. Configuration settings have been updated to include parameters that define the retention criteria.

Changes

File Path Change Summary
internal/analysis/... Added functions for initializing and running clip cleanup monitoring.
internal/conf/config.go Updated Settings struct to include retention parameters.
internal/datastore/... Enhanced interface with methods for clip removal and added tests for new functionality.

🐇✨ In the burrow of the code, deep and wide, A cleanup crew now does reside. Old clips fade, new space is found, In digital fields, where bytes abound. Hop, skip, a jump in the code's weave, A tidy den, as we perceive. 🌟 🐇✨


Recent Review Details **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between 1659c9af57606639d11d05074800694a1422f1bf and 365730aade76a492367a0a302bbe418b8e49f958.
Files selected for processing (4) * internal/analysis/realtime.go (5 hunks) * internal/conf/config.go (2 hunks) * internal/datastore/interfaces.go (3 hunks) * internal/datastore/interfaces_test.go (1 hunks)
Additional Context Used
GitHub Check Runs (1)
lint failure (5)
internal/analysis/realtime.go: [failure] 179-179: Error return value of `dataStore.DeleteNoteClipPath` is not checked (errcheck) --- internal/datastore/interfaces_test.go: [failure] 38-38: Error return value of `dataStore.Save` is not checked (errcheck) --- internal/datastore/interfaces_test.go: [failure] 43-43: Error return value of `dataStore.Save` is not checked (errcheck) --- internal/datastore/interfaces_test.go: [failure] 48-48: Error return value of `dataStore.Save` is not checked (errcheck)
Additional comments not posted (3)
internal/datastore/interfaces_test.go (3)
`11-25`: Setup and teardown of the test database are handled correctly. --- `43-43`: Similar to the previous comment, the error return value of `dataStore.Save` is not checked here as well. --- `48-48`: Again, ensure to check the error return value from `dataStore.Save`.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
tphakala commented 2 months ago

Thank you, merged.

isZumpo commented 2 months ago

That went way quicker than expected. Suppose that we will have to work out those questions as we go instead.