tphakala / birdnet-go

Realtime BirdNET soundscape analyzer
Other
135 stars 13 forks source link

refactor: Major overhaul to audio clip retention methods, age and usa… #182

Closed tphakala closed 3 weeks ago

tphakala commented 3 weeks ago

…ge based policy options.

Retention settings have changed

New settings

Renamed settings

MaxAge support defining retention time like: 24h as in 24 hour 1w as in 1 week 3m as in 3 months 1y as in 1 year

Retention struct {
     Debug    bool       // true to enable retention debug
     Policy   string        // retention policy, "none", "age" or "usage"
     MaxAge   string    // maximum age of audio clips to keep
     MaxUsage string  // maximum disk usage percentage before cleanup
     MinClips int          // minimum number of clips per species to keep
}
coderabbitai[bot] commented 3 weeks ago

Walkthrough

The update transitions the audio clip retention system from a mode-based to a policy-based approach. Key changes include restructuring configuration parameters, adding new cleanup policies, and introducing utility functions for retention period parsing and file management. These modifications enhance flexibility in managing audio clip retention based on age, usage, and other criteria.

Changes

File(s) Change Summary
internal/analysis/realtime.go Updated clip cleanup logic to use specific retention policies instead of modes.
internal/conf/config.go, internal/conf/config.yaml, internal/conf/defaults.go Restructured retention settings, replacing mode and Enabled with policy, maxage, maxusage, and minclips.
internal/conf/utils.go Added ParseRetentionPeriod function to convert retention period strings into hours.
internal/diskmanager/file_utils.go Introduced shared file management functions and added fields to FileInfo struct.
internal/diskmanager/policy_age.go Implemented age-based cleanup policy for removing clips.
internal/diskmanager/policy_usage.go Introduced disk usage-based cleanup policy and supporting functions.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant RealtimeAnalysis
    participant Config
    participant DiskManager

    User->>RealtimeAnalysis: Initiate Analysis
    RealtimeAnalysis->>Config: Fetch Retention Policy
    Config-->>RealtimeAnalysis: Return Policy Details
    RealtimeAnalysis->>DiskManager: Trigger Cleanup Based on Policy
    alt Policy is "age"
        DiskManager->>DiskManager: Perform Age-Based Cleanup
    else Policy is "usage"
        DiskManager->>DiskManager: Perform Usage-Based Cleanup
    end
    DiskManager-->>RealtimeAnalysis: Cleanup Complete
    RealtimeAnalysis-->>User: Analysis Complete

Poem

In the realm of code so bright, Clips now fade with policy's might, Age and usage take their turn, As files in disk do twist and churn. Debugging paths now clear and true, A rabbit's joy in changes new! 🐇


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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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.