Skip to content

Add rtsp monitor #5822

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

harrisonhjones
Copy link

@harrisonhjones harrisonhjones commented May 6, 2025

⚠️ Please Note: We do not accept all types of pull requests, and we want to ensure we don’t waste your time. Before submitting, make sure you have read our pull request guidelines: Pull Request Rules

❗ Important Announcement

Click here for more details:

🚧 Temporary Delay in Feature Requests and Pull Request Reviews

At this time, we may be slower to respond to new feature requests and review pull requests. Existing requests and PRs will remain in the backlog but may not be prioritized immediately.

  • Reason: Our current focus is on addressing bugs, improving system performance, and implementing essential updates. This will help stabilize the project and ensure smoother management.
  • Impact: While no new feature requests or pull requests are being outright rejected, there may be significant delays in reviews. We encourage the community to help by reviewing PRs or assisting other users in the meantime.
  • What You Can Do: If you're interested in contributing, reviewing open PRs by following our Review Guidelines or offering support to other users is greatly appreciated. All feature requests and PRs will be revisited once the suspension period is lifted.

We appreciate your patience and understanding as we continue to improve Uptime Kuma.

🚫 Please Avoid Unnecessary Pinging of Maintainers

We kindly ask you to refrain from pinging maintainers unless absolutely necessary. Pings are reserved for critical/urgent pull requests that require immediate attention.

Why: Reserving pings for urgent matters ensures maintainers can prioritize critical tasks effectively.

📋 Overview

Provide a clear summary of the purpose and scope of this pull request:

  • What problem does this pull request address?
    This PR (once complete) addresses RTSP (Real Time Streaming Protocol)) support #2851 by implementing a new monitoring type: RTSP. The goal is to give folks the ability to monitor their RTSP cameras and alert them when they go down.

The exact implementation seems fairly straight-forwarded (see the latest comment in the linked issue) but I wanted to run an idea past y'all before I implemented this: what about two "levels" of checking: simple (look for the RTSP/1.0 200 OK text) and "deep" (use ffprobe to look for actual video data). This would be implemented as a single RTSP monitoring type with a "simple | deep" toggle or "deep" checkbox (whichever is preferred). If we went with implementing the "deep" option we would need to add ffprobe to our list of deps I think (for the docker container). I'm unsure if we could install ffprobe just-in-time. Let me know what y'all think. Looking forward to helping out here.

  • What features or functionality does this pull request introduce or enhance?

  • A new RTSP monitoring type will be added

🔄 Changes

🛠️ Type of change

  • 🐛 Bugfix (a non-breaking change that resolves an issue)
  • ✨ New feature (a non-breaking change that adds new functionality)
  • ⚠️ Breaking change (a fix or feature that alters existing functionality in a way that could cause issues)
  • 🎨 User Interface (UI) updates
  • 📄 New Documentation (addition of new documentation)
  • 📄 Documentation Update (modification of existing documentation)
  • 📄 Documentation Update Required (the change requires updates to related documentation)
  • 🔧 Other (please specify):
    • Provide additional details here.

🔗 Related Issues

📄 Checklist *

  • 🔍 My code adheres to the style guidelines of this project.
  • ✅ I ran ESLint and other code linters for modified files.
  • 🛠️ I have reviewed and tested my code.
  • 📝 I have commented my code, especially in hard-to-understand areas (e.g., using JSDoc for methods).
  • ⚠️ My changes generate no new warnings.
  • 🤖 My code needed automated testing. I have added them (this is an optional task).
  • 📄 Documentation updates are included (if applicable).
  • 🔒 I have considered potential security impacts and mitigated risks.
  • 🧰 Dependency updates are listed and explained.
  • 📚 I have read and understood the Pull Request guidelines.

📷 Screenshots or Visual Changes

  • UI Modifications: Highlight any changes made to the user interface.
  • Before & After: Include screenshots or comparisons (if applicable).
Event Before After
UP Before After
DOWN Before After
Certificate-expiry Before After
Testing Before After

ℹ️ Additional Context

Provide any relevant details to assist reviewers in understanding the changes.

Click here for more details:

Key Considerations:

  • Design decisions – Key choices or trade-offs made during development.
  • Alternative solutions – Approaches considered but not implemented, along with reasons.
  • Relevant links – Specifications, discussions, or resources that provide context.
  • Dependencies – Related pull requests or issues that must be resolved before merging.
  • Additional context – Any other details that may help reviewers understand the changes.

Provide details here

💬 Requested Feedback

  • Mention documents needing feedback here

Sorry, something went wrong.

@CommanderStorm
Copy link
Collaborator

Lets do only simple at first.
This way, it is also testable.

For ffprobe you likely want to exatract an screenshot and dispaly it which is a lot of work.
=> splitting keeps it maintainable

@hemanth5544 hemanth5544 mentioned this pull request Jun 27, 2025
18 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.

RTSP (Real Time Streaming Protocol)) support
2 participants