Skip to content

Added forecast alerts #1394

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

Merged
merged 1 commit into from
Jul 29, 2025
Merged

Added forecast alerts #1394

merged 1 commit into from
Jul 29, 2025

Conversation

parmesant
Copy link
Contributor

@parmesant parmesant commented Jul 29, 2025

Fixes #XXXX.

Description


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • New Features

    • Added support for a new alert type: Forecast.
  • Bug Fixes

    • Improved error messages for unsupported alert types, providing clearer guidance when certain alert types (such as Anomaly and Forecast) are not available in the open-source version.
  • Refactor

    • Unified error handling for unsupported alert types to ensure consistent user experience.

Copy link
Contributor

coderabbitai bot commented Jul 29, 2025

Walkthrough

A new alert type, Forecast, is introduced alongside updates to error handling for unsupported alert types in both the alert module and HTTP handler. Error reporting is unified by adding a NotPresentInOSS variant to AlertError, which is now used when encountering unsupported alert types like Anomaly and Forecast.

Changes

Cohort / File(s) Change Summary
Alert Type & Error Handling
src/alerts/mod.rs
Added Forecast to AlertType enum and its Display implementation. Introduced AlertError::NotPresentInOSS(String) for unsupported alert types, updated error handling in the load method, and mapped the new error to HTTP 400.
HTTP Handler Error Flow
src/handlers/http/alerts.rs
Updated the post function to handle both Anomaly and Forecast alert types by returning AlertError::NotPresentInOSS, replacing the previous generic error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant HTTP_Handler as HTTP Handler (`post`)
    participant AlertsModule as Alerts Module

    Client->>HTTP_Handler: POST /alerts (with alert type)
    HTTP_Handler->>AlertsModule: load(alert_type)
    alt alert_type is Threshold
        AlertsModule-->>HTTP_Handler: Success
        HTTP_Handler-->>Client: 200 OK
    else alert_type is Anomaly or Forecast
        AlertsModule-->>HTTP_Handler: AlertError::NotPresentInOSS(type)
        HTTP_Handler-->>Client: 400 Bad Request + error message
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Suggested labels

for next release

Poem

A forecast alert now joins the crew,
With errors handled neat and true.
If you seek what’s not OSS,
A gentle message will confess:
“Upgrade, dear friend, to see it through!”
— 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d307215 and 8c3e3cf.

📒 Files selected for processing (2)
  • src/alerts/mod.rs (4 hunks)
  • src/handlers/http/alerts.rs (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: nikhilsinhaparseable
PR: parseablehq/parseable#1388
File: src/alerts/mod.rs:88-104
Timestamp: 2025-07-24T11:09:21.781Z
Learning: In the Parseable alert system (src/alerts/mod.rs), alert versions are server-generated and controlled via CURRENT_ALERTS_VERSION constant, not user input. The AlertVerison enum's From<&str> implementation correctly defaults unknown versions to V2 since the server only generates known versions (v1, v2). Unknown versions would only occur in exceptional cases like file corruption, making the current fallback approach appropriate.
src/alerts/mod.rs (1)

Learnt from: nikhilsinhaparseable
PR: #1388
File: src/alerts/mod.rs:88-104
Timestamp: 2025-07-24T11:09:21.781Z
Learning: In the Parseable alert system (src/alerts/mod.rs), alert versions are server-generated and controlled via CURRENT_ALERTS_VERSION constant, not user input. The AlertVerison enum's From<&str> implementation correctly defaults unknown versions to V2 since the server only generates known versions (v1, v2). Unknown versions would only occur in exceptional cases like file corruption, making the current fallback approach appropriate.

src/handlers/http/alerts.rs (1)

Learnt from: nikhilsinhaparseable
PR: #1388
File: src/alerts/mod.rs:88-104
Timestamp: 2025-07-24T11:09:21.781Z
Learning: In the Parseable alert system (src/alerts/mod.rs), alert versions are server-generated and controlled via CURRENT_ALERTS_VERSION constant, not user input. The AlertVerison enum's From<&str> implementation correctly defaults unknown versions to V2 since the server only generates known versions (v1, v2). Unknown versions would only occur in exceptional cases like file corruption, making the current fallback approach appropriate.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
🔇 Additional comments (4)
src/alerts/mod.rs (3)

235-235: LGTM! Forecast alert type addition follows established patterns.

The new Forecast variant and its Display implementation are consistent with existing alert types and follow the established naming conventions.

Also applies to: 243-243


1363-1364: Well-designed error variant for OSS feature limitations.

The NotPresentInOSS error variant provides clear, actionable messaging to users about Enterprise-only features and maps to an appropriate HTTP status code.

Also applies to: 1389-1389


1470-1477: Excellent centralization of error handling for unsupported alert types.

The updated error handling using AlertError::NotPresentInOSS provides consistent messaging for both Anomaly and Forecast alert types not available in the OSS version.

src/handlers/http/alerts.rs (1)

85-89: Consistent error handling for unsupported alert types.

The updated error handling aligns with the centralized NotPresentInOSS error variant, providing consistent messaging for both Anomaly and the new Forecast alert types across the HTTP layer.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nitisht nitisht merged commit a8c1f80 into parseablehq:main Jul 29, 2025
13 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Aug 4, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants