Compare commits

...
7 Commits
Author SHA1 Message Date
Nick RogersandGitHub 6791df7971 Fix ZMQ detector ignoring the endpoint in its device string (#24464)
CI / AMD64 Build (push) Waiting to run
CI / AMD64 Smoke Test (push) Blocked by required conditions
CI / ARM Build (push) Waiting to run
CI / Jetson Jetpack 6 (push) Waiting to run
CI / AMD64 Extra Build (push) Blocked by required conditions
CI / ARM Extra Build (push) Blocked by required conditions
CI / Synaptics Build (push) Blocked by required conditions
CI / Assemble and push default build (push) Blocked by required conditions
2026-09-24 15:44:07 -06:00
Josh HawkinsandGitHub 9664d9ceae Notices and status bar improvements (#24459)
* Notice and status bar improvements

Status bar problems added in the same pass got the same `Date.now()` id and overwrote each other, so usually only one showed. Messages now fall back to their text as the id. The desktop status bar shows the most severe message with a count of the rest that opens a popover listing all of them, and the mobile drawer stacks them vertically instead of placing them side by side.

Dismissing a notice hid it for good, so a detector that restarted again after a dismissal was never shown. Dismiss is replaced by acknowledge, which hides a notice until it happens again, and mute, which hides it permanently. Kinds that never repeat (config and stream checks, the update notice) can only be muted. `reopen_at_count` is removed since acknowledge covers the failed login case.

* move camera CPU warnings to notices

High ffmpeg and detect CPU warnings sat in the status bar with no way to dismiss them. They're now `ffmpeg_high_cpu` and `detect_high_cpu` notices, raised per episode by the same tracker as skipped detections. Also stop failed login attempts held from before an acknowledgement from reopening the notice.

* fix mypy and handle missing cpu stats in notices
2026-09-24 15:39:18 -06:00
Nick RogersandGitHub c959df32c9 Apple Silicon Macs via lighter: ONNX detector on the Neural Engine and media engine decode (#24453)
* Run ONNX models on a Mac's Neural Engine through lighter's plugin provider

lighter's lighter.sh/ane device places an ONNX Runtime plugin execution
provider in the container. When it is present, the ONNX session setup
registers it once and opens sessions on its Neural Engine device, the same
place CUDA, ROCm and OpenVINO are chosen, so the onnx detector (and any
model that is not pinned to the CPU) runs there with no configuration. The
hardware probe reports it as an onnx unit.

* docs: hardware decode on an Apple Silicon Mac under lighter

A community section on the video decoding page: lighter's lighter.sh/video
device, hwaccel_args -c:v h264_v4l2m2m, and why the Raspberry Pi presets
decode a single-stream camera in software. The detector docs link to it.

* docs: set the lighter decoder per camera when codecs are mixed

* docs: the ONNX detector on a Mac's Neural Engine under lighter

* Format the Neural Engine provider setup

* Fall back to the default providers when the Neural Engine cannot load a model

* Apple Silicon ffmpeg presets for lighter's media engine, recommended when it is present
2026-09-24 15:37:32 -06:00
dependabot[bot]GitHubdependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
c5889ef35f Bump image-size from 2.0.2 to 2.0.4 in /docs (#24462)
Bumps [image-size](https://github.com/image-size/image-size) from 2.0.2 to 2.0.4.
- [Release notes](https://github.com/image-size/image-size/releases)
- [Commits](https://github.com/image-size/image-size/commits)

---
updated-dependencies:
- dependency-name: image-size
  dependency-version: 2.0.4
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-09-24 13:48:50 -05:00
Josh HawkinsandGitHub 9443289112 bump onnxruntime, ruamel, and argcomplete (#24460) 2026-09-24 13:42:58 -05:00
007hacky007andGitHub 40f8ba1f7f Offer the full playback rate list on Safari (#24444)
CI / AMD64 Build (push) Canceled after 0s
CI / AMD64 Smoke Test (push) Canceled after 0s
CI / ARM Build (push) Canceled after 0s
CI / Jetson Jetpack 6 (push) Canceled after 0s
CI / AMD64 Extra Build (push) Canceled after 0s
CI / ARM Extra Build (push) Canceled after 0s
CI / Synaptics Build (push) Canceled after 0s
CI / Assemble and push default build (push) Canceled after 0s
2026-09-24 10:02:06 -05:00
markfrancisonlyandGitHub 397f5253a5 Rate events over at least one second (#24455)
* Rate events over at least one second

EventsPerSecond.eps() divided the event count by the time since start(),
which can be a few milliseconds right after a restart. Frames buffered
during an ffmpeg restart then report as 100+ fps, and the same happens to
the detector fps. Use a window of at least one second.

* Keep sub-second windows consistent

Floor the divisor at the window length when the window is shorter than a
second, so a caller with a sub-second window still gets its true rate.
2026-09-24 06:28:00 -06:00
54 changed files with 1769 additions and 739 deletions
+3 -3
View File
@@ -27,7 +27,7 @@ pydantic == 2.10.*
git+https://github.com/fbcotter/py3nvml#egg=py3nvml git+https://github.com/fbcotter/py3nvml#egg=py3nvml
pytz == 2025.* pytz == 2025.*
pyzmq == 27.1.* pyzmq == 27.1.*
ruamel.yaml == 0.18.* ruamel.yaml == 0.19.*
tzlocal == 5.2 tzlocal == 5.2
requests == 2.33.* requests == 2.33.*
types-requests == 2.32.* types-requests == 2.32.*
@@ -43,7 +43,7 @@ opencv-contrib-python == 4.11.0.*
scipy == 1.16.* scipy == 1.16.*
# OpenVino & ONNX # OpenVino & ONNX
openvino == 2025.4.* openvino == 2025.4.*
onnxruntime == 1.22.* onnxruntime == 1.30.*
# Embeddings # Embeddings
transformers == 4.45.* transformers == 4.45.*
# Generative AI # Generative AI
@@ -58,7 +58,7 @@ pyclipper == 1.4.*
shapely == 2.0.* shapely == 2.0.*
rapidfuzz==3.12.* rapidfuzz==3.12.*
# HailoRT # HailoRT
argcomplete==2.0.* argcomplete==3.7.*
contextlib2==0.6.* contextlib2==0.6.*
future==0.18.* future==0.18.*
netaddr==1.3.* netaddr==1.3.*
+3 -1
View File
@@ -18,9 +18,11 @@ Hardware acceleration arguments tell FFmpeg to decode your camera's video stream
See [the hardware acceleration docs](/configuration/hardware_acceleration_video.md) for details on setting up hardware acceleration for your GPU / iGPU, then select the preset that matches your hardware. See [the hardware acceleration docs](/configuration/hardware_acceleration_video.md) for details on setting up hardware acceleration for your GPU / iGPU, then select the preset that matches your hardware.
| Preset (YAML config) | UI Label | Usage | Notes | | Preset (YAML config) | UI Label | Usage | Notes |
| --------------------- | ----------------------- | --------------------------------- | --------------------------------------------------------------- | | ------------------------- | ----------------------- | --------------------------------------------- | --------------------------------------------------------------- |
| preset-rpi-64-h264 | Raspberry Pi (H.264) | 64-bit Raspberry Pi, H.264 stream | | | preset-rpi-64-h264 | Raspberry Pi (H.264) | 64-bit Raspberry Pi, H.264 stream | |
| preset-rpi-64-h265 | Raspberry Pi (H.265) | 64-bit Raspberry Pi, H.265 stream | | | preset-rpi-64-h265 | Raspberry Pi (H.265) | 64-bit Raspberry Pi, H.265 stream | |
| preset-apple-silicon-h264 | Apple Silicon (H.264) | Apple Silicon Mac under lighter, H.264 stream | Needs the `lighter.sh/video` device |
| preset-apple-silicon-h265 | Apple Silicon (H.265) | Apple Silicon Mac under lighter, H.265 stream | Needs the `lighter.sh/video` device |
| preset-vaapi | VAAPI (Intel/AMD GPU) | Intel or AMD GPU via VAAPI | Check the hwaccel docs to ensure the correct driver is selected | | preset-vaapi | VAAPI (Intel/AMD GPU) | Intel or AMD GPU via VAAPI | Check the hwaccel docs to ensure the correct driver is selected |
| preset-intel-qsv-h264 | Intel QuickSync (H.264) | Intel QuickSync, H.264 stream | If you have issues, use the VAAPI preset instead | | preset-intel-qsv-h264 | Intel QuickSync (H.264) | Intel QuickSync, H.264 stream | If you have issues, use the VAAPI preset instead |
| preset-intel-qsv-h265 | Intel QuickSync (H.265) | Intel QuickSync, H.265 stream | If you have issues, use the VAAPI preset instead | | preset-intel-qsv-h265 | Intel QuickSync (H.265) | Intel QuickSync, H.265 stream | If you have issues, use the VAAPI preset instead |
@@ -43,6 +43,10 @@ Frigate supports presets for optimal hardware accelerated video decoding:
- [RKNN](#rockchip-platform): Frigate can utilize the media engine in RockChip SOCs to accelerate video decoding. - [RKNN](#rockchip-platform): Frigate can utilize the media engine in RockChip SOCs to accelerate video decoding.
**Apple Silicon Mac** <CommunityBadge />
- [lighter](#apple-silicon-mac-lighter): Frigate can utilize the media engine in Apple Silicon Macs to accelerate video decoding, when running under the lighter container runtime.
**Other Hardware** **Other Hardware**
Depending on your system, these presets may not be compatible, and you may need to use manual hwaccel args to take advantage of your hardware. More information on hardware accelerated decoding for ffmpeg can be found here: https://trac.ffmpeg.org/wiki/HWAccelIntro Depending on your system, these presets may not be compatible, and you may need to use manual hwaccel args to take advantage of your hardware. More information on hardware accelerated decoding for ffmpeg can be found here: https://trac.ffmpeg.org/wiki/HWAccelIntro
@@ -533,3 +537,35 @@ output_args:
Make sure that your SoC supports hardware acceleration for your input stream and your input stream is h264 encoding. For example, if your camera streams with h264 encoding, your SoC must be able to de- and encode with it. If you are unsure whether your SoC meets the requirements, take a look at the datasheet. Make sure that your SoC supports hardware acceleration for your input stream and your input stream is h264 encoding. For example, if your camera streams with h264 encoding, your SoC must be able to de- and encode with it. If you are unsure whether your SoC meets the requirements, take a look at the datasheet.
::: :::
## Apple Silicon Mac (lighter)
[lighter](https://github.com/fieldwork-ai/lighter) is an open-source container runtime for macOS. It gives a container the Mac's media engine as a standard V4L2 decoder, backed by VideoToolbox, so Frigate decodes H.264 and H.265 streams in hardware with the ffmpeg it already ships. It works on M1 and newer Macs with lighter 0.9.2 or newer.
Give the container the video device. With Docker Compose:
```yaml {4-5}
services:
frigate:
...
devices:
- lighter.sh/video=all
```
Or with `docker run`, add `--device lighter.sh/video=all`.
Then set the preset for the codec your cameras stream. The decoder is specific to the codec, so if your cameras mix H.264 and H.265, set the preset for the most common codec globally and override it on the other cameras:
```yaml
ffmpeg:
hwaccel_args: preset-apple-silicon-h264
cameras:
garage: # an H.265 camera
ffmpeg:
hwaccel_args: preset-apple-silicon-h265
```
The presets decode on the media engine and encode the Birdseye restream and timelapses there too. Scaling to the detect resolution runs on the CPU, as ffmpeg's V4L2 decoders cannot scale.
lighter can also run object detection on the Mac's Neural Engine; see [Apple Neural Engine (lighter)](object_detectors.md#apple-neural-engine-lighter).
+21 -1
View File
@@ -34,6 +34,7 @@ Frigate supports multiple different detectors that work on different types of ha
**Apple Silicon** **Apple Silicon**
- [Apple Silicon](#apple-silicon-detector): Apple Silicon can run on M1 and newer Apple Silicon devices. - [Apple Silicon](#apple-silicon-detector): Apple Silicon can run on M1 and newer Apple Silicon devices.
- <CommunityBadge /> [ONNX](#apple-neural-engine-lighter): the ONNX detector runs on the Neural Engine of M1 and newer Macs when Frigate runs under the lighter container runtime.
**Intel** **Intel**
@@ -484,7 +485,7 @@ See [ONNX supported models](#onnx) for supported models, there are some caveats:
## ONNX ## ONNX
ONNX is an open format for building machine learning models, Frigate supports running ONNX models on CPU, OpenVINO, ROCm, and TensorRT. On startup Frigate will automatically try to use a GPU if one is available. ONNX is an open format for building machine learning models, Frigate supports running ONNX models on CPU, OpenVINO, ROCm, TensorRT, and a Mac's Neural Engine. On startup Frigate will automatically try to use a GPU if one is available.
:::info :::info
@@ -500,6 +501,9 @@ If the correct build is used for your GPU then the GPU will be detected and used
- Nvidia GPUs will automatically be detected and used with the ONNX detector in the `-tensorrt` Frigate image. - Nvidia GPUs will automatically be detected and used with the ONNX detector in the `-tensorrt` Frigate image.
- Jetson devices will automatically be detected and used with the ONNX detector in the `-tensorrt-jp6` Frigate image. - Jetson devices will automatically be detected and used with the ONNX detector in the `-tensorrt-jp6` Frigate image.
- **Apple Silicon Mac** <CommunityBadge />
- The Neural Engine will automatically be detected and used with the ONNX detector when Frigate runs under lighter with its Neural Engine device. See [Apple Neural Engine (lighter)](#apple-neural-engine-lighter).
::: :::
:::tip :::tip
@@ -515,6 +519,22 @@ models:
::: :::
### Apple Neural Engine (lighter) {#apple-neural-engine-lighter}
[lighter](https://github.com/fieldwork-ai/lighter) is an open-source container runtime for macOS. A container started with its `lighter.sh/ane` device gets an ONNX Runtime execution provider that runs models on the Mac's Neural Engine, and the ONNX detector uses it automatically, with the same models and configuration as on any other hardware. It works on M1 and newer Macs with lighter 0.9.2 or newer.
Give the Frigate container the Neural Engine device. With Docker Compose:
```yaml
services:
frigate:
image: ghcr.io/blakeblackshear/frigate:stable-standard-arm64
devices:
- lighter.sh/ane=all
```
Or with `docker run`, add `--device lighter.sh/ane=all`. Frigate then reports the Neural Engine under **Settings > System > Detection models**, and the ONNX detector's model loads on it. lighter can also decode camera streams on the Mac's media engine; see [Video Decoding](hardware_acceleration_video.md#apple-silicon-mac-lighter).
### Configuration {#configuration-onnx} ### Configuration {#configuration-onnx}
<ModelConfigDropdown detectorTitle="ONNX" models={objectDetectorsModels.onnx.models} /> <ModelConfigDropdown detectorTitle="ONNX" models={objectDetectorsModels.onnx.models} />
+11 -1
View File
@@ -78,6 +78,10 @@ Frigate supports multiple different detectors that work on different types of ha
**Apple Silicon** **Apple Silicon**
- [ONNX via lighter](#apple-silicon): The ONNX detector runs on the Neural Engine of M1 and newer Macs when Frigate runs in the lighter container runtime
- [Supports the same model architectures as the ONNX detector](../../configuration/object_detectors#apple-neural-engine-lighter)
- Runs inside the Frigate container, with no separate detector process to set up
- The recommended way to run Frigate on a Mac
- [Apple Silicon](#apple-silicon): Apple Silicon is usable on all M1 and newer Apple Silicon devices to provide efficient and fast object detection - [Apple Silicon](#apple-silicon): Apple Silicon is usable on all M1 and newer Apple Silicon devices to provide efficient and fast object detection
- [Supports primarily ssdlite and mobilenet model architectures](../../configuration/object_detectors#apple-silicon-detector) - [Supports primarily ssdlite and mobilenet model architectures](../../configuration/object_detectors#apple-silicon-detector)
- Runs well with any size models including large - Runs well with any size models including large
@@ -211,7 +215,13 @@ Inference is done with the `onnx` detector type. Speeds will vary greatly depend
### Apple Silicon ### Apple Silicon
With the [Apple Silicon](../configuration/object_detectors.md#apple-silicon-detector) detector Frigate can take advantage of the NPU in M1 and newer Apple Silicon. Frigate on a Mac is best run in the [lighter](https://github.com/fieldwork-ai/lighter) container runtime, where the [ONNX detector](../configuration/object_detectors.md#apple-neural-engine-lighter) runs on the Neural Engine of M1 and newer Macs from inside the Frigate container. There is no separate detector process to install or keep running, and the same container can decode video on the Mac's media engine.
| Name | YOLOv9 Inference Time | YOLO-NAS Inference Time | RF-DETR Inference Time |
| ---- | -------------------------------------- | ----------------------- | ---------------------- |
| M1 | t-320: 3.3 ms s-320: 7 ms s-640: 13 ms | 320: 6.6 ms | Nano-320: 38 ms |
Alternatively, with the [Apple Silicon](../configuration/object_detectors.md#apple-silicon-detector) detector Frigate can take advantage of the NPU in M1 and newer Apple Silicon.
:::warning :::warning
+1 -1
View File
@@ -184,6 +184,6 @@ Filters and masks only hide the incorrect result - they don't teach Frigate what
### Where do I see problems Frigate has detected? ### Where do I see problems Frigate has detected?
Open System > Health. The Notices list keeps a record of problems Frigate has found, and you can dismiss any entry to acknowledge it. Ongoing conditions, such as an offline camera or recordings deleted before their retention period, appear in the status bar for admins until they clear, and the status bar links to the Notices list while it has undismissed entries. On mobile, tap the warning icon in the bottom navigation bar to see them. Open System > Health. The Notices list keeps a record of problems Frigate has found. Acknowledge an entry to hide it until the problem happens again, or mute it to hide it for good. Hidden entries stay listed under Show hidden in the filter. Ongoing conditions, such as an offline camera or recordings deleted before their retention period, appear in the status bar for admins until they clear, and the status bar links to the Notices list while it has entries showing. On mobile, tap the warning icon in the bottom navigation bar to see them.
The Hardware section below the notices shows whether the detection hardware, hardware acceleration, and enrichment devices in your config were found and are being used, so a GPU that silently fell back to the CPU shows up as a warning. Run stream checks to probe every camera's streams for the same problems the camera wizard reports. The Hardware section below the notices shows whether the detection hardware, hardware acceleration, and enrichment devices in your config were found and are being used, so a GPU that silently fell back to the CPU shows up as a warning. Run stream checks to probe every camera's streams for the same problems the camera wizard reports.
+4 -4
View File
@@ -11375,15 +11375,15 @@
} }
}, },
"node_modules/image-size": { "node_modules/image-size": {
"version": "2.0.2", "version": "2.0.4",
"resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.2.tgz", "resolved": "https://registry.npmjs.org/image-size/-/image-size-2.0.4.tgz",
"integrity": "sha512-IRqXKlaXwgSMAMtpNzZa1ZAe8m+Sa1770Dhk8VkSsP9LS+iHD62Zd8FQKs8fbPiagBE7BzoFX23cxFnwshpV6w==", "integrity": "sha512-QRUkFFsRV/6fuESxb9Vkq+a0LkSrgKXuc2NEqfikiXxxN/G3tjWt5EVUlMaImRBZRZK/jRBEbYvpPYZL8t08Zw==",
"license": "MIT", "license": "MIT",
"bin": { "bin": {
"image-size": "bin/image-size.js" "image-size": "bin/image-size.js"
}, },
"engines": { "engines": {
"node": ">=16.x" "node": ">=18"
} }
}, },
"node_modules/immer": { "node_modules/immer": {
+82 -16
View File
@@ -4174,19 +4174,20 @@ paths:
Get notices, most severe first. Get notices, most severe first.
Args: Args:
include_dismissed: Also return dismissed notices, for the history view include_hidden: Also return acknowledged and muted notices, for the
hidden list
Returns: Returns:
The notices The notices
operationId: get_notices_notices_get operationId: get_notices_notices_get
parameters: parameters:
- name: include_dismissed - name: include_hidden
in: query in: query
required: false required: false
schema: schema:
type: boolean type: boolean
default: false default: false
title: Include Dismissed title: Include Hidden
responses: responses:
'200': '200':
description: Successful Response description: Successful Response
@@ -4221,16 +4222,16 @@ paths:
security: security:
- frigateAdminAuth: [] - frigateAdminAuth: []
x-required-role: admin x-required-role: admin
/notices/dismissed_checks: /notices/muted_checks:
get: get:
tags: tags:
- Notices - Notices
summary: Get Dismissed Checks summary: Get Muted Checks
description: |- description: |-
**Access:** Admin role required. **Access:** Admin role required.
Get the dismissed config and stream check rows, newest first. Get the muted config and stream check rows, newest first.
operationId: get_dismissed_checks_notices_dismissed_checks_get operationId: get_muted_checks_notices_muted_checks_get
responses: responses:
'200': '200':
description: Successful Response description: Successful Response
@@ -4240,16 +4241,16 @@ paths:
security: security:
- frigateAdminAuth: [] - frigateAdminAuth: []
x-required-role: admin x-required-role: admin
/notices/dismissed: /notices/hidden:
delete: delete:
tags: tags:
- Notices - Notices
summary: Purge Dismissed summary: Unhide All Notices
description: |- description: |-
**Access:** Admin role required. **Access:** Admin role required.
Delete every dismissed notice and check row so each can show again. Show every acknowledged and muted notice and check row again.
operationId: purge_dismissed_notices_dismissed_delete operationId: unhide_all_notices_notices_hidden_delete
responses: responses:
'200': '200':
description: Successful Response description: Successful Response
@@ -4259,18 +4260,83 @@ paths:
security: security:
- frigateAdminAuth: [] - frigateAdminAuth: []
x-required-role: admin x-required-role: admin
/notices/{notice_id}/dismiss: /notices/{notice_id}/acknowledge:
post: post:
tags: tags:
- Notices - Notices
summary: Dismiss Notice summary: Acknowledge Notice
description: |- description: |-
**Access:** Admin role required. **Access:** Admin role required.
Hide a notice or a config or stream check row. Hide a notice until it happens again.
It stays hidden if the same problem happens again. Config and stream check rows and the update notice never repeat, so they
operationId: dismiss_notice_notices__notice_id__dismiss_post can only be muted.
operationId: acknowledge_notice_notices__notice_id__acknowledge_post
parameters:
- name: notice_id
in: path
required: true
schema:
type: string
title: Notice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- frigateAdminAuth: []
x-required-role: admin
/notices/{notice_id}/mute:
post:
tags:
- Notices
summary: Mute Notice
description: |-
**Access:** Admin role required.
Hide a notice or a config or stream check row for good.
operationId: mute_notice_notices__notice_id__mute_post
parameters:
- name: notice_id
in: path
required: true
schema:
type: string
title: Notice Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- frigateAdminAuth: []
x-required-role: admin
/notices/{notice_id}/hidden:
delete:
tags:
- Notices
summary: Unhide Notice
description: |-
**Access:** Admin role required.
Show an acknowledged or muted notice or check row again.
operationId: unhide_notice_notices__notice_id__hidden_delete
parameters: parameters:
- name: notice_id - name: notice_id
in: path in: path
+2
View File
@@ -429,6 +429,8 @@ def ffmpeg_presets():
hwaccel_presets = [ hwaccel_presets = [
"preset-rpi-64-h264", "preset-rpi-64-h264",
"preset-rpi-64-h265", "preset-rpi-64-h265",
"preset-apple-silicon-h264",
"preset-apple-silicon-h265",
"preset-jetson-h264", "preset-jetson-h264",
"preset-jetson-h265", "preset-jetson-h265",
"preset-rkmpp", "preset-rkmpp",
+50 -22
View File
@@ -14,17 +14,18 @@ router = APIRouter(tags=[Tags.notices])
@router.get("/notices", dependencies=[Depends(require_role(["admin"]))]) @router.get("/notices", dependencies=[Depends(require_role(["admin"]))])
def get_notices(request: Request, include_dismissed: bool = False) -> JSONResponse: def get_notices(request: Request, include_hidden: bool = False) -> JSONResponse:
"""Get notices, most severe first. """Get notices, most severe first.
Args: Args:
include_dismissed: Also return dismissed notices, for the history view include_hidden: Also return acknowledged and muted notices, for the
hidden list
Returns: Returns:
The notices The notices
""" """
return JSONResponse( return JSONResponse(
content=request.app.notice_registry.active(include_dismissed=include_dismissed) content=request.app.notice_registry.active(include_hidden=include_hidden)
) )
@@ -34,37 +35,64 @@ def get_notice_stats(request: Request) -> JSONResponse:
return JSONResponse(content=request.app.notice_registry.stats()) return JSONResponse(content=request.app.notice_registry.stats())
@router.get( @router.get("/notices/muted_checks", dependencies=[Depends(require_role(["admin"]))])
"/notices/dismissed_checks", dependencies=[Depends(require_role(["admin"]))] def get_muted_checks(request: Request) -> JSONResponse:
) """Get the muted config and stream check rows, newest first."""
def get_dismissed_checks(request: Request) -> JSONResponse: return JSONResponse(content=request.app.notice_registry.muted_checks())
"""Get the dismissed config and stream check rows, newest first."""
return JSONResponse(content=request.app.notice_registry.dismissed_checks())
@router.delete("/notices/dismissed", dependencies=[Depends(require_role(["admin"]))]) @router.delete("/notices/hidden", dependencies=[Depends(require_role(["admin"]))])
def purge_dismissed(request: Request) -> JSONResponse: def unhide_all_notices(request: Request) -> JSONResponse:
"""Delete every dismissed notice and check row so each can show again.""" """Show every acknowledged and muted notice and check row again."""
request.app.notice_registry.purge_dismissed() request.app.notice_registry.unhide_all()
return JSONResponse( return JSONResponse(content={"success": True, "message": "Notices shown again"})
content={"success": True, "message": "Dismissed notices cleared"}
)
# model notice ids contain a slash, so the id is a path parameter # model notice ids contain a slash, so the id is a path parameter
@router.post( @router.post(
"/notices/{notice_id:path}/dismiss", "/notices/{notice_id:path}/acknowledge",
dependencies=[Depends(require_role(["admin"]))], dependencies=[Depends(require_role(["admin"]))],
) )
def dismiss_notice(request: Request, notice_id: str) -> JSONResponse: def acknowledge_notice(request: Request, notice_id: str) -> JSONResponse:
"""Hide a notice or a config or stream check row. """Hide a notice until it happens again.
It stays hidden if the same problem happens again. Config and stream check rows and the update notice never repeat, so they
can only be muted.
""" """
if not request.app.notice_registry.dismiss(notice_id): if not request.app.notice_registry.acknowledge(notice_id):
return JSONResponse( return JSONResponse(
content={"success": False, "message": "Notice not found"}, content={"success": False, "message": "Notice not found"},
status_code=404, status_code=404,
) )
return JSONResponse(content={"success": True, "message": "Notice dismissed"}) return JSONResponse(content={"success": True, "message": "Notice acknowledged"})
@router.post(
"/notices/{notice_id:path}/mute",
dependencies=[Depends(require_role(["admin"]))],
)
def mute_notice(request: Request, notice_id: str) -> JSONResponse:
"""Hide a notice or a config or stream check row for good."""
if not request.app.notice_registry.mute(notice_id):
return JSONResponse(
content={"success": False, "message": "Notice not found"},
status_code=404,
)
return JSONResponse(content={"success": True, "message": "Notice muted"})
@router.delete(
"/notices/{notice_id:path}/hidden",
dependencies=[Depends(require_role(["admin"]))],
)
def unhide_notice(request: Request, notice_id: str) -> JSONResponse:
"""Show an acknowledged or muted notice or check row again."""
if not request.app.notice_registry.unhide(notice_id):
return JSONResponse(
content={"success": False, "message": "Notice not found"},
status_code=404,
)
return JSONResponse(content={"success": True, "message": "Notice shown again"})
+51
View File
@@ -46,8 +46,42 @@ _PROVIDER_LABELS = {
"MIGraphXExecutionProvider": "MIGraphX", "MIGraphXExecutionProvider": "MIGraphX",
"OpenVINOExecutionProvider": "OpenVINO", "OpenVINOExecutionProvider": "OpenVINO",
"CPUExecutionProvider": "CPU", "CPUExecutionProvider": "CPU",
"LighterANE": "Neural Engine",
} }
# lighter (https://github.com/fieldwork-ai/lighter) places an ONNX Runtime plugin
# execution provider in a container started with --device lighter.sh/ane=all,
# which runs models on a Mac's Neural Engine; LIGHTER_ANE_EP names where it is
LIGHTER_ANE_EP_NAME = "LighterANE"
LIGHTER_ANE_LIBRARY = "/usr/lib/lighter/liblighter_ane_ep.so"
def get_lighter_ane_devices() -> list[Any]:
"""Get the Neural Engine devices lighter's provider offers, registering it once.
Returns:
The provider's ONNX Runtime devices, or an empty list without lighter's device
"""
library = os.environ.get("LIGHTER_ANE_EP", LIGHTER_ANE_LIBRARY)
if not os.path.exists(library):
return []
devices = [d for d in ort.get_ep_devices() if d.ep_name == LIGHTER_ANE_EP_NAME]
if not devices:
try:
ort.register_execution_provider_library(LIGHTER_ANE_EP_NAME, library)
except Exception as e:
logger.warning(
f"Failed to load the Neural Engine provider from {library}: {e}"
)
return []
devices = [d for d in ort.get_ep_devices() if d.ep_name == LIGHTER_ANE_EP_NAME]
return devices
def is_arm64_platform() -> bool: def is_arm64_platform() -> bool:
"""Check if we're running on an ARM platform.""" """Check if we're running on an ARM platform."""
@@ -689,6 +723,23 @@ def get_optimized_runner(
if rknn_path: if rknn_path:
return _record_runner(model_path, model_type, RKNNModelRunner(rknn_path)) return _record_runner(model_path, model_type, RKNNModelRunner(rknn_path))
if device != "CPU" and (ane_devices := get_lighter_ane_devices()):
sess_options = get_ort_session_options(model_type) or ort.SessionOptions()
sess_options.add_provider_for_devices(ane_devices, {})
try:
session = ort.InferenceSession(model_path, sess_options=sess_options)
except Exception as e:
logger.warning(
f"Failed to load {model_path} on the Neural Engine, using the default providers: {e}"
)
else:
return _record_runner(
model_path,
model_type,
ONNXModelRunner(session, model_type=model_type),
)
providers, options = get_ort_providers(device == "CPU", device, **kwargs) providers, options = get_ort_providers(device == "CPU", device, **kwargs)
if providers[0] == "CPUExecutionProvider": if providers[0] == "CPUExecutionProvider":
+15
View File
@@ -25,6 +25,7 @@ SYS_ROOT = "/sys"
DEV_ROOT = "/dev" DEV_ROOT = "/dev"
PROC_ROOT = "/proc" PROC_ROOT = "/proc"
ETC_ROOT = "/etc" ETC_ROOT = "/etc"
LIB_ROOT = "/usr/lib"
# a Coral reports as Global Unichip until its firmware is loaded, then as Google # a Coral reports as Global Unichip until its firmware is loaded, then as Google
CORAL_USB_IDS = {("1a6e", "089a"), ("18d1", "9302")} CORAL_USB_IDS = {("1a6e", "089a"), ("18d1", "9302")}
@@ -317,6 +318,19 @@ def detect_synaptics() -> DetectionHardware | None:
return _hardware("synaptics", "synaptics", "Synaptics NPU", units) return _hardware("synaptics", "synaptics", "Synaptics NPU", units)
def detect_lighter_ane() -> DetectionHardware | None:
"""Find a Mac's Neural Engine by the provider library lighter's device places."""
library = os.environ.get(
"LIGHTER_ANE_EP", f"{LIB_ROOT}/lighter/liblighter_ane_ep.so"
)
if not os.path.exists(library):
return None
# runs through onnx, whose session picks lighter's provider when it is present
units = [HardwareUnit(device="onnx", label="Neural Engine")]
return _hardware("onnx:lighter", "onnx", "Apple Neural Engine", units)
def detect_cpu() -> DetectionHardware: def detect_cpu() -> DetectionHardware:
"""The CPU, which is always available.""" """The CPU, which is always available."""
units = [HardwareUnit(device="cpu", label="CPU")] units = [HardwareUnit(device="cpu", label="CPU")]
@@ -338,6 +352,7 @@ PROBES = (
detect_rockchip, detect_rockchip,
detect_axengine, detect_axengine,
detect_synaptics, detect_synaptics,
detect_lighter_ane,
detect_cpu, detect_cpu,
) )
+2 -1
View File
@@ -1,7 +1,7 @@
import json import json
import logging import logging
import os import os
from typing import Any, Literal from typing import Any, ClassVar, Literal
import numpy as np import numpy as np
import zmq import zmq
@@ -21,6 +21,7 @@ class ZmqDetectorConfig(BaseDetectorConfig):
model_config = ConfigDict( model_config = ConfigDict(
title="ZMQ IPC", title="ZMQ IPC",
) )
device_spec_field: ClassVar[str] = "endpoint"
type: Literal[DETECTOR_KEY] type: Literal[DETECTOR_KEY]
endpoint: str = Field( endpoint: str = Field(
+9
View File
@@ -84,6 +84,8 @@ _user_agent_args = [
PRESETS_HW_ACCEL_DECODE = { PRESETS_HW_ACCEL_DECODE = {
"preset-rpi-64-h264": "-c:v:1 h264_v4l2m2m", "preset-rpi-64-h264": "-c:v:1 h264_v4l2m2m",
"preset-rpi-64-h265": "-c:v:1 hevc_v4l2m2m", "preset-rpi-64-h265": "-c:v:1 hevc_v4l2m2m",
"preset-apple-silicon-h264": "-c:v h264_v4l2m2m",
"preset-apple-silicon-h265": "-c:v hevc_v4l2m2m",
FFMPEG_HWACCEL_VAAPI: "-hwaccel_flags allow_profile_mismatch -hwaccel vaapi -hwaccel_device {3} -hwaccel_output_format vaapi", FFMPEG_HWACCEL_VAAPI: "-hwaccel_flags allow_profile_mismatch -hwaccel vaapi -hwaccel_device {3} -hwaccel_output_format vaapi",
"preset-intel-qsv-h264": f"-hwaccel qsv -qsv_device {{3}} -hwaccel_output_format qsv -c:v h264_qsv{' -bsf:v dump_extra' if LIBAVFORMAT_VERSION_MAJOR >= 61 else ''}", # https://trac.ffmpeg.org/ticket/9766#comment:17 "preset-intel-qsv-h264": f"-hwaccel qsv -qsv_device {{3}} -hwaccel_output_format qsv -c:v h264_qsv{' -bsf:v dump_extra' if LIBAVFORMAT_VERSION_MAJOR >= 61 else ''}", # https://trac.ffmpeg.org/ticket/9766#comment:17
"preset-intel-qsv-h265": f"-load_plugin hevc_hw -hwaccel qsv -qsv_device {{3}} -hwaccel_output_format qsv{' -bsf:v dump_extra' if LIBAVFORMAT_VERSION_MAJOR >= 61 else ''}", # https://trac.ffmpeg.org/ticket/9766#comment:17 "preset-intel-qsv-h265": f"-load_plugin hevc_hw -hwaccel qsv -qsv_device {{3}} -hwaccel_output_format qsv{' -bsf:v dump_extra' if LIBAVFORMAT_VERSION_MAJOR >= 61 else ''}", # https://trac.ffmpeg.org/ticket/9766#comment:17
@@ -120,6 +122,9 @@ PRESETS_HW_ACCEL_DECODE["preset-rk-h265"] = PRESETS_HW_ACCEL_DECODE[
PRESETS_HW_ACCEL_SCALE = { PRESETS_HW_ACCEL_SCALE = {
"preset-rpi-64-h264": "-r {0} -vf fps={0},scale={1}:{2}", "preset-rpi-64-h264": "-r {0} -vf fps={0},scale={1}:{2}",
"preset-rpi-64-h265": "-r {0} -vf fps={0},scale={1}:{2}", "preset-rpi-64-h265": "-r {0} -vf fps={0},scale={1}:{2}",
# ffmpeg's v4l2m2m decoders cannot scale, so frames are scaled on the CPU
"preset-apple-silicon-h264": "-r {0} -vf fps={0},scale={1}:{2}",
"preset-apple-silicon-h265": "-r {0} -vf fps={0},scale={1}:{2}",
FFMPEG_HWACCEL_VAAPI: "-r {0} -vf fps={0},scale_vaapi=w={1}:h={2},hwdownload,format=nv12", FFMPEG_HWACCEL_VAAPI: "-r {0} -vf fps={0},scale_vaapi=w={1}:h={2},hwdownload,format=nv12",
"preset-intel-qsv-h264": "-r {0} -vf vpp_qsv=w={1}:h={2}:format=nv12,hwdownload,format=nv12,fps={0},format=yuv420p", "preset-intel-qsv-h264": "-r {0} -vf vpp_qsv=w={1}:h={2}:format=nv12,hwdownload,format=nv12,fps={0},format=yuv420p",
"preset-intel-qsv-h265": "-r {0} -vf vpp_qsv=w={1}:h={2}:format=nv12,hwdownload,format=nv12,fps={0},format=yuv420p", "preset-intel-qsv-h265": "-r {0} -vf vpp_qsv=w={1}:h={2}:format=nv12,hwdownload,format=nv12,fps={0},format=yuv420p",
@@ -150,6 +155,8 @@ PRESETS_HW_ACCEL_SCALE["preset-rk-h265"] = PRESETS_HW_ACCEL_SCALE[FFMPEG_HWACCEL
PRESETS_HW_ACCEL_ENCODE_BIRDSEYE = { PRESETS_HW_ACCEL_ENCODE_BIRDSEYE = {
"preset-rpi-64-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m {2}", "preset-rpi-64-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m {2}",
"preset-rpi-64-h265": "{0} -hide_banner {1} -c:v hevc_v4l2m2m {2}", "preset-rpi-64-h265": "{0} -hide_banner {1} -c:v hevc_v4l2m2m {2}",
"preset-apple-silicon-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m {2}",
"preset-apple-silicon-h265": "{0} -hide_banner {1} -c:v h264_v4l2m2m {2}",
# -vaapi_device is required in addition to -hwaccel_device: this is the only # -vaapi_device is required in addition to -hwaccel_device: this is the only
# birdseye preset that uses hwupload, and ffmpeg 8 initializes filters before # birdseye preset that uses hwupload, and ffmpeg 8 initializes filters before
# the decoder creates a device, so hwupload cannot see an -hwaccel_device one. # the decoder creates a device, so hwupload cannot see an -hwaccel_device one.
@@ -184,6 +191,8 @@ PRESETS_HW_ACCEL_ENCODE_BIRDSEYE["preset-rk-h264"] = PRESETS_HW_ACCEL_ENCODE_BIR
PRESETS_HW_ACCEL_ENCODE_TIMELAPSE = { PRESETS_HW_ACCEL_ENCODE_TIMELAPSE = {
"preset-rpi-64-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m -pix_fmt yuv420p {2}", "preset-rpi-64-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m -pix_fmt yuv420p {2}",
"preset-rpi-64-h265": "{0} -hide_banner {1} -c:v hevc_v4l2m2m -pix_fmt yuv420p {2}", "preset-rpi-64-h265": "{0} -hide_banner {1} -c:v hevc_v4l2m2m -pix_fmt yuv420p {2}",
"preset-apple-silicon-h264": "{0} -hide_banner {1} -c:v h264_v4l2m2m -pix_fmt yuv420p {2}",
"preset-apple-silicon-h265": "{0} -hide_banner {1} -c:v hevc_v4l2m2m -pix_fmt yuv420p {2}",
FFMPEG_HWACCEL_VAAPI: "{0} -hide_banner -hwaccel vaapi -hwaccel_output_format vaapi -hwaccel_device {3} {1} -c:v h264_vaapi {2}", FFMPEG_HWACCEL_VAAPI: "{0} -hide_banner -hwaccel vaapi -hwaccel_output_format vaapi -hwaccel_device {3} {1} -c:v h264_vaapi {2}",
"preset-intel-qsv-h264": "{0} -hide_banner {1} -c:v h264_qsv -profile:v high -level:v 4.1 -async_depth:v 1 {2}", "preset-intel-qsv-h264": "{0} -hide_banner {1} -c:v h264_qsv -profile:v high -level:v 4.1 -async_depth:v 1 {2}",
"preset-intel-qsv-h265": "{0} -hide_banner {1} -c:v hevc_qsv -profile:v main -level:v 4.1 -async_depth:v 1 {2}", "preset-intel-qsv-h265": "{0} -hide_banner {1} -c:v hevc_qsv -profile:v main -level:v 4.1 -async_depth:v 1 {2}",
+8 -3
View File
@@ -195,15 +195,20 @@ class Notice(Model):
first_seen = DateTimeField() first_seen = DateTimeField()
last_seen = DateTimeField() last_seen = DateTimeField()
count = IntegerField(default=1) count = IntegerField(default=1)
dismissed_at = DateTimeField(null=True) # hidden until the next occurrence
acknowledged_at = DateTimeField(null=True)
# hidden for good
muted_at = DateTimeField(null=True)
class NoticeStats(Model): class NoticeStats(Model):
kind = CharField(null=False, primary_key=True, max_length=50) kind = CharField(null=False, primary_key=True, max_length=50)
occurrences = IntegerField(default=0) occurrences = IntegerField(default=0)
dismissals = IntegerField(default=0) acknowledgements = IntegerField(default=0)
mutes = IntegerField(default=0)
first_seen = DateTimeField() first_seen = DateTimeField()
last_seen = DateTimeField() last_seen = DateTimeField()
# watermarks for a future analytics reporter; unused until then # watermarks for a future analytics reporter; unused until then
reported_occurrences = IntegerField(default=0) reported_occurrences = IntegerField(default=0)
reported_dismissals = IntegerField(default=0) reported_acknowledgements = IntegerField(default=0)
reported_mutes = IntegerField(default=0)
+110 -43
View File
@@ -5,7 +5,7 @@ import threading
from collections.abc import Callable from collections.abc import Callable
from dataclasses import dataclass from dataclasses import dataclass
from datetime import datetime from datetime import datetime
from typing import Any from typing import Any, cast
from frigate.const import REPLAY_CAMERA_PREFIX from frigate.const import REPLAY_CAMERA_PREFIX
from frigate.models import Notice, NoticeStats from frigate.models import Notice, NoticeStats
@@ -77,9 +77,8 @@ class NoticeRegistry:
) -> None: ) -> None:
"""Insert a notice or count another occurrence of it. """Insert a notice or count another occurrence of it.
A dismissed notice stays dismissed when it is raised again, unless its Another occurrence shows an acknowledged notice again. A muted notice
kind sets reopen_at_count. A kind that should come back after a stays hidden.
dismissal gives each episode its own scope.
""" """
definition = NOTICE_KINDS.get(kind) definition = NOTICE_KINDS.get(kind)
@@ -112,7 +111,6 @@ class NoticeRegistry:
first_seen=now, first_seen=now,
last_seen=now, last_seen=now,
count=1, count=1,
dismissed_at=None,
) )
self._bump_occurrences(kind, 1, now) self._bump_occurrences(kind, 1, now)
@@ -175,7 +173,7 @@ class NoticeRegistry:
self._notify() self._notify()
def resolve_camera(self, camera: str) -> None: def resolve_camera(self, camera: str) -> None:
"""Drop the notices and check dismissals of a camera being deleted.""" """Drop the notices and check mutes of a camera being deleted."""
camera_kinds = [ camera_kinds = [
key key
for key, definition in NOTICE_KINDS.items() for key, definition in NOTICE_KINDS.items()
@@ -193,7 +191,7 @@ class NoticeRegistry:
) )
# a stream id names its camera first; a config id ends with camera.<name> # a stream id names its camera first; a config id ends with camera.<name>
for check in self.dismissed_checks(): for check in self.muted_checks():
check_id = check["id"] check_id = check["id"]
if check_id.startswith(f"stream:{camera}:") or ( if check_id.startswith(f"stream:{camera}:") or (
@@ -205,26 +203,50 @@ class NoticeRegistry:
if deleted: if deleted:
self._notify() self._notify()
def purge_dismissed(self) -> int: def acknowledge(self, row_id: str) -> bool:
"""Delete every dismissed row so each can show again. Returns how many.""" """Hide a notice until it happens again.
with self._lock:
return int(
Notice.delete().where(Notice.dismissed_at.is_null(False)).execute()
)
def dismiss(self, row_id: str) -> bool: Returns False for an unknown id or a kind that never repeats, such as
"""Hide a notice or check row for good. Returns False for an unknown id.""" a check row or the update notice.
"""
with self._lock: with self._lock:
existing = Notice.get_or_none(Notice.id == row_id) existing = Notice.get_or_none(Notice.id == row_id)
if existing is None: if existing is None:
# a check row gets a notice row only once it is dismissed return False
definition = NOTICE_KINDS.get(existing.kind)
if definition is None or not definition.counts_repeats:
return False
if existing.acknowledged_at is not None or existing.muted_at is not None:
return True
Notice.update(acknowledged_at=datetime.now().timestamp()).where(
Notice.id == row_id
).execute()
NoticeStats.update(acknowledgements=NoticeStats.acknowledgements + 1).where(
NoticeStats.kind == existing.kind
).execute()
self._notify()
return True
def mute(self, row_id: str) -> bool:
"""Hide a notice or check row for good. Returns False for an unknown id."""
now = datetime.now().timestamp()
with self._lock:
existing = Notice.get_or_none(Notice.id == row_id)
if existing is None:
# a check row gets a notice row only once it is muted
kind, _, scope = row_id.partition(":") kind, _, scope = row_id.partition(":")
if kind not in CHECK_KINDS or not scope: if kind not in CHECK_KINDS or not scope:
return False return False
now = datetime.now().timestamp()
Notice.create( Notice.create(
id=row_id, id=row_id,
kind=kind, kind=kind,
@@ -233,40 +255,78 @@ class NoticeRegistry:
first_seen=now, first_seen=now,
last_seen=now, last_seen=now,
count=1, count=1,
dismissed_at=now, muted_at=now,
) )
return True return True
if existing.dismissed_at is not None: if existing.muted_at is not None:
return True return True
if existing.kind not in NOTICE_KINDS: if existing.kind not in NOTICE_KINDS:
return False return False
Notice.update(dismissed_at=datetime.now().timestamp()).where( Notice.update(acknowledged_at=None, muted_at=now).where(
Notice.id == row_id Notice.id == row_id
).execute() ).execute()
NoticeStats.update(dismissals=NoticeStats.dismissals + 1).where( NoticeStats.update(mutes=NoticeStats.mutes + 1).where(
NoticeStats.kind == existing.kind NoticeStats.kind == existing.kind
).execute() ).execute()
self._notify() self._notify()
return True return True
def dismissed_checks(self) -> list[dict[str, Any]]: def unhide(self, row_id: str) -> bool:
"""Dismissed config and stream check rows, newest first.""" """Show an acknowledged or muted row again. Returns False for an unknown id."""
with self._lock:
existing = Notice.get_or_none(Notice.id == row_id)
if existing is None:
return False
if existing.kind in CHECK_KINDS:
Notice.delete_by_id(row_id)
return True
Notice.update(acknowledged_at=None, muted_at=None).where(
Notice.id == row_id
).execute()
self._notify()
return True
def unhide_all(self) -> None:
"""Show every acknowledged and muted row again."""
with self._lock:
for check in self.muted_checks():
Notice.delete_by_id(check["id"])
shown = (
Notice.update(acknowledged_at=None, muted_at=None)
.where(
Notice.acknowledged_at.is_null(False)
| Notice.muted_at.is_null(False)
)
.execute()
)
if shown:
self._notify()
def muted_checks(self) -> list[dict[str, Any]]:
"""Muted config and stream check rows, newest first."""
rows = ( rows = (
Notice.select() Notice.select()
.where(Notice.kind.in_(list(CHECK_KINDS))) .where(Notice.kind.in_(list(CHECK_KINDS)))
.order_by(Notice.dismissed_at.desc()) .order_by(Notice.muted_at.desc())
) )
return [{"id": row.id, "dismissed_at": row.dismissed_at} for row in rows] return [{"id": row.id, "muted_at": row.muted_at} for row in rows]
def active(self, include_dismissed: bool = False) -> list[dict[str, Any]]: def active(self, include_hidden: bool = False) -> list[dict[str, Any]]:
"""Notices most severe first, then most recent first. """Notices most severe first, then most recent first.
Args: Args:
include_dismissed: Also return dismissed notices, for the history view include_hidden: Also return acknowledged and muted notices, for the
hidden list
""" """
rows = [] rows = []
@@ -276,7 +336,9 @@ class NoticeRegistry:
if definition is None: if definition is None:
continue continue
if row.dismissed_at is not None and not include_dismissed: hidden = row.acknowledged_at is not None or row.muted_at is not None
if hidden and not include_hidden:
continue continue
rows.append( rows.append(
@@ -291,7 +353,9 @@ class NoticeRegistry:
"first_seen": row.first_seen, "first_seen": row.first_seen,
"last_seen": row.last_seen, "last_seen": row.last_seen,
"count": row.count, "count": row.count,
"dismissed_at": row.dismissed_at, "acknowledgeable": definition.counts_repeats,
"acknowledged_at": row.acknowledged_at,
"muted_at": row.muted_at,
} }
) )
@@ -309,11 +373,13 @@ class NoticeRegistry:
{ {
"kind": row.kind, "kind": row.kind,
"occurrences": row.occurrences, "occurrences": row.occurrences,
"dismissals": row.dismissals, "acknowledgements": row.acknowledgements,
"mutes": row.mutes,
"first_seen": row.first_seen, "first_seen": row.first_seen,
"last_seen": row.last_seen, "last_seen": row.last_seen,
"reported_occurrences": row.reported_occurrences, "reported_occurrences": row.reported_occurrences,
"reported_dismissals": row.reported_dismissals, "reported_acknowledgements": row.reported_acknowledgements,
"reported_mutes": row.reported_mutes,
} }
for row in NoticeStats.select() for row in NoticeStats.select()
if row.kind in NOTICE_KINDS if row.kind in NOTICE_KINDS
@@ -327,18 +393,18 @@ class NoticeRegistry:
last_seen: float, last_seen: float,
params: dict[str, Any], params: dict[str, Any],
) -> None: ) -> None:
# called with the lock held # called with the lock held; held repeats from before an acknowledgement
fields: dict[str, Any] = { # still count but leave the notice hidden
"count": row.count + count, still_acknowledged = row.acknowledged_at is not None and (
"last_seen": last_seen, last_seen <= cast(float, row.acknowledged_at)
"params": params, )
}
reopen_at = NOTICE_KINDS[kind].reopen_at_count
if reopen_at is not None and row.count < reopen_at <= row.count + count: Notice.update(
fields["dismissed_at"] = None count=row.count + count,
last_seen=last_seen,
Notice.update(**fields).where(Notice.id == row.id).execute() params=params,
acknowledged_at=row.acknowledged_at if still_acknowledged else None,
).where(Notice.id == row.id).execute()
self._bump_occurrences(kind, count, last_seen) self._bump_occurrences(kind, count, last_seen)
def _prune(self, kind: str, keep: int) -> None: def _prune(self, kind: str, keep: int) -> None:
@@ -362,7 +428,8 @@ class NoticeRegistry:
NoticeStats.create( NoticeStats.create(
kind=kind, kind=kind,
occurrences=count, occurrences=count,
dismissals=0, acknowledgements=0,
mutes=0,
first_seen=now, first_seen=now,
last_seen=now, last_seen=now,
) )
+10 -6
View File
@@ -28,9 +28,9 @@ class NoticeKind:
category: camera, detector, model, or system; a camera scope is a category: camera, detector, model, or system; a camera scope is a
camera name, and the UI shows it camera name, and the UI shows it
link: app route or absolute URL for the row, filled in from params link: app route or absolute URL for the row, filled in from params
counts_repeats: whether raising an existing notice counts another occurrence counts_repeats: whether raising an existing notice counts another
occurrence, which also shows an acknowledged notice again
batch_repeats: whether repeats wait in memory for the next flush batch_repeats: whether repeats wait in memory for the next flush
reopen_at_count: count at which a dismissed notice shows again
keep_latest: rows of this kind to keep; a new row drops the oldest keep_latest: rows of this kind to keep; a new row drops the oldest
reportable: whether a future analytics reporter may send this kind's counts reportable: whether a future analytics reporter may send this kind's counts
""" """
@@ -41,7 +41,6 @@ class NoticeKind:
link: str | None = None link: str | None = None
counts_repeats: bool = True counts_repeats: bool = True
batch_repeats: bool = False batch_repeats: bool = False
reopen_at_count: int | None = None
keep_latest: int | None = None keep_latest: int | None = None
reportable: bool = True reportable: bool = True
@@ -67,6 +66,12 @@ _KINDS = (
"camera", "camera",
link="/system#cameras", link="/system#cameras",
), ),
NoticeKind(
"ffmpeg_high_cpu", NoticeSeverity.warning, "camera", link="/system#cameras"
),
NoticeKind(
"detect_high_cpu", NoticeSeverity.warning, "camera", link="/system#cameras"
),
NoticeKind("shm_too_low", NoticeSeverity.warning, "system", link="/system#storage"), NoticeKind("shm_too_low", NoticeSeverity.warning, "system", link="/system#storage"),
# one row per user per burst; the login log lines carry the address # one row per user per burst; the login log lines carry the address
NoticeKind( NoticeKind(
@@ -75,10 +80,9 @@ _KINDS = (
"system", "system",
link="/logs", link="/logs",
batch_repeats=True, batch_repeats=True,
reopen_at_count=5,
keep_latest=100, keep_latest=100,
), ),
# one row per release, so a dismissal lasts until the next release # one row per release, so muting it lasts until the next release
NoticeKind( NoticeKind(
"update_available", "update_available",
NoticeSeverity.info, NoticeSeverity.info,
@@ -92,7 +96,7 @@ _KINDS = (
NOTICE_KINDS: dict[str, NoticeKind] = {kind.key: kind for kind in _KINDS} NOTICE_KINDS: dict[str, NoticeKind] = {kind.key: kind for kind in _KINDS}
# the Health tab builds config and stream check rows in the browser, so a notice # the Health tab builds config and stream check rows in the browser, so a notice
# row of these kinds only records a dismissal; its other fields are placeholders # row of these kinds only records a mute; its other fields are placeholders
CHECK_KINDS = frozenset({"config", "stream"}) CHECK_KINDS = frozenset({"config", "stream"})
+61 -15
View File
@@ -29,38 +29,59 @@ VERSION_REFRESH_S = 24 * 60 * 60
# a camera skipping at least this percent of its frames is falling behind # a camera skipping at least this percent of its frames is falling behind
SKIPPED_DETECTIONS_PCT = 5 SKIPPED_DETECTIONS_PCT = 5
# for at least this long before it becomes a notice # lifetime CPU averages at or above these are high; they match
SKIPPED_DETECTIONS_HOLD_S = 60 # CameraFfmpegThreshold.error and CameraDetectThreshold.error in the UI
FFMPEG_HIGH_CPU_PCT = 20
DETECT_HIGH_CPU_PCT = 40
# a camera stays over a threshold this long before it becomes a notice
EPISODE_HOLD_S = 60
# detectors warm up after a start; the status bar waits this long too # detectors warm up after a start; the status bar waits this long too
STARTUP_GRACE_S = 120 STARTUP_GRACE_S = 120
class SkippedDetectionsTracker: def cpu_average(cpu_usages: dict[str, Any], pid: int | None) -> float | None:
"""Finds cameras whose skipped share stays high long enough for a notice.""" """A process's CPU use averaged over its lifetime, or None if unknown."""
usage = cpu_usages.get(str(pid)) if pid else None
def __init__(self) -> None: try:
return float(usage["cpu_average"]) if usage else None
except (KeyError, TypeError, ValueError):
return None
class EpisodeTracker:
"""Finds cameras whose value stays over a threshold long enough for a notice."""
def __init__(self, threshold: float) -> None:
self._threshold = threshold
self._since: dict[str, float] = {} self._since: dict[str, float] = {}
self._raised: set[str] = set() self._raised: set[str] = set()
def update(self, cameras: dict[str, dict[str, Any]], now: float) -> list[str]: def update(self, values: dict[str, float | None], now: float) -> list[str]:
"""Return the cameras whose episode qualified on this sample.""" """Return the cameras whose episode qualified on this sample.
Args:
values: Each camera's current value, or None when it has none
now: Sample time in seconds
"""
qualified: list[str] = [] qualified: list[str] = []
# a removed camera that comes back starts a new episode # a removed camera that comes back starts a new episode
for camera in self._since.keys() - cameras.keys(): for camera in self._since.keys() - values.keys():
self._since.pop(camera) self._since.pop(camera)
self._raised.discard(camera) self._raised.discard(camera)
for camera, camera_stats in cameras.items(): for camera, value in values.items():
if camera_stats["skipped_pct"] < SKIPPED_DETECTIONS_PCT: if value is None or value < self._threshold:
self._since.pop(camera, None) self._since.pop(camera, None)
self._raised.discard(camera) self._raised.discard(camera)
continue continue
since = self._since.setdefault(camera, now) since = self._since.setdefault(camera, now)
if camera not in self._raised and now - since >= SKIPPED_DETECTIONS_HOLD_S: if camera not in self._raised and now - since >= EPISODE_HOLD_S:
self._raised.add(camera) self._raised.add(camera)
qualified.append(camera) qualified.append(camera)
@@ -80,7 +101,9 @@ class StatsEmitter(threading.Thread):
self.stop_event = stop_event self.stop_event = stop_event
self.hardware_stats = HardwareStats(config) self.hardware_stats = HardwareStats(config)
self.stats_history: list[dict[str, Any]] = [] self.stats_history: list[dict[str, Any]] = []
self.skipped_detections = SkippedDetectionsTracker() self.skipped_detections = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
self.ffmpeg_cpu = EpisodeTracker(FFMPEG_HIGH_CPU_PCT)
self.detect_cpu = EpisodeTracker(DETECT_HIGH_CPU_PCT)
# the shm notice's params as last sent, so only a change is written # the shm notice's params as last sent, so only a change is written
self._shm_checked = False self._shm_checked = False
@@ -227,15 +250,38 @@ class StatsEmitter(threading.Thread):
def _update_notices(self, stats: dict[str, Any], now: float) -> None: def _update_notices(self, stats: dict[str, Any], now: float) -> None:
"""Update notices based on current stats or time.""" """Update notices based on current stats or time."""
# skipped detections cameras = stats["cameras"]
# absent when CPU collection timed out or failed on this tick
cpu_usages = stats.get("cpu_usages", {})
if stats["service"]["uptime"] >= STARTUP_GRACE_S: if stats["service"]["uptime"] >= STARTUP_GRACE_S:
for camera in self.skipped_detections.update(stats["cameras"], now): # skipped detections
skipped = {
camera: camera_stats["skipped_pct"]
for camera, camera_stats in cameras.items()
}
for camera in self.skipped_detections.update(skipped, now):
raise_notice( raise_notice(
"skipped_detections", "skipped_detections",
scope=camera, scope=camera,
params={"pct": stats["cameras"][camera]["skipped_pct"]}, params={"pct": skipped[camera]},
) )
# high ffmpeg and detect CPU
for tracker, kind, pid_key in (
(self.ffmpeg_cpu, "ffmpeg_high_cpu", "ffmpeg_pid"),
(self.detect_cpu, "detect_high_cpu", "pid"),
):
averages = {
camera: cpu_average(cpu_usages, camera_stats.get(pid_key))
for camera, camera_stats in cameras.items()
}
for camera in tracker.update(averages, now):
raise_notice(kind, scope=camera, params={"cpu": averages[camera]})
# shm too small for the cameras # shm too small for the cameras
self._update_shm_notice(stats["service"]["storage"]["/dev/shm"]) self._update_shm_notice(stats["service"]["storage"]["/dev/shm"])
+60 -44
View File
@@ -53,92 +53,108 @@ class TestHttpNotices(BaseTestHttp):
self.assertEqual(response.json()[0]["kind"], "detector_stuck") self.assertEqual(response.json()[0]["kind"], "detector_stuck")
self.assertEqual(response.json()[0]["occurrences"], 1) self.assertEqual(response.json()[0]["occurrences"], 1)
def test_dismiss_hides_and_history_keeps_it(self): def test_acknowledge_hides_and_the_hidden_list_keeps_it(self):
self.registry.raise_notice( self.registry.raise_notice(
"detector_stuck", scope="ov", params={"detector": "ov"} "detector_stuck", scope="ov", params={"detector": "ov"}
) )
with self.client() as client: with self.client() as client:
response = client.post("/notices/detector_stuck:ov/dismiss") response = client.post("/notices/detector_stuck:ov/acknowledge")
listed = client.get("/notices").json() listed = client.get("/notices").json()
history = client.get("/notices", params={"include_dismissed": True}).json() hidden = client.get("/notices", params={"include_hidden": True}).json()
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(listed, []) self.assertEqual(listed, [])
self.assertEqual([n["id"] for n in history], ["detector_stuck:ov"]) self.assertEqual([n["id"] for n in hidden], ["detector_stuck:ov"])
self.assertIsNotNone(history[0]["dismissed_at"]) self.assertIsNotNone(hidden[0]["acknowledged_at"])
def test_dismiss_an_id_with_a_slash(self): def test_acknowledging_a_check_is_404(self):
with self.client() as client:
response = client.post(f"/notices/{CONFIG_CHECK}/acknowledge")
self.assertEqual(response.status_code, 404)
def test_mute_an_id_with_a_slash(self):
self.registry.raise_notice( self.registry.raise_notice(
"model_download_failed", scope="yolo/model.onnx", params={} "model_download_failed", scope="yolo/model.onnx", params={}
) )
with self.client() as client: with self.client() as client:
response = client.post( response = client.post(
"/notices/model_download_failed:yolo/model.onnx/dismiss" "/notices/model_download_failed:yolo/model.onnx/mute"
) )
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(self.registry.active(), []) self.assertEqual(self.registry.active(), [])
def test_dismiss_unknown_is_404(self): def test_unknown_ids_are_404(self):
with self.client() as client: with self.client() as client:
response = client.post("/notices/nope/dismiss") responses = [
client.post("/notices/nope/acknowledge"),
client.post("/notices/nope/mute"),
client.delete("/notices/nope/hidden"),
]
self.assertEqual(response.status_code, 404) self.assertEqual([r.status_code for r in responses], [404, 404, 404])
def test_requires_admin(self): def test_requires_admin(self):
viewer = {"remote-user": "viewer", "remote-role": "viewer"}
with TestClient(self.app) as client: with TestClient(self.app) as client:
response = client.get( responses = [
"/notices", headers={"remote-user": "viewer", "remote-role": "viewer"} client.get("/notices", headers=viewer),
) client.get("/notices/muted_checks", headers=viewer),
client.post("/notices/detector_stuck:ov/acknowledge", headers=viewer),
client.post("/notices/detector_stuck:ov/mute", headers=viewer),
client.delete("/notices/detector_stuck:ov/hidden", headers=viewer),
client.delete("/notices/hidden", headers=viewer),
]
self.assertEqual(response.status_code, 403) self.assertEqual([r.status_code for r in responses], [403] * 6)
def test_dismissed_checks_are_listed_once(self): def test_muted_checks_are_listed_once(self):
with self.client() as client: with self.client() as client:
first = client.post(f"/notices/{CONFIG_CHECK}/dismiss") first = client.post(f"/notices/{CONFIG_CHECK}/mute")
again = client.post(f"/notices/{CONFIG_CHECK}/dismiss") again = client.post(f"/notices/{CONFIG_CHECK}/mute")
listed = client.get("/notices/dismissed_checks").json() listed = client.get("/notices/muted_checks").json()
history = client.get("/notices", params={"include_dismissed": True}).json() hidden = client.get("/notices", params={"include_hidden": True}).json()
self.assertEqual(first.status_code, 200) self.assertEqual(first.status_code, 200)
self.assertEqual(again.status_code, 200) self.assertEqual(again.status_code, 200)
self.assertEqual([check["id"] for check in listed], [CONFIG_CHECK]) self.assertEqual([check["id"] for check in listed], [CONFIG_CHECK])
self.assertIsNotNone(listed[0]["dismissed_at"]) self.assertIsNotNone(listed[0]["muted_at"])
# the Health tab builds the row itself, so it never comes back as a notice # the Health tab builds the row itself, so it never comes back as a notice
self.assertEqual(history, []) self.assertEqual(hidden, [])
def test_dismissed_checks_require_admin(self): def test_unhide_one_row(self):
with TestClient(self.app) as client:
response = client.get(
"/notices/dismissed_checks",
headers={"remote-user": "viewer", "remote-role": "viewer"},
)
self.assertEqual(response.status_code, 403)
def test_purge_dismissed_clears_notices_and_checks(self):
self.registry.raise_notice( self.registry.raise_notice(
"detector_stuck", scope="ov", params={"detector": "ov"} "detector_stuck", scope="ov", params={"detector": "ov"}
) )
self.registry.dismiss("detector_stuck:ov") self.registry.mute("detector_stuck:ov")
self.registry.dismiss(CONFIG_CHECK) self.registry.mute(CONFIG_CHECK)
with self.client() as client: with self.client() as client:
response = client.delete("/notices/dismissed") notice = client.delete("/notices/detector_stuck:ov/hidden")
history = client.get("/notices", params={"include_dismissed": True}).json() check = client.delete(f"/notices/{CONFIG_CHECK}/hidden")
checks = client.get("/notices/dismissed_checks").json() listed = client.get("/notices").json()
checks = client.get("/notices/muted_checks").json()
self.assertEqual(response.status_code, 200) self.assertEqual([notice.status_code, check.status_code], [200, 200])
self.assertEqual(history, []) self.assertEqual([n["id"] for n in listed], ["detector_stuck:ov"])
self.assertEqual(checks, []) self.assertEqual(checks, [])
def test_purge_dismissed_requires_admin(self): def test_unhide_all_shows_notices_and_drops_check_mutes(self):
with TestClient(self.app) as client: self.registry.raise_notice(
response = client.delete( "detector_stuck", scope="ov", params={"detector": "ov"}
"/notices/dismissed",
headers={"remote-user": "viewer", "remote-role": "viewer"},
) )
self.registry.acknowledge("detector_stuck:ov")
self.registry.mute(CONFIG_CHECK)
self.assertEqual(response.status_code, 403) with self.client() as client:
response = client.delete("/notices/hidden")
listed = client.get("/notices").json()
checks = client.get("/notices/muted_checks").json()
self.assertEqual(response.status_code, 200)
self.assertEqual([n["id"] for n in listed], ["detector_stuck:ov"])
self.assertEqual(checks, [])
+25
View File
@@ -36,6 +36,31 @@ class TestEventsPerSecond(unittest.TestCase):
clock[0] += 100.0 clock[0] += 100.0
self.assertEqual(eps.eps(), 0.0) self.assertEqual(eps.eps(), 0.0)
def test_burst_after_start_is_not_divided_by_a_tiny_window(self) -> None:
eps = EventsPerSecond(last_n_seconds=10)
clock = [1000.0]
with patch("frigate.util.builtin.time.monotonic", side_effect=lambda: clock[0]):
eps.start()
# eleven buffered frames arrive within 100 ms of starting
for _ in range(11):
clock[0] += 0.01
eps.update()
# 11 events over less than a second is at most 11 per second
self.assertLessEqual(eps.eps(), 11.0)
def test_subsecond_window_keeps_its_rate(self) -> None:
eps = EventsPerSecond(last_n_seconds=0.5)
clock = [1000.0]
with patch("frigate.util.builtin.time.monotonic", side_effect=lambda: clock[0]):
eps.start()
# twenty events per second for two seconds
for _ in range(40):
clock[0] += 0.05
eps.update()
# read between events, so none sits exactly on the window edge
clock[0] += 0.01
self.assertAlmostEqual(eps.eps(), 20.0)
if __name__ == "__main__": if __name__ == "__main__":
unittest.main() unittest.main()
+5
View File
@@ -59,6 +59,10 @@ class TestBuildDetectorConfig(unittest.TestCase):
def test_detectors_that_name_the_field_something_else(self): def test_detectors_that_name_the_field_something_else(self):
self.assertEqual(self._build("cpu:4").num_threads, 4) self.assertEqual(self._build("cpu:4").num_threads, 4)
self.assertEqual(self._build("rknn:2").num_cores, 2) self.assertEqual(self._build("rknn:2").num_cores, 2)
self.assertEqual(
self._build("zmq:tcp://host.docker.internal:5555").endpoint,
"tcp://host.docker.internal:5555",
)
def test_device_is_coerced_to_the_detector_field_type(self): def test_device_is_coerced_to_the_detector_field_type(self):
self.assertEqual(self._build("tensorrt:1").device, 1) self.assertEqual(self._build("tensorrt:1").device, 1)
@@ -66,6 +70,7 @@ class TestBuildDetectorConfig(unittest.TestCase):
def test_omitted_device_falls_back_to_the_detector_default(self): def test_omitted_device_falls_back_to_the_detector_default(self):
self.assertEqual(self._build("cpu").num_threads, 3) self.assertEqual(self._build("cpu").num_threads, 3)
self.assertEqual(self._build("rknn").num_cores, 0) self.assertEqual(self._build("rknn").num_cores, 0)
self.assertEqual(self._build("zmq").endpoint, "ipc:///tmp/cache/zmq_detector")
self.assertEqual(self._build("openvino").device, "AUTO") self.assertEqual(self._build("openvino").device, "AUTO")
self.assertIsNone(self._build("edgetpu").device) self.assertIsNone(self._build("edgetpu").device)
+24 -1
View File
@@ -25,7 +25,7 @@ class HardwareProbeTestCase(unittest.TestCase):
self.root = tempfile.TemporaryDirectory() self.root = tempfile.TemporaryDirectory()
self.addCleanup(self.root.cleanup) self.addCleanup(self.root.cleanup)
for name in ("SYS_ROOT", "DEV_ROOT", "PROC_ROOT", "ETC_ROOT"): for name in ("SYS_ROOT", "DEV_ROOT", "PROC_ROOT", "ETC_ROOT", "LIB_ROOT"):
sub = os.path.join(self.root.name, name.split("_")[0].lower()) sub = os.path.join(self.root.name, name.split("_")[0].lower())
os.makedirs(sub, exist_ok=True) os.makedirs(sub, exist_ok=True)
patcher = patch.object(hardware, name, sub) patcher = patch.object(hardware, name, sub)
@@ -167,6 +167,29 @@ class TestNvidia(HardwareProbeTestCase):
class TestAccelerators(HardwareProbeTestCase): class TestAccelerators(HardwareProbeTestCase):
def test_the_neural_engine_is_found_by_lighters_provider_library(self):
write(os.path.join(self.lib_root, "lighter", "liblighter_ane_ep.so"))
with patch.dict(os.environ, clear=False) as env:
env.pop("LIGHTER_ANE_EP", None)
ane = self.probe()["onnx:lighter"]
self.assertEqual(ane.detector, "onnx")
self.assertEqual(ane.units[0].device, "onnx")
self.assertEqual(ane.units[0].label, "Neural Engine")
def test_the_neural_engine_is_found_where_lighter_ane_ep_points(self):
library = os.path.join(self.root.name, "elsewhere", "liblighter_ane_ep.so")
write(library)
with patch.dict(os.environ, {"LIGHTER_ANE_EP": library}):
self.assertIn("onnx:lighter", self.probe())
def test_no_neural_engine_is_reported_without_the_library(self):
with patch.dict(os.environ, clear=False) as env:
env.pop("LIGHTER_ANE_EP", None)
self.assertNotIn("onnx:lighter", self.probe())
def test_hailo_is_found_by_its_device_node(self): def test_hailo_is_found_by_its_device_node(self):
write(os.path.join(self.dev_root, "hailo0")) write(os.path.join(self.dev_root, "hailo0"))
+10
View File
@@ -51,6 +51,16 @@ class TestFfmpegPresets(unittest.TestCase):
" ".join(frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"]) " ".join(frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"])
) )
def test_ffmpeg_hwaccel_apple_preset_decodes_every_stream(self):
self.default_ffmpeg["cameras"]["back"]["ffmpeg"]["hwaccel_args"] = (
"preset-apple-silicon-h265"
)
frigate_config = FrigateConfig(**self.default_ffmpeg)
cmd = " ".join(frigate_config.cameras["back"].ffmpeg_cmds[0]["cmd"])
assert "-c:v hevc_v4l2m2m" in cmd
assert "-c:v:1" not in cmd
assert "scale=1920:1080" in cmd
def test_ffmpeg_hwaccel_not_preset(self): def test_ffmpeg_hwaccel_not_preset(self):
self.default_ffmpeg["cameras"]["back"]["ffmpeg"]["hwaccel_args"] = ( self.default_ffmpeg["cameras"]["back"]["ffmpeg"]["hwaccel_args"] = (
"-other-hwaccel args" "-other-hwaccel args"
@@ -34,6 +34,12 @@ class HwaccelRecommendationTestCase(unittest.TestCase):
patcher.start() patcher.start()
self.addCleanup(patcher.stop) self.addCleanup(patcher.stop)
self.sys_root = os.path.join(self.root.name, "sys")
os.makedirs(self.sys_root)
patcher = patch.object(hwaccel, "SYS_ROOT", self.sys_root)
patcher.start()
self.addCleanup(patcher.stop)
drm = patch.object(hwaccel, "enumerate_drm_devices", return_value={}) drm = patch.object(hwaccel, "enumerate_drm_devices", return_value={})
self.drm = drm.start() self.drm = drm.start()
self.addCleanup(drm.stop) self.addCleanup(drm.stop)
@@ -66,6 +72,12 @@ class HwaccelRecommendationTestCase(unittest.TestCase):
with open(os.path.join(self.proc_root, "cpuinfo"), "w") as f: with open(os.path.join(self.proc_root, "cpuinfo"), "w") as f:
f.write(f"processor\t: 0\nmodel name\t: {model_name}\n") f.write(f"processor\t: 0\nmodel name\t: {model_name}\n")
def write_video_device(self, vendor: str) -> None:
device = os.path.join(self.sys_root, "class", "video4linux", "video0", "device")
os.makedirs(device)
with open(os.path.join(device, "vendor"), "w") as f:
f.write(f"{vendor}\n")
def write_device_tree(self) -> None: def write_device_tree(self) -> None:
os.makedirs(os.path.join(self.proc_root, "device-tree"), exist_ok=True) os.makedirs(os.path.join(self.proc_root, "device-tree"), exist_ok=True)
with open(os.path.join(self.proc_root, "device-tree", "compatible"), "w") as f: with open(os.path.join(self.proc_root, "device-tree", "compatible"), "w") as f:
@@ -191,6 +203,22 @@ class TestAvailableFamilies(HwaccelRecommendationTestCase):
self.assertIn(recommended, [family.key for family in families]) self.assertIn(recommended, [family.key for family in families])
class TestLighter(HwaccelRecommendationTestCase):
def test_lighters_media_engine_is_recommended(self):
self.write_video_device(hwaccel.LIGHTER_VIRTIO_VENDOR)
self.assertEqual(self.recommend(codecs={"h264"}), "apple-silicon")
self.assertEqual(
self.presets()["apple-silicon"],
{"h264": "preset-apple-silicon-h264", "h265": "preset-apple-silicon-h265"},
)
def test_another_virtio_media_device_is_not_lighters(self):
self.write_video_device("0x554d4551")
self.assertEqual(self.available(), [])
class TestCodecCoverage(HwaccelRecommendationTestCase): class TestCodecCoverage(HwaccelRecommendationTestCase):
def test_a_family_carries_a_preset_per_codec(self): def test_a_family_carries_a_preset_per_codec(self):
self.assertEqual( self.assertEqual(
+119 -57
View File
@@ -16,9 +16,7 @@ from frigate.test.const import TEST_DB, TEST_DB_CLEANUPS
# kinds that switch on the lifecycle knobs, so the tests do not depend on the # kinds that switch on the lifecycle knobs, so the tests do not depend on the
# values the real catalog picks # values the real catalog picks
BATCHED = NoticeKind( BATCHED = NoticeKind("batched", NoticeSeverity.warning, "system", batch_repeats=True)
"batched", NoticeSeverity.warning, "system", batch_repeats=True, reopen_at_count=3
)
PRUNED = NoticeKind("pruned", NoticeSeverity.info, "system", keep_latest=2) PRUNED = NoticeKind("pruned", NoticeSeverity.info, "system", keep_latest=2)
TEST_KINDS = {kind.key: kind for kind in (BATCHED, PRUNED)} TEST_KINDS = {kind.key: kind for kind in (BATCHED, PRUNED)}
@@ -77,6 +75,11 @@ class RegistryTestCase(unittest.TestCase):
mock_datetime.now.return_value.timestamp.return_value = timestamp mock_datetime.now.return_value.timestamp.return_value = timestamp
self.registry.raise_notice(kind, **kwargs) self.registry.raise_notice(kind, **kwargs)
def _acknowledge_at(self, timestamp: float, row_id: str) -> None:
with patch("frigate.notices.registry.datetime") as mock_datetime:
mock_datetime.now.return_value.timestamp.return_value = timestamp
self.registry.acknowledge(row_id)
class TestNoticeRegistry(RegistryTestCase): class TestNoticeRegistry(RegistryTestCase):
def test_raise_inserts_and_counts_one_occurrence(self): def test_raise_inserts_and_counts_one_occurrence(self):
@@ -122,34 +125,98 @@ class TestNoticeRegistry(RegistryTestCase):
self.assertEqual(self.registry.stats()[0]["occurrences"], 1) self.assertEqual(self.registry.stats()[0]["occurrences"], 1)
self.listener.assert_not_called() self.listener.assert_not_called()
def test_dismissal_survives_a_re_raise(self): def test_acknowledged_notice_returns_on_a_re_raise(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.assertTrue(self.registry.acknowledge("detector_stuck:ov"))
self.assertEqual(self.registry.active(), [])
self.registry.raise_notice("detector_stuck", scope="ov", params={})
notice = self.registry.active()[0]
self.assertEqual(notice["count"], 2)
self.assertIsNone(notice["acknowledged_at"])
def test_muted_notice_stays_hidden_on_a_re_raise(self):
self.registry.raise_notice("skipped_detections", scope="front_door", params={}) self.registry.raise_notice("skipped_detections", scope="front_door", params={})
self.assertTrue(self.registry.dismiss("skipped_detections:front_door")) self.assertTrue(self.registry.mute("skipped_detections:front_door"))
self.registry.raise_notice("skipped_detections", scope="front_door", params={}) self.registry.raise_notice("skipped_detections", scope="front_door", params={})
self.assertEqual(self.registry.active(), []) self.assertEqual(self.registry.active(), [])
history = self.registry.active(include_dismissed=True) hidden = self.registry.active(include_hidden=True)
self.assertEqual(history[0]["count"], 2) self.assertEqual(hidden[0]["count"], 2)
self.assertIsNotNone(history[0]["dismissed_at"]) self.assertIsNotNone(hidden[0]["muted_at"])
def test_dismiss_counts_once(self): def test_muting_an_acknowledged_notice_replaces_the_acknowledgement(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={}) self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.acknowledge("detector_stuck:ov")
self.assertTrue(self.registry.dismiss("detector_stuck:ov")) self.assertTrue(self.registry.mute("detector_stuck:ov"))
self.assertTrue(self.registry.dismiss("detector_stuck:ov"))
self.assertEqual(self.registry.stats()[0]["dismissals"], 1) notice = self.registry.active(include_hidden=True)[0]
self.assertIsNone(notice["acknowledged_at"])
self.assertIsNotNone(notice["muted_at"])
def test_dismiss_unknown_id(self): def test_acknowledging_a_muted_notice_keeps_it_muted(self):
self.assertFalse(self.registry.dismiss("nope"))
def test_dismissed_hidden_unless_requested(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={}) self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.dismiss("detector_stuck:ov") self.registry.mute("detector_stuck:ov")
self.assertTrue(self.registry.acknowledge("detector_stuck:ov"))
notice = self.registry.active(include_hidden=True)[0]
self.assertIsNone(notice["acknowledged_at"])
self.assertIsNotNone(notice["muted_at"])
def test_acknowledge_and_mute_each_count_once(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.raise_notice("shm_too_low", params={})
self.assertTrue(self.registry.acknowledge("detector_stuck:ov"))
self.assertTrue(self.registry.acknowledge("detector_stuck:ov"))
self.assertTrue(self.registry.mute("shm_too_low"))
self.assertTrue(self.registry.mute("shm_too_low"))
stats = {s["kind"]: s for s in self.registry.stats()}
self.assertEqual(stats["detector_stuck"]["acknowledgements"], 1)
self.assertEqual(stats["detector_stuck"]["mutes"], 0)
self.assertEqual(stats["shm_too_low"]["mutes"], 1)
def test_unknown_ids_are_rejected(self):
self.assertFalse(self.registry.acknowledge("nope"))
self.assertFalse(self.registry.mute("nope"))
self.assertFalse(self.registry.unhide("nope"))
def test_kinds_that_never_repeat_cannot_be_acknowledged(self):
self.registry.raise_notice(
"update_available", scope="0.19.1", params={"version": "0.19.1"}
)
self.assertFalse(self.registry.acknowledge("update_available:0.19.1"))
self.assertFalse(
self.registry.acknowledge("config:detect:fps-greater-than-five:global")
)
self.assertEqual(self.registry.active()[0]["acknowledgeable"], False)
def test_hidden_notices_listed_only_when_requested(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.acknowledge("detector_stuck:ov")
self.assertEqual(self.registry.active(), []) self.assertEqual(self.registry.active(), [])
self.assertEqual(len(self.registry.active(include_dismissed=True)), 1) self.assertEqual(len(self.registry.active(include_hidden=True)), 1)
def test_unhide_shows_a_notice_and_drops_a_check_mute(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.mute("detector_stuck:ov")
self.registry.mute("config:detect:fps-greater-than-five:global")
self.assertTrue(self.registry.unhide("detector_stuck:ov"))
self.assertTrue(
self.registry.unhide("config:detect:fps-greater-than-five:global")
)
notice = self.registry.active()[0]
self.assertIsNone(notice["muted_at"])
self.assertEqual(self.registry.muted_checks(), [])
def test_resolve_deletes_and_keeps_stats(self): def test_resolve_deletes_and_keeps_stats(self):
self.registry.raise_notice( self.registry.raise_notice(
@@ -160,7 +227,7 @@ class TestNoticeRegistry(RegistryTestCase):
self.registry.resolve("model_download_failed", "yolo/model.onnx") self.registry.resolve("model_download_failed", "yolo/model.onnx")
self.registry.resolve("model_download_failed", "yolo/model.onnx") self.registry.resolve("model_download_failed", "yolo/model.onnx")
self.assertEqual(self.registry.active(include_dismissed=True), []) self.assertEqual(self.registry.active(include_hidden=True), [])
self.assertEqual(self.registry.stats()[0]["occurrences"], 1) self.assertEqual(self.registry.stats()[0]["occurrences"], 1)
self.listener.assert_called_once() self.listener.assert_called_once()
@@ -237,45 +304,47 @@ class TestNoticeRegistry(RegistryTestCase):
ids, ["model_download_failed:front_door", "skipped_detections:garage"] ids, ["model_download_failed:front_door", "skipped_detections:garage"]
) )
def test_resolve_camera_drops_that_cameras_check_dismissals(self): def test_resolve_camera_drops_that_cameras_check_mutes(self):
for check_id in ( for check_id in (
"stream:front_door:0:probe", "stream:front_door:0:probe",
"config:detect:fps-greater-than-five:camera.front_door", "config:detect:fps-greater-than-five:camera.front_door",
"config:detect:fps-greater-than-five:global", "config:detect:fps-greater-than-five:global",
"stream:garage:0:probe", "stream:garage:0:probe",
): ):
self.assertTrue(self.registry.dismiss(check_id)) self.assertTrue(self.registry.mute(check_id))
self.registry.resolve_camera("front_door") self.registry.resolve_camera("front_door")
ids = sorted(check["id"] for check in self.registry.dismissed_checks()) ids = sorted(check["id"] for check in self.registry.muted_checks())
self.assertEqual( self.assertEqual(
ids, ids,
["config:detect:fps-greater-than-five:global", "stream:garage:0:probe"], ["config:detect:fps-greater-than-five:global", "stream:garage:0:probe"],
) )
def test_camera_named_global_keeps_global_check_dismissals(self): def test_camera_named_global_keeps_global_check_mutes(self):
self.registry.dismiss("config:detect:fps-greater-than-five:global") self.registry.mute("config:detect:fps-greater-than-five:global")
self.registry.dismiss("config:detect:fps-greater-than-five:camera.global") self.registry.mute("config:detect:fps-greater-than-five:camera.global")
self.registry.resolve_camera("global") self.registry.resolve_camera("global")
ids = [check["id"] for check in self.registry.dismissed_checks()] ids = [check["id"] for check in self.registry.muted_checks()]
self.assertEqual(ids, ["config:detect:fps-greater-than-five:global"]) self.assertEqual(ids, ["config:detect:fps-greater-than-five:global"])
def test_purge_dismissed_keeps_active_notices_and_counts(self): def test_unhide_all_shows_every_notice_and_keeps_counts(self):
self.registry.raise_notice("detector_stuck", scope="ov", params={}) self.registry.raise_notice("detector_stuck", scope="ov", params={})
self.registry.raise_notice("skipped_detections", scope="garage", params={}) self.registry.raise_notice("skipped_detections", scope="garage", params={})
self.registry.dismiss("detector_stuck:ov") self.registry.acknowledge("detector_stuck:ov")
self.registry.dismiss("config:detect:fps-greater-than-five:camera.garage") self.registry.mute("skipped_detections:garage")
self.registry.mute("config:detect:fps-greater-than-five:camera.garage")
self.assertEqual(self.registry.purge_dismissed(), 2) self.registry.unhide_all()
ids = [n["id"] for n in self.registry.active(include_dismissed=True)] ids = sorted(n["id"] for n in self.registry.active())
self.assertEqual(ids, ["skipped_detections:garage"]) self.assertEqual(ids, ["detector_stuck:ov", "skipped_detections:garage"])
self.assertEqual(self.registry.dismissed_checks(), []) self.assertEqual(self.registry.muted_checks(), [])
dismissals = {s["kind"]: s["dismissals"] for s in self.registry.stats()} stats = {s["kind"]: s for s in self.registry.stats()}
self.assertEqual(dismissals["detector_stuck"], 1) self.assertEqual(stats["detector_stuck"]["acknowledgements"], 1)
self.assertEqual(stats["skipped_detections"]["mutes"], 1)
class TestApply(RegistryTestCase): class TestApply(RegistryTestCase):
@@ -349,7 +418,7 @@ class TestLifecycleKnobs(RegistryTestCase):
self.registry.flush() self.registry.flush()
self.assertEqual(self.registry.active(include_dismissed=True), []) self.assertEqual(self.registry.active(include_hidden=True), [])
self.listener.assert_not_called() self.listener.assert_not_called()
def test_a_new_row_starts_without_stale_repeats(self): def test_a_new_row_starts_without_stale_repeats(self):
@@ -362,32 +431,26 @@ class TestLifecycleKnobs(RegistryTestCase):
self.assertEqual(self.registry.active()[0]["count"], 1) self.assertEqual(self.registry.active()[0]["count"], 1)
def test_a_dismissed_notice_reopens_at_the_count(self): def test_an_acknowledged_notice_returns_when_a_later_repeat_flushes(self):
self.registry.raise_notice("batched") self._raise_at(1000.0, "batched")
self.registry.dismiss("batched") self._acknowledge_at(1010.0, "batched")
self.registry.raise_notice("batched") self._raise_at(1020.0, "batched")
self.registry.flush()
self.assertEqual(self.registry.active(), []) self.assertEqual(self.registry.active(), [])
self.registry.raise_notice("batched")
self.registry.flush() self.registry.flush()
notice = self.registry.active()[0] self.assertEqual(self.registry.active()[0]["count"], 2)
self.assertEqual(notice["count"], BATCHED.reopen_at_count)
self.assertIsNone(notice["dismissed_at"])
def test_a_notice_dismissed_past_the_count_stays_dismissed(self): def test_repeats_held_from_before_an_acknowledgement_stay_hidden(self):
for _ in range(3): self._raise_at(1000.0, "batched")
self.registry.raise_notice("batched") self._raise_at(1005.0, "batched")
self.registry.flush() self._acknowledge_at(1010.0, "batched")
self.registry.dismiss("batched")
self.registry.raise_notice("batched")
self.registry.flush() self.registry.flush()
self.assertEqual(self.registry.active(), []) self.assertEqual(self.registry.active(), [])
self.assertEqual(self.registry.active(include_dismissed=True)[0]["count"], 4) self.assertEqual(self.registry.active(include_hidden=True)[0]["count"], 2)
def test_keep_latest_drops_the_oldest_rows(self): def test_keep_latest_drops_the_oldest_rows(self):
for index, scope in enumerate(("a", "b", "c")): for index, scope in enumerate(("a", "b", "c")):
@@ -410,14 +473,13 @@ class TestCatalogLifecycles(RegistryTestCase):
ids = [n["id"] for n in self.registry.active()] ids = [n["id"] for n in self.registry.active()]
self.assertEqual(ids, ["update_available:0.19.1"]) self.assertEqual(ids, ["update_available:0.19.1"])
def test_a_dismissed_failed_login_burst_reopens_at_five_attempts(self): def test_an_acknowledged_failed_login_burst_returns_on_the_next_attempt(self):
self.registry.raise_notice("failed_login", scope="1000") self.registry.raise_notice("failed_login", scope="1000")
self.registry.dismiss("failed_login:1000") self.registry.acknowledge("failed_login:1000")
for _ in range(4):
self.registry.raise_notice("failed_login", scope="1000") self.registry.raise_notice("failed_login", scope="1000")
self.registry.flush() self.registry.flush()
burst = self.registry.active()[0] burst = self.registry.active()[0]
self.assertEqual(burst["count"], 5) self.assertEqual(burst["count"], 2)
self.assertIsNone(burst["dismissed_at"]) self.assertIsNone(burst["acknowledged_at"])
+147
View File
@@ -1,5 +1,7 @@
"""Tests for the device each model runner reports after loading.""" """Tests for the device each model runner reports after loading."""
import os
import tempfile
import threading import threading
import unittest import unittest
from unittest.mock import MagicMock, patch from unittest.mock import MagicMock, patch
@@ -38,6 +40,7 @@ class TestRunnerDeviceName(unittest.TestCase):
self._onnx(["OpenVINOExecutionProvider"]).device_name, "OpenVINO" self._onnx(["OpenVINOExecutionProvider"]).device_name, "OpenVINO"
) )
self.assertEqual(self._onnx(["CPUExecutionProvider"]).device_name, "CPU") self.assertEqual(self._onnx(["CPUExecutionProvider"]).device_name, "CPU")
self.assertEqual(self._onnx(["LighterANE"]).device_name, "Neural Engine")
self.assertEqual(self._onnx(["ROCMExecutionProvider"]).device_name, "ROCM") self.assertEqual(self._onnx(["ROCMExecutionProvider"]).device_name, "ROCM")
self.assertEqual(self._onnx([]).device_name, "CPU") self.assertEqual(self._onnx([]).device_name, "CPU")
@@ -129,3 +132,147 @@ class TestLoadedDeviceSnapshot(unittest.TestCase):
finally: finally:
stop.set() stop.set()
thread.join(timeout=5) thread.join(timeout=5)
class TestLighterANE(unittest.TestCase):
"""lighter's plugin provider, picked up by the ONNX session setup."""
def setUp(self):
loaded_devices.clear()
self.root = tempfile.TemporaryDirectory()
self.addCleanup(self.root.cleanup)
self.library = os.path.join(self.root.name, "liblighter_ane_ep.so")
env = patch.dict(os.environ, {"LIGHTER_ANE_EP": self.library})
env.start()
self.addCleanup(env.stop)
def _device(self) -> MagicMock:
device = MagicMock()
device.ep_name = "LighterANE"
return device
def test_no_devices_without_the_library(self):
with patch.object(detection_runners.ort, "get_ep_devices") as get_ep_devices:
self.assertEqual(detection_runners.get_lighter_ane_devices(), [])
get_ep_devices.assert_not_called()
def test_the_provider_is_registered_once(self):
open(self.library, "w").close()
device = self._device()
other = MagicMock()
other.ep_name = "CPUExecutionProvider"
with (
patch.object(
detection_runners.ort,
"get_ep_devices",
side_effect=[[other], [other, device], [other, device]],
),
patch.object(
detection_runners.ort, "register_execution_provider_library"
) as register,
):
self.assertEqual(detection_runners.get_lighter_ane_devices(), [device])
self.assertEqual(detection_runners.get_lighter_ane_devices(), [device])
register.assert_called_once_with("LighterANE", self.library)
def test_a_provider_that_will_not_load_is_skipped(self):
open(self.library, "w").close()
with (
patch.object(detection_runners.ort, "get_ep_devices", return_value=[]),
patch.object(
detection_runners.ort,
"register_execution_provider_library",
side_effect=RuntimeError("not a provider"),
),
):
self.assertEqual(detection_runners.get_lighter_ane_devices(), [])
def test_the_session_runs_on_the_neural_engine(self):
device = self._device()
session = MagicMock()
session.get_providers.return_value = ["LighterANE", "CPUExecutionProvider"]
options = MagicMock()
with (
patch.object(detection_runners, "is_rknn_compatible", return_value=False),
patch.object(
detection_runners, "get_lighter_ane_devices", return_value=[device]
),
patch.object(
detection_runners, "get_ort_session_options", return_value=options
),
patch.object(
detection_runners.ort, "InferenceSession", return_value=session
) as inference_session,
):
runner = get_optimized_runner("/models/yolo.onnx", "AUTO", "yolo-generic")
options.add_provider_for_devices.assert_called_once_with([device], {})
inference_session.assert_called_once_with(
"/models/yolo.onnx", sess_options=options
)
self.assertIsInstance(runner, ONNXModelRunner)
self.assertEqual(
loaded_devices["/models/yolo.onnx"], ("yolo-generic", "Neural Engine")
)
def test_a_model_the_neural_engine_cannot_load_uses_the_default_providers(self):
session = MagicMock()
session.get_providers.return_value = ["CPUExecutionProvider"]
with (
patch.object(detection_runners, "is_rknn_compatible", return_value=False),
patch.object(
detection_runners, "get_lighter_ane_devices", return_value=[MagicMock()]
),
patch.object(
detection_runners,
"get_ort_providers",
return_value=(["CPUExecutionProvider"], [{}]),
),
patch.object(
detection_runners, "is_openvino_gpu_npu_available", return_value=False
),
patch.object(
detection_runners.ort,
"InferenceSession",
side_effect=[RuntimeError("unsupported"), session],
) as inference_session,
patch.object(
detection_runners, "get_ort_session_options", return_value=MagicMock()
),
self.assertLogs(detection_runners.logger, level="WARNING"),
):
runner = get_optimized_runner("/models/jina.onnx", "AUTO", "jina-v2")
self.assertEqual(inference_session.call_count, 2)
self.assertIsInstance(runner, ONNXModelRunner)
self.assertEqual(loaded_devices["/models/jina.onnx"], ("jina-v2", "CPU"))
def test_a_cpu_model_stays_on_the_cpu(self):
session = MagicMock()
session.get_providers.return_value = ["CPUExecutionProvider"]
with (
patch.object(detection_runners, "is_rknn_compatible", return_value=False),
patch.object(
detection_runners, "get_lighter_ane_devices", return_value=[MagicMock()]
) as ane,
patch.object(
detection_runners,
"get_ort_providers",
return_value=(["CPUExecutionProvider"], [{}]),
),
patch.object(
detection_runners.ort, "InferenceSession", return_value=session
),
patch.object(
detection_runners, "get_ort_session_options", return_value=None
),
):
get_optimized_runner("/models/arcface.onnx", "CPU", "arcface")
ane.assert_not_called()
+86 -18
View File
@@ -1,10 +1,14 @@
"""Tests for the skipped detection rate and the notice it can raise.""" """Tests for the per-camera episode notices: skipped detections and high CPU."""
import unittest import unittest
from unittest.mock import patch from unittest.mock import call, patch
from frigate.stats import emitter from frigate.stats import emitter
from frigate.stats.emitter import SkippedDetectionsTracker from frigate.stats.emitter import (
SKIPPED_DETECTIONS_PCT,
EpisodeTracker,
cpu_average,
)
from frigate.stats.util import skipped_percent from frigate.stats.util import skipped_percent
@@ -19,18 +23,18 @@ class TestSkippedPercent(unittest.TestCase):
self.assertEqual(skipped_percent(2.0, 5.0, False), 0.0) self.assertEqual(skipped_percent(2.0, 5.0, False), 0.0)
class TestSkippedDetectionsTracker(unittest.TestCase): class TestEpisodeTracker(unittest.TestCase):
def _cameras(self, pct: float) -> dict: def _cameras(self, pct: float) -> dict:
return {"front_door": {"skipped_pct": pct}} return {"front_door": pct}
def test_below_threshold_never_qualifies(self): def test_below_threshold_never_qualifies(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
for tick in range(10): for tick in range(10):
self.assertEqual(tracker.update(self._cameras(4.9), tick * 15.0), []) self.assertEqual(tracker.update(self._cameras(4.9), tick * 15.0), [])
def test_qualifies_once_after_the_hold(self): def test_qualifies_once_after_the_hold(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
results = [ results = [
tracker.update(self._cameras(10.0), tick * 15.0) for tick in range(8) tracker.update(self._cameras(10.0), tick * 15.0) for tick in range(8)
@@ -42,7 +46,7 @@ class TestSkippedDetectionsTracker(unittest.TestCase):
self.assertEqual(results[5:], [[], [], []]) self.assertEqual(results[5:], [[], [], []])
def test_a_dip_restarts_the_hold(self): def test_a_dip_restarts_the_hold(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
for now, pct in ((0.0, 10.0), (15.0, 10.0), (30.0, 10.0), (45.0, 2.0)): for now, pct in ((0.0, 10.0), (15.0, 10.0), (30.0, 10.0), (45.0, 2.0)):
self.assertEqual(tracker.update(self._cameras(pct), now), []) self.assertEqual(tracker.update(self._cameras(pct), now), [])
@@ -51,7 +55,7 @@ class TestSkippedDetectionsTracker(unittest.TestCase):
self.assertEqual(tracker.update(self._cameras(10.0), 120.0), ["front_door"]) self.assertEqual(tracker.update(self._cameras(10.0), 120.0), ["front_door"])
def test_recovery_then_relapse_is_a_new_episode(self): def test_recovery_then_relapse_is_a_new_episode(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
tracker.update(self._cameras(10.0), 0.0) tracker.update(self._cameras(10.0), 0.0)
self.assertEqual(tracker.update(self._cameras(10.0), 60.0), ["front_door"]) self.assertEqual(tracker.update(self._cameras(10.0), 60.0), ["front_door"])
@@ -61,17 +65,15 @@ class TestSkippedDetectionsTracker(unittest.TestCase):
self.assertEqual(tracker.update(self._cameras(10.0), 150.0), ["front_door"]) self.assertEqual(tracker.update(self._cameras(10.0), 150.0), ["front_door"])
def test_cameras_are_tracked_separately(self): def test_cameras_are_tracked_separately(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
tracker.update({"a": {"skipped_pct": 10.0}, "b": {"skipped_pct": 0.0}}, 0.0) tracker.update({"a": 10.0, "b": 0.0}, 0.0)
qualified = tracker.update( qualified = tracker.update({"a": 10.0, "b": 10.0}, 60.0)
{"a": {"skipped_pct": 10.0}, "b": {"skipped_pct": 10.0}}, 60.0
)
self.assertEqual(qualified, ["a"]) self.assertEqual(qualified, ["a"])
def test_a_removed_camera_starts_a_new_episode(self): def test_a_removed_camera_starts_a_new_episode(self):
tracker = SkippedDetectionsTracker() tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
tracker.update(self._cameras(10.0), 0.0) tracker.update(self._cameras(10.0), 0.0)
tracker.update({}, 15.0) tracker.update({}, 15.0)
tracker.update(self._cameras(10.0), 30.0) tracker.update(self._cameras(10.0), 30.0)
@@ -79,6 +81,25 @@ class TestSkippedDetectionsTracker(unittest.TestCase):
self.assertEqual(tracker.update(self._cameras(10.0), 60.0), []) self.assertEqual(tracker.update(self._cameras(10.0), 60.0), [])
self.assertEqual(tracker.update(self._cameras(10.0), 90.0), ["front_door"]) self.assertEqual(tracker.update(self._cameras(10.0), 90.0), ["front_door"])
def test_a_missing_value_ends_the_episode(self):
tracker = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
tracker.update(self._cameras(10.0), 0.0)
tracker.update({"front_door": None}, 30.0)
self.assertEqual(tracker.update(self._cameras(10.0), 60.0), [])
class TestCpuAverage(unittest.TestCase):
def test_reads_the_lifetime_average(self):
usages = {"42": {"cpu": "80.0", "cpu_average": "25.0"}}
self.assertEqual(cpu_average(usages, 42), 25.0)
def test_unknown_process_has_no_average(self):
self.assertIsNone(cpu_average({}, 42))
self.assertIsNone(cpu_average({"42": {"cpu_average": "25.0"}}, None))
self.assertIsNone(cpu_average({"42": {"cpu_average": ""}}, 42))
class TestEmitterNotices(unittest.TestCase): class TestEmitterNotices(unittest.TestCase):
def setUp(self): def setUp(self):
@@ -94,15 +115,25 @@ class TestEmitterNotices(unittest.TestCase):
def _emitter(self) -> emitter.StatsEmitter: def _emitter(self) -> emitter.StatsEmitter:
stats_emitter = emitter.StatsEmitter.__new__(emitter.StatsEmitter) stats_emitter = emitter.StatsEmitter.__new__(emitter.StatsEmitter)
stats_emitter.skipped_detections = SkippedDetectionsTracker() stats_emitter.skipped_detections = EpisodeTracker(SKIPPED_DETECTIONS_PCT)
stats_emitter.ffmpeg_cpu = EpisodeTracker(emitter.FFMPEG_HIGH_CPU_PCT)
stats_emitter.detect_cpu = EpisodeTracker(emitter.DETECT_HIGH_CPU_PCT)
stats_emitter._shm_checked = False stats_emitter._shm_checked = False
stats_emitter._shm_params = None stats_emitter._shm_params = None
return stats_emitter return stats_emitter
def _stats(self, uptime: int, pct: float) -> dict: def _stats(
self, uptime: int, pct: float, ffmpeg_cpu: str = "5.0", detect_cpu: str = "5.0"
) -> dict:
return { return {
"service": {"uptime": uptime, "storage": {"/dev/shm": {}}}, "service": {"uptime": uptime, "storage": {"/dev/shm": {}}},
"cameras": {"front_door": {"skipped_pct": pct}}, "cameras": {
"front_door": {"skipped_pct": pct, "ffmpeg_pid": 10, "pid": 11}
},
"cpu_usages": {
"10": {"cpu_average": ffmpeg_cpu},
"11": {"cpu_average": detect_cpu},
},
} }
def test_qualified_camera_raises_a_notice(self): def test_qualified_camera_raises_a_notice(self):
@@ -115,6 +146,43 @@ class TestEmitterNotices(unittest.TestCase):
"skipped_detections", scope="front_door", params={"pct": 12.5} "skipped_detections", scope="front_door", params={"pct": 12.5}
) )
def test_high_cpu_raises_a_notice_per_process(self):
stats_emitter = self._emitter()
for uptime, now in ((300, 0.0), (360, 60.0)):
stats_emitter._update_notices(
self._stats(uptime, 0.0, ffmpeg_cpu="25.0", detect_cpu="45.0"), now
)
self.assertEqual(
self.raise_notice.call_args_list,
[
call("ffmpeg_high_cpu", scope="front_door", params={"cpu": 25.0}),
call("detect_high_cpu", scope="front_door", params={"cpu": 45.0}),
],
)
def test_cpu_below_each_threshold_raises_nothing(self):
stats_emitter = self._emitter()
for uptime, now in ((300, 0.0), (360, 60.0)):
stats_emitter._update_notices(
self._stats(uptime, 0.0, ffmpeg_cpu="19.0", detect_cpu="39.0"), now
)
self.raise_notice.assert_not_called()
def test_missing_cpu_stats_raise_nothing(self):
stats_emitter = self._emitter()
for uptime, now in ((300, 0.0), (360, 60.0)):
stats = self._stats(uptime, 0.0)
del stats["cpu_usages"]
stats_emitter._update_notices(stats, now)
self.raise_notice.assert_not_called()
self.assertEqual(self.flush_notices.call_count, 2)
def test_startup_window_is_ignored(self): def test_startup_window_is_ignored(self):
stats_emitter = self._emitter() stats_emitter = self._emitter()
+7 -4
View File
@@ -56,10 +56,13 @@ class EventsPerSecond:
self._start = now self._start = now
# compute the (approximate) events in the last n seconds # compute the (approximate) events in the last n seconds
self.expire_timestamps(now) self.expire_timestamps(now)
seconds = min(now - self._start, self._last_n_seconds) # rate over at least one second (or the whole window, if shorter),
# avoid divide by zero # so a burst of events right after start() is not divided by a
if seconds == 0: # tiny window
seconds = 1 seconds = max(
min(now - self._start, self._last_n_seconds),
min(1.0, self._last_n_seconds),
)
return len(self._timestamps) / seconds return len(self._timestamps) / seconds
# remove aged out timestamps # remove aged out timestamps
+33 -1
View File
@@ -9,6 +9,7 @@ and resolve it per camera against that camera's detect stream.
""" """
import logging import logging
import os
import re import re
from pydantic import BaseModel, Field from pydantic import BaseModel, Field
@@ -23,14 +24,20 @@ from frigate.util.services import enumerate_drm_devices
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
# root the /proc reads use, so tests can point them at a fixture tree # roots the /proc and /sys reads use, so tests can point them at a fixture tree
PROC_ROOT = "/proc" PROC_ROOT = "/proc"
SYS_ROOT = "/sys"
ANY_CODEC = "any" ANY_CODEC = "any"
# a Raspberry Pi has no detection hardware of its own, so it gets a key here # a Raspberry Pi has no detection hardware of its own, so it gets a key here
RASPBERRY_PI = "raspberrypi" RASPBERRY_PI = "raspberrypi"
# lighter (https://github.com/fieldwork-ai/lighter) decodes on a Mac's media
# engine through virtio-media devices, which carry its virtio vendor id "LGHT"
LIGHTER_MEDIA = "lighter"
LIGHTER_VIRTIO_VENDOR = "0x4c474854"
# ffprobe names h265 streams hevc # ffprobe names h265 streams hevc
CODEC_ALIASES = {"hevc": "h265"} CODEC_ALIASES = {"hevc": "h265"}
@@ -52,6 +59,7 @@ DECODE_HARDWARE = (
"rknn", "rknn",
"openvino:GPU", "openvino:GPU",
"onnx:amd", "onnx:amd",
LIGHTER_MEDIA,
RASPBERRY_PI, RASPBERRY_PI,
) )
@@ -98,6 +106,10 @@ FAMILY_RPI = HwaccelFamily(
key="rpi", key="rpi",
presets={"h264": "preset-rpi-64-h264", "h265": "preset-rpi-64-h265"}, presets={"h264": "preset-rpi-64-h264", "h265": "preset-rpi-64-h265"},
) )
FAMILY_APPLE = HwaccelFamily(
key="apple-silicon",
presets={"h264": "preset-apple-silicon-h264", "h265": "preset-apple-silicon-h265"},
)
def _read(path: str) -> str | None: def _read(path: str) -> str | None:
@@ -139,6 +151,20 @@ def _is_raspberry_pi() -> bool:
return "raspberrypi" in compatible return "raspberrypi" in compatible
def _has_lighter_media() -> bool:
video = f"{SYS_ROOT}/class/video4linux"
try:
devices = os.listdir(video)
except OSError:
return False
return any(
_read(f"{video}/{device}/device/vendor") == LIGHTER_VIRTIO_VENDOR
for device in devices
)
def _intel_families(generation: int | None) -> list[HwaccelFamily]: def _intel_families(generation: int | None) -> list[HwaccelFamily]:
"""vaapi drives every Intel GPU, qsv only those from gen8 on.""" """vaapi drives every Intel GPU, qsv only those from gen8 on."""
if generation is not None and generation < INTEL_QSV_SUPPORTED_GEN: if generation is not None and generation < INTEL_QSV_SUPPORTED_GEN:
@@ -164,6 +190,9 @@ def _families(key: str, generation: int | None) -> list[HwaccelFamily]:
if key == "onnx:amd": if key == "onnx:amd":
return [FAMILY_VAAPI] return [FAMILY_VAAPI]
if key == LIGHTER_MEDIA:
return [FAMILY_APPLE]
if key == RASPBERRY_PI: if key == RASPBERRY_PI:
return [FAMILY_RPI] return [FAMILY_RPI]
@@ -193,6 +222,9 @@ def _decode_hardware(detector_key: str | None) -> list[str]:
""" """
present = {found.key for found in hardware_prober.probe()} present = {found.key for found in hardware_prober.probe()}
if _has_lighter_media():
present.add(LIGHTER_MEDIA)
if _is_raspberry_pi(): if _is_raspberry_pi():
present.add(RASPBERRY_PI) present.add(RASPBERRY_PI)
+6 -3
View File
@@ -18,18 +18,21 @@ def migrate(migrator, database, fake=False, **kwargs):
'"first_seen" DATETIME NOT NULL, ' '"first_seen" DATETIME NOT NULL, '
'"last_seen" DATETIME NOT NULL, ' '"last_seen" DATETIME NOT NULL, '
'"count" INTEGER NOT NULL, ' '"count" INTEGER NOT NULL, '
'"dismissed_at" DATETIME)' '"acknowledged_at" DATETIME, '
'"muted_at" DATETIME)'
) )
migrator.sql('CREATE INDEX IF NOT EXISTS "notice_kind" ON "notice" ("kind")') migrator.sql('CREATE INDEX IF NOT EXISTS "notice_kind" ON "notice" ("kind")')
migrator.sql( migrator.sql(
'CREATE TABLE IF NOT EXISTS "noticestats" (' 'CREATE TABLE IF NOT EXISTS "noticestats" ('
'"kind" VARCHAR(50) NOT NULL PRIMARY KEY, ' '"kind" VARCHAR(50) NOT NULL PRIMARY KEY, '
'"occurrences" INTEGER NOT NULL, ' '"occurrences" INTEGER NOT NULL, '
'"dismissals" INTEGER NOT NULL, ' '"acknowledgements" INTEGER NOT NULL, '
'"mutes" INTEGER NOT NULL, '
'"first_seen" DATETIME NOT NULL, ' '"first_seen" DATETIME NOT NULL, '
'"last_seen" DATETIME NOT NULL, ' '"last_seen" DATETIME NOT NULL, '
'"reported_occurrences" INTEGER NOT NULL DEFAULT 0, ' '"reported_occurrences" INTEGER NOT NULL DEFAULT 0, '
'"reported_dismissals" INTEGER NOT NULL DEFAULT 0)' '"reported_acknowledgements" INTEGER NOT NULL DEFAULT 0, '
'"reported_mutes" INTEGER NOT NULL DEFAULT 0)'
) )
+3 -3
View File
@@ -49,7 +49,7 @@ export interface ApiMockOverrides {
}; };
users?: { username: string; role: string }[]; users?: { username: string; role: string }[];
notices?: unknown[]; notices?: unknown[];
dismissedChecks?: unknown[]; mutedChecks?: unknown[];
/** camera name to the ffprobe entries returned for `paths=camera:<name>` */ /** camera name to the ffprobe entries returned for `paths=camera:<name>` */
ffprobe?: Record<string, unknown[]>; ffprobe?: Record<string, unknown[]>;
} }
@@ -238,8 +238,8 @@ export class ApiMocker {
await this.page.route("**/api/notices", (route) => await this.page.route("**/api/notices", (route) =>
route.fulfill({ json: overrides?.notices ?? [] }), route.fulfill({ json: overrides?.notices ?? [] }),
); );
await this.page.route("**/api/notices/dismissed_checks", (route) => await this.page.route("**/api/notices/muted_checks", (route) =>
route.fulfill({ json: overrides?.dismissedChecks ?? [] }), route.fulfill({ json: overrides?.mutedChecks ?? [] }),
); );
// Users. GET lists them; POST/PUT (create, password) just succeed, so // Users. GET lists them; POST/PUT (create, password) just succeed, so
+226 -89
View File
@@ -1,7 +1,8 @@
/** /**
* Health tab tests -- MEDIUM tier. * Health tab tests -- MEDIUM tier.
* *
* Default tab, notice list rendering, dismiss, empty state, update notice. * Default tab, notice list rendering, acknowledge and mute, empty state,
* update notice.
*/ */
import { test, expect } from "../fixtures/frigate-test"; import { test, expect } from "../fixtures/frigate-test";
@@ -23,7 +24,9 @@ const ERROR_NOTICE = {
first_seen: NOW - 600, first_seen: NOW - 600,
last_seen: NOW, last_seen: NOW,
count: 2, count: 2,
dismissed_at: null, acknowledgeable: true,
acknowledged_at: null,
muted_at: null,
}; };
const EVENT_NOTICE = { const EVENT_NOTICE = {
@@ -37,7 +40,9 @@ const EVENT_NOTICE = {
first_seen: NOW - 7200, first_seen: NOW - 7200,
last_seen: NOW - 60, last_seen: NOW - 60,
count: 3, count: 3,
dismissed_at: null, acknowledgeable: true,
acknowledged_at: null,
muted_at: null,
}; };
test.describe("System — Health tab @medium", () => { test.describe("System — Health tab @medium", () => {
@@ -63,31 +68,34 @@ test.describe("System — Health tab @medium", () => {
"Downloading model.onnx for yolo failed: timeout", "Downloading model.onnx for yolo failed: timeout",
); );
await expect(rows.nth(0)).toContainText("2 times"); await expect(rows.nth(0)).toContainText("2 times");
await expect(
rows.nth(0).getByRole("button", { name: "Dismiss" }),
).toBeVisible();
await expect(rows.nth(1)).toContainText("Detector ov was restarted"); await expect(rows.nth(1)).toContainText("Detector ov was restarted");
await expect(rows.nth(1)).toContainText("3 times"); await expect(rows.nth(1)).toContainText("3 times");
for (const index of [0, 1]) {
await expect( await expect(
rows.nth(1).getByRole("button", { name: "Dismiss" }), rows.nth(index).getByRole("button", { name: "Acknowledge" }),
).toBeVisible(); ).toBeVisible();
await expect(
rows.nth(index).getByRole("button", { name: "Mute", exact: true }),
).toBeVisible();
}
}); });
test("dismiss posts and removes the row", async ({ frigateApp }) => { for (const action of ["acknowledge", "mute"] as const) {
test(`${action} posts and removes the row`, async ({ frigateApp }) => {
await frigateApp.installDefaults({ await frigateApp.installDefaults({
stats: QUIET_STATS, stats: QUIET_STATS,
notices: [EVENT_NOTICE], notices: [EVENT_NOTICE],
}); });
// the list shrinks after the dismiss so the refetch shows the row gone // the list shrinks after the POST so the refetch shows the row gone
let dismissed = false; let hidden = false;
await frigateApp.page.route("**/api/notices", (route) => await frigateApp.page.route("**/api/notices", (route) =>
route.fulfill({ json: dismissed ? [] : [EVENT_NOTICE] }), route.fulfill({ json: hidden ? [] : [EVENT_NOTICE] }),
); );
await frigateApp.page.route( await frigateApp.page.route(
"**/api/notices/detector_stuck/dismiss", `**/api/notices/detector_stuck/${action}`,
(route) => { (route) => {
dismissed = true; hidden = true;
return route.fulfill({ json: { success: true } }); return route.fulfill({ json: { success: true } });
}, },
); );
@@ -95,12 +103,15 @@ test.describe("System — Health tab @medium", () => {
await frigateApp.goto("/system#health"); await frigateApp.goto("/system#health");
const request = frigateApp.page.waitForRequest( const request = frigateApp.page.waitForRequest(
(req) => (req) =>
req.url().includes("/api/notices/detector_stuck/dismiss") && req.url().includes(`/api/notices/detector_stuck/${action}`) &&
req.method() === "POST", req.method() === "POST",
); );
await frigateApp.page await frigateApp.page
.getByTestId("health-problem-notice:detector_stuck") .getByTestId("health-problem-notice:detector_stuck")
.getByRole("button", { name: "Dismiss" }) .getByRole("button", {
name: action === "mute" ? "Mute" : "Acknowledge",
exact: true,
})
.click(); .click();
await request; await request;
@@ -111,6 +122,7 @@ test.describe("System — Health tab @medium", () => {
frigateApp.page.getByText("Your Frigate installation is healthy"), frigateApp.page.getByText("Your Frigate installation is healthy"),
).toBeVisible(); ).toBeVisible();
}); });
}
test("empty state with no notices", async ({ frigateApp }) => { test("empty state with no notices", async ({ frigateApp }) => {
await frigateApp.installDefaults({ stats: QUIET_STATS }); await frigateApp.installDefaults({ stats: QUIET_STATS });
@@ -140,7 +152,9 @@ test.describe("System — Health tab @medium", () => {
first_seen: NOW - 3600, first_seen: NOW - 3600,
last_seen: NOW, last_seen: NOW,
count: 1, count: 1,
dismissed_at: null, acknowledgeable: false,
acknowledged_at: null,
muted_at: null,
}, },
], ],
}); });
@@ -156,10 +170,23 @@ test.describe("System — Health tab @medium", () => {
"href", "href",
"https://github.com/blakeblackshear/frigate/releases/tag/v0.19.0", "https://github.com/blakeblackshear/frigate/releases/tag/v0.19.0",
); );
await expect(row.getByRole("button", { name: "Dismiss" })).toBeVisible(); await expect(
row.getByRole("button", { name: "Mute", exact: true }),
).toBeVisible();
await expect(row.getByRole("button", { name: "Acknowledge" })).toHaveCount(
0,
);
}); });
test("the filter shows dismissed notices without a Dismiss button", async ({ const ACKNOWLEDGED_NOTICE = {
...EVENT_NOTICE,
id: "detector_stuck:coral",
params: { detector: "coral" },
acknowledged_at: NOW - 60,
};
const MUTED_NOTICE = { ...ERROR_NOTICE, muted_at: NOW - 120 };
test("the filter shows hidden notices marked by how they were hidden", async ({
frigateApp, frigateApp,
}) => { }) => {
await frigateApp.installDefaults({ await frigateApp.installDefaults({
@@ -169,33 +196,85 @@ test.describe("System — Health tab @medium", () => {
await frigateApp.page.route( await frigateApp.page.route(
(url) => (url) =>
url.pathname.endsWith("/api/notices") && url.pathname.endsWith("/api/notices") &&
url.searchParams.get("include_dismissed") === "true", url.searchParams.get("include_hidden") === "true",
(route) => (route) =>
route.fulfill({ route.fulfill({
json: [EVENT_NOTICE, { ...ERROR_NOTICE, dismissed_at: NOW - 120 }], json: [EVENT_NOTICE, ACKNOWLEDGED_NOTICE, MUTED_NOTICE],
}), }),
); );
await frigateApp.goto("/system#health"); await frigateApp.goto("/system#health");
await frigateApp.page.getByRole("button", { name: "Filter" }).click(); await frigateApp.page.getByRole("button", { name: "Filter" }).click();
const showDismissed = frigateApp.page.getByRole("switch", { const showHidden = frigateApp.page.getByRole("switch", {
name: "Show dismissed", name: "Show hidden",
}); });
await expect(showDismissed).toHaveAttribute("aria-checked", "false"); await expect(showHidden).toHaveAttribute("aria-checked", "false");
await showDismissed.click(); await showHidden.click();
// mobile opens the filter as a modal drawer, which hides the rows' roles
await frigateApp.page.keyboard.press("Escape");
const row = frigateApp.page.getByTestId( const acknowledged = frigateApp.page.getByTestId(
"health-problem-notice:detector_stuck:coral",
);
await expect(acknowledged).toBeVisible({ timeout: 15_000 });
await expect(acknowledged).toContainText("Acknowledged");
await expect(
acknowledged.getByRole("button", { name: "Show again" }),
).toBeVisible();
await expect(
acknowledged.getByRole("button", { name: "Acknowledge" }),
).toHaveCount(0);
const muted = frigateApp.page.getByTestId(
"health-problem-notice:model_download_failed:yolo/model.onnx", "health-problem-notice:model_download_failed:yolo/model.onnx",
); );
await expect(row).toBeVisible({ timeout: 15_000 }); await expect(muted).toContainText("Muted");
await expect(row).toContainText("Dismissed"); await expect(muted.getByRole("button", { name: "Unmute" })).toBeVisible();
await expect(row.getByRole("button", { name: "Dismiss" })).toHaveCount(0); await expect(
muted.getByRole("button", { name: "Mute", exact: true }),
).toHaveCount(0);
await showDismissed.click(); await frigateApp.page.getByRole("button", { name: "Filter" }).click();
await expect(row).toHaveCount(0); await showHidden.click();
await expect(muted).toHaveCount(0);
}); });
test("clear dismissed deletes the dismissed rows after confirming", async ({ test("unmute deletes the row's hidden state", async ({ frigateApp }) => {
await frigateApp.installDefaults({ stats: QUIET_STATS, notices: [] });
await frigateApp.page.route(
(url) =>
url.pathname.endsWith("/api/notices") &&
url.searchParams.get("include_hidden") === "true",
(route) => route.fulfill({ json: [MUTED_NOTICE] }),
);
await frigateApp.page.route(
"**/api/notices/model_download_failed:yolo/model.onnx/hidden",
(route) => route.fulfill({ json: { success: true } }),
);
await frigateApp.goto("/system#health");
await frigateApp.page.getByRole("button", { name: "Filter" }).click();
await frigateApp.page.getByRole("switch", { name: "Show hidden" }).click();
await frigateApp.page.keyboard.press("Escape");
const request = frigateApp.page.waitForRequest(
(req) =>
req
.url()
.endsWith(
"/api/notices/model_download_failed:yolo/model.onnx/hidden",
) && req.method() === "DELETE",
);
await frigateApp.page
.getByTestId(
"health-problem-notice:model_download_failed:yolo/model.onnx",
)
.getByRole("button", { name: "Unmute" })
.click({ timeout: 15_000 });
await request;
});
test("show all again unhides every row after confirming", async ({
frigateApp, frigateApp,
}) => { }) => {
await frigateApp.installDefaults({ await frigateApp.installDefaults({
@@ -203,29 +282,25 @@ test.describe("System — Health tab @medium", () => {
notices: [EVENT_NOTICE], notices: [EVENT_NOTICE],
}); });
// the history loses its dismissed row once the DELETE lands // the hidden list loses its muted row once the DELETE lands
let cleared = false; let cleared = false;
await frigateApp.page.route( await frigateApp.page.route(
(url) => (url) =>
url.pathname.endsWith("/api/notices") && url.pathname.endsWith("/api/notices") &&
url.searchParams.get("include_dismissed") === "true", url.searchParams.get("include_hidden") === "true",
(route) => (route) =>
route.fulfill({ route.fulfill({
json: cleared json: cleared ? [EVENT_NOTICE] : [EVENT_NOTICE, MUTED_NOTICE],
? [EVENT_NOTICE]
: [EVENT_NOTICE, { ...ERROR_NOTICE, dismissed_at: NOW - 120 }],
}), }),
); );
await frigateApp.page.route("**/api/notices/dismissed", (route) => { await frigateApp.page.route("**/api/notices/hidden", (route) => {
cleared = true; cleared = true;
return route.fulfill({ json: { success: true } }); return route.fulfill({ json: { success: true } });
}); });
await frigateApp.goto("/system#health"); await frigateApp.goto("/system#health");
await frigateApp.page.getByRole("button", { name: "Filter" }).click(); await frigateApp.page.getByRole("button", { name: "Filter" }).click();
await frigateApp.page await frigateApp.page.getByRole("switch", { name: "Show hidden" }).click();
.getByRole("switch", { name: "Show dismissed" })
.click();
const row = frigateApp.page.getByTestId( const row = frigateApp.page.getByTestId(
"health-problem-notice:model_download_failed:yolo/model.onnx", "health-problem-notice:model_download_failed:yolo/model.onnx",
); );
@@ -233,23 +308,20 @@ test.describe("System — Health tab @medium", () => {
await frigateApp.page.keyboard.press("Escape"); await frigateApp.page.keyboard.press("Escape");
await frigateApp.page await frigateApp.page
.getByRole("button", { name: "Clear dismissed" }) .getByRole("button", { name: "Show all again" })
.click(); .click();
const request = frigateApp.page.waitForRequest( const request = frigateApp.page.waitForRequest(
(req) => (req) =>
req.url().endsWith("/api/notices/dismissed") && req.url().endsWith("/api/notices/hidden") && req.method() === "DELETE",
req.method() === "DELETE",
); );
await frigateApp.page await frigateApp.page
.getByRole("alertdialog") .getByRole("alertdialog")
.getByRole("button", { name: "Clear dismissed" }) .getByRole("button", { name: "Show all again" })
.click(); .click();
await request; await request;
await expect(row).toHaveCount(0); await expect(row).toHaveCount(0);
await expect( await expect(frigateApp.page.getByText("No hidden notices")).toBeVisible();
frigateApp.page.getByText("No dismissed notices"),
).toBeVisible();
}); });
test("severity switches hide notices of that severity", async ({ test("severity switches hide notices of that severity", async ({
@@ -290,7 +362,9 @@ test.describe("System — Health tab @medium", () => {
first_seen: start, first_seen: start,
last_seen: start + 60, last_seen: start + 60,
count, count,
dismissed_at: null, acknowledgeable: true,
acknowledged_at: null,
muted_at: null,
}); });
await frigateApp.installDefaults({ await frigateApp.installDefaults({
stats: QUIET_STATS, stats: QUIET_STATS,
@@ -332,7 +406,9 @@ test.describe("System — Health tab @medium", () => {
first_seen: NOW - 600, first_seen: NOW - 600,
last_seen: NOW - 600, last_seen: NOW - 600,
count: 1, count: 1,
dismissed_at: null, acknowledgeable: true,
acknowledged_at: null,
muted_at: null,
}, },
], ],
}); });
@@ -363,7 +439,9 @@ test.describe("System — Health tab @medium", () => {
first_seen: NOW - 600, first_seen: NOW - 600,
last_seen: NOW - 600, last_seen: NOW - 600,
count: 1, count: 1,
dismissed_at: null, acknowledgeable: true,
acknowledged_at: null,
muted_at: null,
}, },
], ],
}); });
@@ -695,7 +773,7 @@ test.describe("System — Health notices sources @medium", () => {
// the status bar shows a problem, so stats have loaded // the status bar shows a problem, so stats have loaded
await expect( await expect(
frigateApp.page.getByText("Front Door is offline"), frigateApp.page.getByText("Recordings are being deleted"),
).toBeVisible({ timeout: 15_000 }); ).toBeVisible({ timeout: 15_000 });
await expect( await expect(
frigateApp.page.locator("[data-testid^='health-problem-']"), frigateApp.page.locator("[data-testid^='health-problem-']"),
@@ -1046,7 +1124,7 @@ test.describe("System — Health notices sources @medium", () => {
await expect(frigateApp.page).toHaveURL(/\/system#health/); await expect(frigateApp.page).toHaveURL(/\/system#health/);
}); });
test("status bar counts undismissed notices next to the health text", async ({ test("status bar counts shown notices next to the health text", async ({
frigateApp, frigateApp,
}) => { }) => {
test.skip(frigateApp.isMobile, "Status bar is desktop-only"); test.skip(frigateApp.isMobile, "Status bar is desktop-only");
@@ -1089,41 +1167,61 @@ test.describe("System — Health notices sources @medium", () => {
await expect(frigateApp.page.getByText("System is healthy")).toHaveCount(0); await expect(frigateApp.page.getByText("System is healthy")).toHaveCount(0);
}); });
test("a config row can be dismissed", async ({ frigateApp }) => { // the slow detector warning is added before the offline error
const id = "config:detect:fps-greater-than-five:camera.garage"; const TWO_PROBLEM_STATS = {
await frigateApp.installDefaults({ detectors: { cpu: { inference_speed: 60 } },
config: { cameras: { front_door: { camera_fps: 0 } },
cameras: { };
garage: { detect: { width: 2560, height: 1440, fps: 10 } },
}, test("status bar collapses several problems behind the most severe", async ({
}, frigateApp,
stats: QUIET_STATS, }) => {
test.skip(frigateApp.isMobile, "Status bar is desktop-only");
await frigateApp.installDefaults({ stats: TWO_PROBLEM_STATS });
await frigateApp.goto("/");
const summary = frigateApp.page.getByRole("button", {
name: "Front Door is offline +1",
});
await expect(summary).toBeVisible({ timeout: 15_000 });
await expect(frigateApp.page.getByText("Cpu is slow")).toHaveCount(0);
await summary.click();
const list = frigateApp.page.getByTestId("status-message-list");
await expect(list.getByRole("link")).toHaveText([
"Front Door is offline",
"Cpu is slow (60 ms)",
]);
await list.getByRole("link", { name: "Cpu is slow (60 ms)" }).click();
await expect(frigateApp.page).toHaveURL(/\/system#general/);
await expect(list).toHaveCount(0);
}); });
// the list gains the dismissal after the POST so the refetch hides the row test("mobile status drawer stacks every problem", async ({ frigateApp }) => {
let dismissed = false; test.skip(!frigateApp.isMobile, "Mobile-only");
await frigateApp.page.route(`**/api/notices/${id}/dismiss`, (route) => { await frigateApp.installDefaults({ stats: TWO_PROBLEM_STATS });
dismissed = true; await frigateApp.goto("/");
return route.fulfill({ json: { success: true } });
});
await frigateApp.page.route("**/api/notices/dismissed_checks", (route) =>
route.fulfill({ json: dismissed ? [{ id, dismissed_at: NOW }] : [] }),
);
await frigateApp.goto("/system#health");
const row = frigateApp.page.getByTestId(`health-problem-${id}`); await frigateApp.page
await expect(row).toBeVisible({ timeout: 15_000 }); .getByTestId("status-alert-trigger")
const request = frigateApp.page.waitForRequest( .click({ timeout: 15_000 });
(req) => const items = frigateApp.page
req.url().includes(`/api/notices/${id}/dismiss`) && .getByTestId("status-message-list")
req.method() === "POST", .getByRole("link");
); await expect(items).toHaveText([
await row.getByRole("button", { name: "Dismiss" }).click(); "Front Door is offline",
await request; "Cpu is slow (60 ms)",
await expect(row).toHaveCount(0); ]);
const [first, second] = await Promise.all([
items.nth(0).boundingBox(),
items.nth(1).boundingBox(),
]);
expect(second!.y).toBeGreaterThan(first!.y);
}); });
test("dismissed config rows move to the dismissed list", async ({ test("a config row can be muted but not acknowledged", async ({
frigateApp, frigateApp,
}) => { }) => {
const id = "config:detect:fps-greater-than-five:camera.garage"; const id = "config:detect:fps-greater-than-five:camera.garage";
@@ -1134,12 +1232,49 @@ test.describe("System — Health notices sources @medium", () => {
}, },
}, },
stats: QUIET_STATS, stats: QUIET_STATS,
dismissedChecks: [{ id, dismissed_at: NOW - 120 }], });
// the list gains the mute after the POST so the refetch hides the row
let muted = false;
await frigateApp.page.route(`**/api/notices/${id}/mute`, (route) => {
muted = true;
return route.fulfill({ json: { success: true } });
});
await frigateApp.page.route("**/api/notices/muted_checks", (route) =>
route.fulfill({ json: muted ? [{ id, muted_at: NOW }] : [] }),
);
await frigateApp.goto("/system#health");
const row = frigateApp.page.getByTestId(`health-problem-${id}`);
await expect(row).toBeVisible({ timeout: 15_000 });
await expect(row.getByRole("button", { name: "Acknowledge" })).toHaveCount(
0,
);
const request = frigateApp.page.waitForRequest(
(req) =>
req.url().includes(`/api/notices/${id}/mute`) &&
req.method() === "POST",
);
await row.getByRole("button", { name: "Mute", exact: true }).click();
await request;
await expect(row).toHaveCount(0);
});
test("muted config rows move to the hidden list", async ({ frigateApp }) => {
const id = "config:detect:fps-greater-than-five:camera.garage";
await frigateApp.installDefaults({
config: {
cameras: {
garage: { detect: { width: 2560, height: 1440, fps: 10 } },
},
},
stats: QUIET_STATS,
mutedChecks: [{ id, muted_at: NOW - 120 }],
}); });
await frigateApp.page.route( await frigateApp.page.route(
(url) => (url) =>
url.pathname.endsWith("/api/notices") && url.pathname.endsWith("/api/notices") &&
url.searchParams.get("include_dismissed") === "true", url.searchParams.get("include_hidden") === "true",
(route) => route.fulfill({ json: [] }), (route) => route.fulfill({ json: [] }),
); );
await frigateApp.goto("/system#health"); await frigateApp.goto("/system#health");
@@ -1153,12 +1288,14 @@ test.describe("System — Health notices sources @medium", () => {
await expect(row).toHaveCount(0); await expect(row).toHaveCount(0);
await frigateApp.page.getByRole("button", { name: "Filter" }).click(); await frigateApp.page.getByRole("button", { name: "Filter" }).click();
await frigateApp.page await frigateApp.page.getByRole("switch", { name: "Show hidden" }).click();
.getByRole("switch", { name: "Show dismissed" }) await frigateApp.page.keyboard.press("Escape");
.click();
await expect(row).toBeVisible(); await expect(row).toBeVisible();
await expect(row).toContainText("Dismissed"); await expect(row).toContainText("Muted");
await expect(row.getByRole("button", { name: "Dismiss" })).toHaveCount(0); await expect(row.getByRole("button", { name: "Unmute" })).toBeVisible();
await expect(
row.getByRole("button", { name: "Mute", exact: true }),
).toHaveCount(0);
}); });
}); });
@@ -1567,6 +1567,8 @@
"presetLabels": { "presetLabels": {
"preset-rpi-64-h264": "Raspberry Pi (H.264)", "preset-rpi-64-h264": "Raspberry Pi (H.264)",
"preset-rpi-64-h265": "Raspberry Pi (H.265)", "preset-rpi-64-h265": "Raspberry Pi (H.265)",
"preset-apple-silicon-h264": "Apple Silicon (H.264)",
"preset-apple-silicon-h265": "Apple Silicon (H.265)",
"preset-vaapi": "VAAPI (Intel/AMD GPU)", "preset-vaapi": "VAAPI (Intel/AMD GPU)",
"preset-intel-qsv-h264": "Intel QuickSync (H.264)", "preset-intel-qsv-h264": "Intel QuickSync (H.264)",
"preset-intel-qsv-h265": "Intel QuickSync (H.265)", "preset-intel-qsv-h265": "Intel QuickSync (H.265)",
+1
View File
@@ -48,6 +48,7 @@
"rkmpp": "RKMPP (Rockchip)", "rkmpp": "RKMPP (Rockchip)",
"jetson": "NVIDIA Jetson", "jetson": "NVIDIA Jetson",
"rpi": "V4L2 (Raspberry Pi)", "rpi": "V4L2 (Raspberry Pi)",
"apple-silicon": "Media engine (Apple Silicon)",
"none": "None (software decoding)" "none": "None (software decoding)"
} }
}, },
+18 -10
View File
@@ -19,20 +19,26 @@
"notices": { "notices": {
"title": "Notices", "title": "Notices",
"empty": "Your Frigate installation is healthy", "empty": "Your Frigate installation is healthy",
"dismiss": "Dismiss", "acknowledge": "Acknowledge",
"acknowledgeHint": "Hide until this happens again",
"mute": "Mute",
"muteHint": "Never show this again",
"unmute": "Unmute",
"showAgain": "Show again",
"openSettings": "Open settings", "openSettings": "Open settings",
"openLink": "Open link", "openLink": "Open link",
"noMatches": "No notices match the filter", "noMatches": "No notices match the filter",
"dismissedTitle": "Dismissed", "hiddenTitle": "Hidden",
"noneDismissed": "No dismissed notices", "noneHidden": "No hidden notices",
"clearDismissed": "Clear dismissed", "showAll": "Show all again",
"clearDismissedTitle": "Clear dismissed notices?", "showAllTitle": "Show all hidden notices?",
"clearDismissedDesc": "Every dismissed notice is deleted. Config and stream checks show again right away, and other notices return the next time they happen.", "showAllDesc": "Every acknowledged and muted notice returns to the Notices list, including config and stream checks.",
"firstSeen_one": "First seen {{time}}", "firstSeen_one": "First seen {{time}}",
"firstSeen_other": "First seen {{time}} · {{count}} times", "firstSeen_other": "First seen {{time}} · {{count}} times",
"dismissedAt": "Dismissed {{time}}", "acknowledgedAt": "Acknowledged {{time}}",
"mutedAt": "Muted {{time}}",
"filter": { "filter": {
"showDismissed": "Show dismissed", "showHidden": "Show hidden",
"severity": "Severity", "severity": "Severity",
"error": "Error", "error": "Error",
"warning": "Warning", "warning": "Warning",
@@ -42,6 +48,8 @@
"detector_stuck": "Detector {{detector}} was restarted after it stopped responding", "detector_stuck": "Detector {{detector}} was restarted after it stopped responding",
"model_download_failed": "Downloading {{file}} for {{model}} failed: {{error}}", "model_download_failed": "Downloading {{file}} for {{model}} failed: {{error}}",
"skipped_detections": "Detection could not keep up and skipped {{pct}}% of frames for over a minute", "skipped_detections": "Detection could not keep up and skipped {{pct}}% of frames for over a minute",
"ffmpeg_high_cpu": "FFmpeg CPU usage is high ({{cpu}}% average)",
"detect_high_cpu": "Detection CPU usage is high ({{cpu}}% average)",
"shm_too_low": "/dev/shm allocation ({{total}} MB) should be increased to at least {{min}} MB", "shm_too_low": "/dev/shm allocation ({{total}} MB) should be increased to at least {{min}} MB",
"failed_login_one": "Failed login attempt for {{user}}", "failed_login_one": "Failed login attempt for {{user}}",
"failed_login_other": "Failed login attempts for {{user}}", "failed_login_other": "Failed login attempts for {{user}}",
@@ -324,12 +332,12 @@
}, },
"lastRefreshed": "Last refreshed: ", "lastRefreshed": "Last refreshed: ",
"stats": { "stats": {
"ffmpegHighCpuUsage": "{{camera}} has high FFmpeg CPU usage ({{ffmpegAvg}}%)",
"cameraSkippedDetections": "{{camera}} is skipping detection on {{pct}}% of frames", "cameraSkippedDetections": "{{camera}} is skipping detection on {{pct}}% of frames",
"detectHighCpuUsage": "{{camera}} has high detect CPU usage ({{detectAvg}}%)",
"healthy": "System is healthy", "healthy": "System is healthy",
"systemNotices_one": "{{count}} system notice", "systemNotices_one": "{{count}} system notice",
"systemNotices_other": "{{count}} system notices", "systemNotices_other": "{{count}} system notices",
"moreMessages_one": "+{{count}}",
"moreMessages_other": "+{{count}}",
"reindexingEmbeddings": "Reindexing embeddings ({{processed}}% complete)", "reindexingEmbeddings": "Reindexing embeddings ({{processed}}% complete)",
"cameraIsOffline": "{{camera}} is offline", "cameraIsOffline": "{{camera}} is offline",
"detectIsSlow": "{{detect}} is slow ({{speed}} ms)", "detectIsSlow": "{{detect}} is slow ({{speed}} ms)",
+78
View File
@@ -0,0 +1,78 @@
import { StatusMessage } from "@/context/statusbar-context";
import { cn } from "@/lib/utils";
import { ProblemSeverity } from "@/types/stats";
import { IoIosWarning } from "react-icons/io";
import { Link } from "react-router-dom";
const SEVERITY_COLOR: Record<ProblemSeverity, string> = {
error: "text-danger",
warning: "text-orange-400",
info: "text-selected",
};
type StatusMessageItemProps = {
message: StatusMessage;
className?: string;
onNavigate?: () => void;
};
/** One status bar message, a link when it has one. */
export function StatusMessageItem({
message,
className,
onNavigate,
}: StatusMessageItemProps) {
const content = (
<div
className={cn(
"flex items-center gap-2 text-sm",
message.link && "cursor-pointer hover:underline",
className,
)}
>
<IoIosWarning
className={cn("size-5 shrink-0", SEVERITY_COLOR[message.severity])}
/>
{message.text}
</div>
);
if (!message.link) {
return content;
}
return (
<Link to={message.link} onClick={onNavigate}>
{content}
</Link>
);
}
type StatusMessageListProps = {
messages: StatusMessage[];
className?: string;
onNavigate?: () => void;
};
/** Status bar messages stacked one per line. */
export default function StatusMessageList({
messages,
className,
onNavigate,
}: StatusMessageListProps) {
return (
<div
className={cn("flex flex-col gap-2", className)}
data-testid="status-message-list"
>
{messages.map((message, index) => (
// ids are unique only within a message key
<StatusMessageItem
key={`${index}:${message.id}`}
message={message}
onNavigate={onNavigate}
/>
))}
</div>
);
}
+55 -75
View File
@@ -1,20 +1,24 @@
import { useEmbeddingsReindexProgress } from "@/api/ws"; import { StatusMessage } from "@/context/statusbar-context";
import { useAutoFrigateStats } from "@/hooks/use-stats";
import useStatusMessages from "@/hooks/use-status-messages";
import StatusMessageList, {
StatusMessageItem,
} from "@/components/StatusMessageList";
import { import {
StatusBarMessagesContext, Popover,
StatusMessage, PopoverContent,
} from "@/context/statusbar-context"; PopoverTrigger,
import useStats, { useAutoFrigateStats } from "@/hooks/use-stats"; } from "@/components/ui/popover";
import StatusBarNotices from "@/components/health/StatusBarNotices"; import StatusBarNotices from "@/components/health/StatusBarNotices";
import { cn } from "@/lib/utils"; import { cn } from "@/lib/utils";
import type { ProfilesApiResponse } from "@/types/profile"; import type { ProfilesApiResponse } from "@/types/profile";
import { getProfileColor } from "@/utils/profileColors"; import { getProfileColor } from "@/utils/profileColors";
import { useIsAdmin } from "@/hooks/use-is-admin"; import { useIsAdmin } from "@/hooks/use-is-admin";
import { useContext, useEffect, useMemo } from "react"; import { useMemo, useState } from "react";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import useSWR from "swr"; import useSWR from "swr";
import { FaCheck } from "react-icons/fa"; import { FaCheck } from "react-icons/fa";
import { IoIosWarning } from "react-icons/io";
import { MdCircle } from "react-icons/md"; import { MdCircle } from "react-icons/md";
import { Link } from "react-router-dom"; import { Link } from "react-router-dom";
@@ -22,9 +26,7 @@ export default function Statusbar() {
const { t } = useTranslation(["views/system"]); const { t } = useTranslation(["views/system"]);
const isAdmin = useIsAdmin(); const isAdmin = useIsAdmin();
const { messages, addMessage, clearMessages } = useContext( const messages = useStatusMessages();
StatusBarMessagesContext,
)!;
const stats = useAutoFrigateStats(); const stats = useAutoFrigateStats();
@@ -38,21 +40,6 @@ export default function Statusbar() {
return parseInt(systemCpu); return parseInt(systemCpu);
}, [stats]); }, [stats]);
const { potentialProblems } = useStats(stats);
useEffect(() => {
clearMessages("stats");
potentialProblems.forEach((problem) => {
addMessage(
"stats",
problem.text,
problem.color,
undefined,
problem.relevantLink,
);
});
}, [potentialProblems, addMessage, clearMessages]);
const { data: profilesData } = useSWR<ProfilesApiResponse>("profiles"); const { data: profilesData } = useSWR<ProfilesApiResponse>("profiles");
const activeProfile = useMemo(() => { const activeProfile = useMemo(() => {
@@ -68,28 +55,6 @@ export default function Statusbar() {
}; };
}, [profilesData]); }, [profilesData]);
const { payload: reindexState } = useEmbeddingsReindexProgress();
useEffect(() => {
if (reindexState) {
if (reindexState.status == "indexing") {
clearMessages("embeddings-reindex");
addMessage(
"embeddings-reindex",
t("stats.reindexingEmbeddings", {
processed: Math.floor(
(reindexState.processed_objects / reindexState.total_objects) *
100,
),
}),
);
}
if (reindexState.status === "completed") {
clearMessages("embeddings-reindex");
}
}
}, [reindexState, addMessage, clearMessages, t]);
return ( return (
<div className="absolute bottom-0 left-0 right-0 z-10 flex h-8 w-full items-center justify-between border-t border-secondary-highlight bg-background_alt px-4 dark:text-secondary-foreground"> <div className="absolute bottom-0 left-0 right-0 z-10 flex h-8 w-full items-center justify-between border-t border-secondary-highlight bg-background_alt px-4 dark:text-secondary-foreground">
<div className="flex h-full items-center gap-2"> <div className="flex h-full items-center gap-2">
@@ -187,42 +152,57 @@ export default function Statusbar() {
))} ))}
</div> </div>
<div className="no-scrollbar flex h-full max-w-[50%] items-center gap-2 overflow-x-auto"> <div className="no-scrollbar flex h-full max-w-[50%] items-center gap-2 overflow-x-auto">
{!isAdmin ? null : Object.entries(messages).length === 0 ? ( {!isAdmin ? null : messages.length === 0 ? (
<Link to="/system#health" className="flex items-center gap-2 text-sm"> <Link to="/system#health" className="flex items-center gap-2 text-sm">
<FaCheck className="size-3 text-green-500" /> <FaCheck className="size-3 text-green-500" />
{t("stats.healthy")} {t("stats.healthy")}
</Link> </Link>
) : ( ) : messages.length === 1 ? (
Object.entries(messages).map(([key, messageArray]) => ( <StatusMessageItem
<div key={key} className="flex h-full items-center gap-2"> message={messages[0]}
{messageArray.map(({ text, color, link }: StatusMessage) => { className="whitespace-nowrap"
const message = (
<div
key={text}
className={`flex items-center gap-2 whitespace-nowrap text-sm ${link ? "cursor-pointer hover:underline" : ""}`}
>
<IoIosWarning
className={`size-5 ${color || "text-danger"}`}
/> />
{text} ) : (
</div> <StatusMessagesPopover messages={messages} />
);
if (link) {
return (
<Link key={text} to={link}>
{message}
</Link>
);
} else {
return message;
}
})}
</div>
))
)} )}
{isAdmin && <StatusBarNotices />} {isAdmin && <StatusBarNotices />}
</div> </div>
</div> </div>
); );
} }
type StatusMessagesPopoverProps = {
messages: StatusMessage[];
};
/** The most severe message and a count of the rest, which open the full list. */
function StatusMessagesPopover({ messages }: StatusMessagesPopoverProps) {
const { t } = useTranslation(["views/system"]);
const [open, setOpen] = useState(false);
const [first, ...rest] = messages;
return (
<Popover open={open} onOpenChange={setOpen}>
<PopoverTrigger asChild>
<button
type="button"
className="flex items-center gap-2 text-sm hover:underline"
>
<StatusMessageItem
message={{ ...first, link: undefined }}
className="whitespace-nowrap"
/>
<span className="shrink-0 rounded-full bg-secondary px-1.5 text-xs text-secondary-foreground">
{t("stats.moreMessages", { count: rest.length })}
</span>
</button>
</PopoverTrigger>
<PopoverContent side="top" align="end" className="w-auto max-w-md">
<StatusMessageList
messages={messages}
onNavigate={() => setOpen(false)}
/>
</PopoverContent>
</Popover>
);
}
+46 -6
View File
@@ -2,7 +2,11 @@ import { Link } from "react-router-dom";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
import { FaTriangleExclamation } from "react-icons/fa6"; import { FaTriangleExclamation } from "react-icons/fa6";
import { import {
LuBell,
LuBellOff,
LuCheck,
LuExternalLink, LuExternalLink,
LuEye,
LuInfo, LuInfo,
LuSlidersHorizontal, LuSlidersHorizontal,
LuX, LuX,
@@ -51,7 +55,13 @@ export default function HealthProblemRow({ problem }: HealthProblemRowProps) {
problem.link || problem.link ||
problem.docLink || problem.docLink ||
problem.externalLink || problem.externalLink ||
problem.onDismiss; problem.onAcknowledge ||
problem.onMute ||
problem.onUnhide;
const unhideLabel =
problem.hidden === "muted"
? t("health.notices.unmute")
: t("health.notices.showAgain");
return ( return (
<div <div
@@ -150,16 +160,46 @@ export default function HealthProblemRow({ problem }: HealthProblemRowProps) {
</Button> </Button>
</RowAction> </RowAction>
)} )}
{problem.onDismiss && ( {problem.onAcknowledge && (
<RowAction label={t("health.notices.dismiss")}> <RowAction label={t("health.notices.acknowledgeHint")}>
<Button <Button
variant="ghost" variant="ghost"
size="icon" size="icon"
className={ICON_BUTTON_CLASS} className={ICON_BUTTON_CLASS}
aria-label={t("health.notices.dismiss")} aria-label={t("health.notices.acknowledge")}
onClick={problem.onDismiss} onClick={problem.onAcknowledge}
> >
<LuX className="size-3.5" /> <LuCheck className="size-3.5" />
</Button>
</RowAction>
)}
{problem.onMute && (
<RowAction label={t("health.notices.muteHint")}>
<Button
variant="ghost"
size="icon"
className={ICON_BUTTON_CLASS}
aria-label={t("health.notices.mute")}
onClick={problem.onMute}
>
<LuBellOff className="size-3.5" />
</Button>
</RowAction>
)}
{problem.onUnhide && (
<RowAction label={unhideLabel}>
<Button
variant="ghost"
size="icon"
className={ICON_BUTTON_CLASS}
aria-label={unhideLabel}
onClick={problem.onUnhide}
>
{problem.hidden === "muted" ? (
<LuBell className="size-3.5" />
) : (
<LuEye className="size-3.5" />
)}
</Button> </Button>
</RowAction> </RowAction>
)} )}
@@ -24,7 +24,7 @@ export default function NoticeFilterButton({
const { t } = useTranslation(["views/system", "components/filter"]); const { t } = useTranslation(["views/system", "components/filter"]);
const [open, setOpen] = useState(false); const [open, setOpen] = useState(false);
const active = const active =
filter.showDismissed || filter.showHidden ||
filter.severities.length < DEFAULT_NOTICE_FILTER.severities.length; filter.severities.length < DEFAULT_NOTICE_FILTER.severities.length;
const severityLabels: Record<HealthSeverity, string> = { const severityLabels: Record<HealthSeverity, string> = {
@@ -59,10 +59,10 @@ export default function NoticeFilterButton({
const content = ( const content = (
<div className="space-y-3 p-4"> <div className="space-y-3 p-4">
<FilterSwitch <FilterSwitch
label={t("health.notices.filter.showDismissed")} label={t("health.notices.filter.showHidden")}
isChecked={filter.showDismissed} isChecked={filter.showHidden}
onCheckedChange={(showDismissed) => onCheckedChange={(showHidden) =>
onFilterChange({ ...filter, showDismissed }) onFilterChange({ ...filter, showHidden })
} }
/> />
<DropdownMenuSeparator /> <DropdownMenuSeparator />
+17 -19
View File
@@ -23,9 +23,9 @@ type NoticesPaneProps = {
export default function NoticesPane({ filter }: NoticesPaneProps) { export default function NoticesPane({ filter }: NoticesPaneProps) {
const { t } = useTranslation(["views/system", "views/settings", "common"]); const { t } = useTranslation(["views/system", "views/settings", "common"]);
const { problems, dismissed, loading, clearDismissed } = useHealthProblems( const { problems, hidden, loading, unhideAll } = useHealthProblems(
t, t,
filter.showDismissed, filter.showHidden,
); );
const [confirmClear, setConfirmClear] = useState(false); const [confirmClear, setConfirmClear] = useState(false);
@@ -37,12 +37,10 @@ export default function NoticesPane({ filter }: NoticesPaneProps) {
[problems, filter.severities], [problems, filter.severities],
); );
const shownDismissed = useMemo( const shownHidden = useMemo(
() => () =>
dismissed?.filter((problem) => hidden?.filter((problem) => filter.severities.includes(problem.severity)),
filter.severities.includes(problem.severity), [hidden, filter.severities],
),
[dismissed, filter.severities],
); );
return ( return (
@@ -70,32 +68,32 @@ export default function NoticesPane({ filter }: NoticesPaneProps) {
</div> </div>
)} )}
</div> </div>
{filter.showDismissed && ( {filter.showHidden && (
<div className="flex flex-col gap-2"> <div className="flex flex-col gap-2">
<div className="flex items-center justify-between gap-2"> <div className="flex items-center justify-between gap-2">
<div className="text-sm text-muted-foreground"> <div className="text-sm text-muted-foreground">
{t("health.notices.dismissedTitle")} {t("health.notices.hiddenTitle")}
</div> </div>
{dismissed && dismissed.length > 0 && ( {hidden && hidden.length > 0 && (
<Button <Button
variant="ghost" variant="ghost"
size="sm" size="sm"
onClick={() => setConfirmClear(true)} onClick={() => setConfirmClear(true)}
> >
{t("health.notices.clearDismissed")} {t("health.notices.showAll")}
</Button> </Button>
)} )}
</div> </div>
<div className="rounded-lg bg-background_alt p-2.5 md:rounded-2xl"> <div className="rounded-lg bg-background_alt p-2.5 md:rounded-2xl">
{shownDismissed === undefined ? ( {shownHidden === undefined ? (
<Skeleton className="h-10 w-full" /> <Skeleton className="h-10 w-full" />
) : shownDismissed.length === 0 ? ( ) : shownHidden.length === 0 ? (
<div className="px-1 py-2 text-sm text-muted-foreground"> <div className="px-1 py-2 text-sm text-muted-foreground">
{t("health.notices.noneDismissed")} {t("health.notices.noneHidden")}
</div> </div>
) : ( ) : (
<div className="flex flex-col"> <div className="flex flex-col">
{shownDismissed.map((problem) => ( {shownHidden.map((problem) => (
<HealthProblemRow key={problem.id} problem={problem} /> <HealthProblemRow key={problem.id} problem={problem} />
))} ))}
</div> </div>
@@ -107,10 +105,10 @@ export default function NoticesPane({ filter }: NoticesPaneProps) {
<AlertDialogContent> <AlertDialogContent>
<AlertDialogHeader> <AlertDialogHeader>
<AlertDialogTitle> <AlertDialogTitle>
{t("health.notices.clearDismissedTitle")} {t("health.notices.showAllTitle")}
</AlertDialogTitle> </AlertDialogTitle>
<AlertDialogDescription> <AlertDialogDescription>
{t("health.notices.clearDismissedDesc")} {t("health.notices.showAllDesc")}
</AlertDialogDescription> </AlertDialogDescription>
</AlertDialogHeader> </AlertDialogHeader>
<AlertDialogFooter> <AlertDialogFooter>
@@ -119,9 +117,9 @@ export default function NoticesPane({ filter }: NoticesPaneProps) {
</AlertDialogCancel> </AlertDialogCancel>
<AlertDialogAction <AlertDialogAction
className={buttonVariants({ variant: "destructive" })} className={buttonVariants({ variant: "destructive" })}
onClick={clearDismissed} onClick={unhideAll}
> >
{t("health.notices.clearDismissed")} {t("health.notices.showAll")}
</AlertDialogAction> </AlertDialogAction>
</AlertDialogFooter> </AlertDialogFooter>
</AlertDialogContent> </AlertDialogContent>
@@ -2,7 +2,7 @@ import { useTranslation } from "react-i18next";
import { Link } from "react-router-dom"; import { Link } from "react-router-dom";
import { useHealthProblems } from "@/hooks/use-health-problems"; import { useHealthProblems } from "@/hooks/use-health-problems";
/** The count of undismissed Notices rows, shown before the status bar's health text. */ /** The count of shown Notices rows, shown before the status bar's health text. */
export default function StatusBarNotices() { export default function StatusBarNotices() {
const { t } = useTranslation(["views/system"]); const { t } = useTranslation(["views/system"]);
const { problems, loading } = useHealthProblems(t); const { problems, loading } = useHealthProblems(t);
+9 -97
View File
@@ -1,30 +1,15 @@
import NavItem from "./NavItem"; import NavItem from "./NavItem";
import { IoIosWarning } from "react-icons/io"; import { IoIosWarning } from "react-icons/io";
import { Drawer, DrawerContent, DrawerTrigger } from "../ui/drawer"; import { Drawer, DrawerContent, DrawerTrigger } from "../ui/drawer";
import useSWR from "swr"; import { useLayoutEffect, useRef, useState } from "react";
import { FrigateStats } from "@/types/stats"; import useStatusMessages from "@/hooks/use-status-messages";
import { useEmbeddingsReindexProgress, useFrigateStats } from "@/api/ws"; import StatusMessageList from "../StatusMessageList";
import {
useContext,
useEffect,
useLayoutEffect,
useMemo,
useRef,
useState,
} from "react";
import useStats from "@/hooks/use-stats";
import { useIsAdmin } from "@/hooks/use-is-admin"; import { useIsAdmin } from "@/hooks/use-is-admin";
import GeneralSettings from "../menu/GeneralSettings"; import GeneralSettings from "../menu/GeneralSettings";
import useNavigation from "@/hooks/use-navigation"; import useNavigation from "@/hooks/use-navigation";
import {
StatusBarMessagesContext,
StatusMessage,
} from "@/context/statusbar-context";
import { Link } from "react-router-dom";
import { cn } from "@/lib/utils"; import { cn } from "@/lib/utils";
import { isMobile } from "react-device-detect"; import { isMobile } from "react-device-detect";
import { isPWA } from "@/utils/isPWA"; import { isPWA } from "@/utils/isPWA";
import { useTranslation } from "react-i18next";
function Bottombar() { function Bottombar() {
const navItems = useNavigation("secondary"); const navItems = useNavigation("secondary");
@@ -98,64 +83,12 @@ type StatusAlertNavProps = {
large?: boolean; large?: boolean;
}; };
function StatusAlertNav({ className, large }: StatusAlertNavProps) { function StatusAlertNav({ className, large }: StatusAlertNavProps) {
const { t } = useTranslation(["views/system"]); const messages = useStatusMessages();
const { data: initialStats } = useSWR<FrigateStats>("stats", {
revalidateOnFocus: false,
});
const latestStats = useFrigateStats();
const { messages, addMessage, clearMessages } = useContext(
StatusBarMessagesContext,
)!;
const stats = useMemo(() => {
if (latestStats) {
return latestStats;
}
return initialStats;
}, [initialStats, latestStats]);
const { potentialProblems } = useStats(stats);
useEffect(() => {
clearMessages("stats");
potentialProblems.forEach((problem) => {
addMessage(
"stats",
problem.text,
problem.color,
undefined,
problem.relevantLink,
);
});
}, [potentialProblems, addMessage, clearMessages]);
const { payload: reindexState } = useEmbeddingsReindexProgress();
useEffect(() => {
if (reindexState) {
if (reindexState.status == "indexing") {
clearMessages("embeddings-reindex");
addMessage(
"embeddings-reindex",
t("stats.reindexingEmbeddings", {
processed: Math.floor(
(reindexState.processed_objects / reindexState.total_objects) *
100,
),
}),
);
}
if (reindexState.status === "completed") {
clearMessages("embeddings-reindex");
}
}
}, [reindexState, addMessage, clearMessages, t]);
const isAdmin = useIsAdmin(); const isAdmin = useIsAdmin();
// problems link to admin-only pages // problems link to admin-only pages
if (!isAdmin || !messages || Object.keys(messages).length === 0) { if (!isAdmin || messages.length === 0) {
return; return;
} }
@@ -163,6 +96,7 @@ function StatusAlertNav({ className, large }: StatusAlertNavProps) {
<Drawer> <Drawer>
<DrawerTrigger asChild> <DrawerTrigger asChild>
<div <div
data-testid="status-alert-trigger"
className={cn( className={cn(
"flex flex-col items-center justify-center p-2", "flex flex-col items-center justify-center p-2",
large && "size-12", large && "size-12",
@@ -182,32 +116,10 @@ function StatusAlertNav({ className, large }: StatusAlertNavProps) {
className, className,
)} )}
> >
<div className="scrollbar-container flex h-auto w-full flex-col items-center gap-2 overflow-y-auto overflow-x-hidden px-2 py-4"> <StatusMessageList
{Object.entries(messages).map(([key, messageArray]) => ( messages={messages}
<div key={key} className="flex w-full items-center gap-2"> className="scrollbar-container w-full overflow-y-auto overflow-x-hidden px-4 py-4"
{messageArray.map(({ id, text, color, link }: StatusMessage) => {
const message = (
<div key={id} className="flex items-center gap-2 text-xs">
<IoIosWarning
className={`size-5 ${color || "text-danger"}`}
/> />
{text}
</div>
);
if (link) {
return (
<Link key={id} to={link}>
{message}
</Link>
);
} else {
return message;
}
})}
</div>
))}
</div>
</DrawerContent> </DrawerContent>
</Drawer> </Drawer>
); );
+2 -2
View File
@@ -1,6 +1,6 @@
import { useCallback, useMemo, useRef, useState } from "react"; import { useCallback, useMemo, useRef, useState } from "react";
import { LuFolderX } from "react-icons/lu"; import { LuFolderX } from "react-icons/lu";
import { isMobileOnly, isSafari } from "react-device-detect"; import { isMobileOnly } from "react-device-detect";
import { LuPause, LuPlay } from "react-icons/lu"; import { LuPause, LuPlay } from "react-icons/lu";
import { import {
DropdownMenu, DropdownMenu,
@@ -54,7 +54,7 @@ const CONTROLS_DEFAULT: VideoControls = {
snapshot: false, snapshot: false,
fullscreen: false, fullscreen: false,
}; };
const PLAYBACK_RATE_DEFAULT = isSafari ? [0.5, 1, 2] : [0.5, 1, 2, 4, 8, 16]; const PLAYBACK_RATE_DEFAULT = [0.5, 1, 2, 4, 8, 16];
const MIN_ITEMS_WRAP = 6; const MIN_ITEMS_WRAP = 6;
type VideoControlsProps = { type VideoControlsProps = {
+3 -2
View File
@@ -1,9 +1,10 @@
import { createContext } from "react"; import { createContext } from "react";
import { ProblemSeverity } from "@/types/stats";
export type StatusMessage = { export type StatusMessage = {
id: string; id: string;
text: string; text: string;
color?: string; severity: ProblemSeverity;
link?: string; link?: string;
}; };
@@ -16,7 +17,7 @@ type StatusBarMessagesContextValue = {
addMessage: ( addMessage: (
key: string, key: string,
message: string, message: string,
color?: string, severity?: ProblemSeverity,
messageId?: string, messageId?: string,
link?: string, link?: string,
) => string | undefined; ) => string | undefined;
+5 -4
View File
@@ -3,6 +3,7 @@ import {
StatusBarMessagesContext, StatusBarMessagesContext,
StatusMessagesState, StatusMessagesState,
} from "@/context/statusbar-context"; } from "@/context/statusbar-context";
import { ProblemSeverity } from "@/types/stats";
type StatusBarMessagesProviderProps = { type StatusBarMessagesProviderProps = {
children: ReactNode; children: ReactNode;
@@ -19,21 +20,21 @@ export function StatusBarMessagesProvider({
( (
key: string, key: string,
message: string, message: string,
color?: string, severity: ProblemSeverity = "error",
messageId?: string, messageId?: string,
link?: string, link?: string,
) => { ) => {
if (!key || !message) return; if (!key || !message) return;
const id = messageId ?? Date.now().toString(); // the text is the fallback id, so repeating a message replaces it
const msgColor = color ?? "text-danger"; const id = messageId ?? message;
setMessagesState((prevMessages) => { setMessagesState((prevMessages) => {
const existingMessages = prevMessages[key] || []; const existingMessages = prevMessages[key] || [];
// Check if a message with the same ID already exists // Check if a message with the same ID already exists
const messageIndex = existingMessages.findIndex((msg) => msg.id === id); const messageIndex = existingMessages.findIndex((msg) => msg.id === id);
const newMessage = { id, text: message, color: msgColor, link }; const newMessage = { id, text: message, severity, link };
// If the message exists, replace it, otherwise add the new message // If the message exists, replace it, otherwise add the new message
let updatedMessages; let updatedMessages;
+77 -53
View File
@@ -5,25 +5,25 @@ import useSWR from "swr";
import { useDateLocale } from "@/hooks/use-date-locale"; import { useDateLocale } from "@/hooks/use-date-locale";
import { useTimezone } from "@/hooks/use-date-utils"; import { useTimezone } from "@/hooks/use-date-utils";
import { useHealthChecks } from "@/hooks/use-health-checks"; import { useHealthChecks } from "@/hooks/use-health-checks";
import { useNotices } from "@/hooks/use-notices"; import { hiddenAt, useNotices } from "@/hooks/use-notices";
import { evaluateConfigHealth } from "@/utils/configHealth"; import { evaluateConfigHealth } from "@/utils/configHealth";
import { formatUnixTimestampToDateTime } from "@/utils/dateUtil"; import { formatUnixTimestampToDateTime } from "@/utils/dateUtil";
import { sortHealthProblems } from "@/utils/healthSort"; import { sortHealthProblems } from "@/utils/healthSort";
import { streamHealth } from "@/utils/streamHealth"; import { streamHealth } from "@/utils/streamHealth";
import type { FrigateConfig } from "@/types/frigateConfig"; import type { FrigateConfig } from "@/types/frigateConfig";
import type { HealthProblem } from "@/types/health"; import type { HealthProblem } from "@/types/health";
import type { DismissedCheck, Notice } from "@/types/notice"; import type { MutedCheck, Notice } from "@/types/notice";
const EXTERNAL_LINK = /^https?:\/\//; const EXTERNAL_LINK = /^https?:\/\//;
type HealthProblems = { type HealthProblems = {
/** undismissed rows, most severe first */ /** shown rows, most severe first */
problems: HealthProblem[]; problems: HealthProblem[];
/** dismissed rows, most recently dismissed first; undefined until loaded */ /** acknowledged and muted rows, most recently hidden first; undefined until loaded */
dismissed?: HealthProblem[]; hidden?: HealthProblem[];
loading: boolean; loading: boolean;
/** delete every dismissed row, so each can show again */ /** show every hidden row again */
clearDismissed: () => Promise<void>; unhideAll: () => Promise<void>;
}; };
/** /**
@@ -34,7 +34,7 @@ type HealthProblems = {
*/ */
export function useHealthProblems( export function useHealthProblems(
t: TFunction, t: TFunction,
showDismissed = false, showHidden = false,
): HealthProblems { ): HealthProblems {
const { data: config } = useSWR<FrigateConfig>("config", { const { data: config } = useSWR<FrigateConfig>("config", {
revalidateOnFocus: false, revalidateOnFocus: false,
@@ -43,30 +43,40 @@ export function useHealthProblems(
const locale = useDateLocale(); const locale = useDateLocale();
const { const {
notices, notices,
dismissed: dismissedNotices, hidden: hiddenNotices,
dismiss, acknowledge,
mutateDismissed, mute,
} = useNotices(showDismissed); unhide,
const { data: dismissedChecks, mutate: mutateDismissedChecks } = useSWR< mutateHidden,
DismissedCheck[] } = useNotices(showHidden);
>("notices/dismissed_checks"); const { data: mutedChecks, mutate: mutateMutedChecks } = useSWR<MutedCheck[]>(
"notices/muted_checks",
);
const { const {
stream: { results }, stream: { results },
} = useHealthChecks(); } = useHealthChecks();
const dismissCheck = useCallback( const muteCheck = useCallback(
async (id: string) => { async (id: string) => {
await axios.post(`notices/${id}/dismiss`); await axios.post(`notices/${id}/mute`);
mutateDismissedChecks(); mutateMutedChecks();
}, },
[mutateDismissedChecks], [mutateMutedChecks],
); );
const clearDismissed = useCallback(async () => { const unmuteCheck = useCallback(
await axios.delete("notices/dismissed"); async (id: string) => {
mutateDismissed(); await axios.delete(`notices/${id}/hidden`);
mutateDismissedChecks(); mutateMutedChecks();
}, [mutateDismissed, mutateDismissedChecks]); },
[mutateMutedChecks],
);
const unhideAll = useCallback(async () => {
await axios.delete("notices/hidden");
mutateHidden();
mutateMutedChecks();
}, [mutateHidden, mutateMutedChecks]);
const formatTime = useCallback( const formatTime = useCallback(
(timestamp: number) => (timestamp: number) =>
@@ -98,23 +108,37 @@ export function useHealthProblems(
count: notice.count, count: notice.count,
}), }),
meta: meta:
notice.dismissed_at === null notice.muted_at !== null
? t("health.notices.firstSeen", { ? t("health.notices.mutedAt", {
ns: "views/system",
time: formatTime(notice.muted_at),
})
: notice.acknowledged_at !== null
? t("health.notices.acknowledgedAt", {
ns: "views/system",
time: formatTime(notice.acknowledged_at),
})
: t("health.notices.firstSeen", {
ns: "views/system", ns: "views/system",
time: formatTime(notice.first_seen), time: formatTime(notice.first_seen),
count: notice.count, count: notice.count,
})
: t("health.notices.dismissedAt", {
ns: "views/system",
time: formatTime(notice.dismissed_at),
}), }),
link: external ? undefined : link, link: external ? undefined : link,
externalLink: external ? link : undefined, externalLink: external ? link : undefined,
onDismiss: ...(hiddenAt(notice) > 0
notice.dismissed_at === null ? () => dismiss(notice.id) : undefined, ? {
hidden: notice.muted_at !== null ? "muted" : "acknowledged",
onUnhide: () => unhide(notice.id),
}
: {
onAcknowledge: notice.acknowledgeable
? () => acknowledge(notice.id)
: undefined,
onMute: () => mute(notice.id),
}),
}; };
}, },
[dismiss, formatTime, t], [acknowledge, mute, unhide, formatTime, t],
); );
const checks = useMemo<HealthProblem[]>( const checks = useMemo<HealthProblem[]>(
@@ -128,12 +152,10 @@ export function useHealthProblems(
[config, results, t], [config, results, t],
); );
const dismissedAt = useMemo( const mutedAt = useMemo(
() => () =>
new Map( new Map((mutedChecks ?? []).map((check) => [check.id, check.muted_at])),
(dismissedChecks ?? []).map((check) => [check.id, check.dismissed_at]), [mutedChecks],
),
[dismissedChecks],
); );
const problems = useMemo( const problems = useMemo(
@@ -141,27 +163,27 @@ export function useHealthProblems(
sortHealthProblems([ sortHealthProblems([
...(notices ?? []).map(noticeRow), ...(notices ?? []).map(noticeRow),
...checks ...checks
.filter((check) => !dismissedAt.has(check.id)) .filter((check) => !mutedAt.has(check.id))
.map((check) => ({ .map((check) => ({
...check, ...check,
onDismiss: () => dismissCheck(check.id), onMute: () => muteCheck(check.id),
})), })),
]), ]),
[notices, noticeRow, checks, dismissedAt, dismissCheck], [notices, noticeRow, checks, mutedAt, muteCheck],
); );
const dismissed = useMemo(() => { const hidden = useMemo(() => {
if (!showDismissed || dismissedNotices === undefined) { if (!showHidden || hiddenNotices === undefined) {
return undefined; return undefined;
} }
const rows = [ const rows = [
...dismissedNotices.map((notice) => ({ ...hiddenNotices.map((notice) => ({
at: notice.dismissed_at ?? 0, at: hiddenAt(notice),
row: noticeRow(notice), row: noticeRow(notice),
})), })),
...checks.flatMap((check) => { ...checks.flatMap((check) => {
const at = dismissedAt.get(check.id); const at = mutedAt.get(check.id);
return at === undefined return at === undefined
? [] ? []
@@ -170,10 +192,12 @@ export function useHealthProblems(
at, at,
row: { row: {
...check, ...check,
meta: t("health.notices.dismissedAt", { meta: t("health.notices.mutedAt", {
ns: "views/system", ns: "views/system",
time: formatTime(at), time: formatTime(at),
}), }),
hidden: "muted" as const,
onUnhide: () => unmuteCheck(check.id),
}, },
}, },
]; ];
@@ -182,17 +206,17 @@ export function useHealthProblems(
return rows.sort((a, b) => b.at - a.at).map(({ row }) => row); return rows.sort((a, b) => b.at - a.at).map(({ row }) => row);
}, [ }, [
showDismissed, showHidden,
dismissedNotices, hiddenNotices,
noticeRow, noticeRow,
checks, checks,
dismissedAt, mutedAt,
formatTime, formatTime,
unmuteCheck,
t, t,
]); ]);
const loading = const loading = notices === undefined || mutedChecks === undefined || !config;
notices === undefined || dismissedChecks === undefined || !config;
return { problems, dismissed, loading, clearDismissed }; return { problems, hidden, loading, unhideAll };
} }
+38 -22
View File
@@ -4,19 +4,22 @@ import useSWR from "swr";
import { useWs } from "@/api/ws"; import { useWs } from "@/api/ws";
import type { Notice } from "@/types/notice"; import type { Notice } from "@/types/notice";
/** When a hidden notice was acknowledged or muted. */
export function hiddenAt(notice: Notice): number {
return notice.muted_at ?? notice.acknowledged_at ?? 0;
}
/** /**
* Active notices come from a REST snapshot, then from every `notices` * Active notices come from a REST snapshot, then from every `notices`
* websocket payload. Dismissed notices are fetched only while the history is * websocket payload. Hidden notices are fetched only while the hidden list is
* shown, and again when the active list changes or the tab regains focus. A * shown, and again when the active list changes or the tab regains focus.
* purge in another tab leaves the active list unchanged, so only focus
* catches it.
*/ */
export function useNotices(showDismissed: boolean) { export function useNotices(showHidden: boolean) {
const { data: initial, mutate } = useSWR<Notice[]>("notices", { const { data: initial, mutate } = useSWR<Notice[]>("notices", {
revalidateOnFocus: false, revalidateOnFocus: false,
}); });
const { data: history, mutate: mutateHistory } = useSWR<Notice[]>( const { data: all, mutate: mutateHidden } = useSWR<Notice[]>(
showDismissed ? ["notices", { include_dismissed: true }] : null, showHidden ? ["notices", { include_hidden: true }] : null,
); );
const { const {
value: { payload }, value: { payload },
@@ -30,31 +33,44 @@ export function useNotices(showDismissed: boolean) {
[payload], [payload],
); );
// once a websocket frame has arrived it is the source of truth; a dismiss // once a websocket frame has arrived it is the source of truth; every
// still shows up because the registry publishes a new frame after it // acknowledge, mute, and unhide publishes a new frame
const notices = live ?? initial; const notices = live ?? initial;
// refetch the history whenever the active list changes; SWR ignores the // refetch the hidden list whenever the active list changes; SWR ignores the
// call while the history is hidden // call while the hidden list is not shown
useEffect(() => { useEffect(() => {
mutateHistory(); mutateHidden();
}, [live, mutateHistory]); }, [live, mutateHidden]);
const dismissed = useMemo( const hidden = useMemo(
() => () =>
history all
?.filter((notice) => notice.dismissed_at !== null) ?.filter((notice) => hiddenAt(notice) > 0)
.sort((a, b) => (b.dismissed_at ?? 0) - (a.dismissed_at ?? 0)), .sort((a, b) => hiddenAt(b) - hiddenAt(a)),
[history], [all],
); );
const dismiss = useCallback( const act = useCallback(
async (id: string) => { async (request: Promise<unknown>) => {
await axios.post(`notices/${id}/dismiss`); await request;
mutate(); mutate();
}, },
[mutate], [mutate],
); );
return { notices, dismissed, dismiss, mutateDismissed: mutateHistory }; const acknowledge = useCallback(
(id: string) => act(axios.post(`notices/${id}/acknowledge`)),
[act],
);
const mute = useCallback(
(id: string) => act(axios.post(`notices/${id}/mute`)),
[act],
);
const unhide = useCallback(
(id: string) => act(axios.delete(`notices/${id}/hidden`)),
[act],
);
return { notices, hidden, acknowledge, mute, unhide, mutateHidden };
} }
+3 -48
View File
@@ -1,9 +1,5 @@
import { FrigateConfig } from "@/types/frigateConfig"; import { FrigateConfig } from "@/types/frigateConfig";
import { import { InferenceThreshold } from "@/types/graph";
CameraDetectThreshold,
CameraFfmpegThreshold,
InferenceThreshold,
} from "@/types/graph";
import { FrigateStats, PotentialProblem, ProblemSeverity } from "@/types/stats"; import { FrigateStats, PotentialProblem, ProblemSeverity } from "@/types/stats";
import { useMemo } from "react"; import { useMemo } from "react";
import useSWR from "swr"; import useSWR from "swr";
@@ -15,20 +11,12 @@ import { useIsAdmin } from "./use-is-admin";
import { useTranslation } from "react-i18next"; import { useTranslation } from "react-i18next";
// the status bar has always rendered these exact classes; keep them byte for
// byte so its output does not change
const SEVERITY_COLOR: Record<ProblemSeverity, string> = {
error: "text-danger",
warning: "text-orange-400",
info: "text-selected",
};
function problem( function problem(
severity: ProblemSeverity, severity: ProblemSeverity,
text: string, text: string,
relevantLink?: string, relevantLink?: string,
): PotentialProblem { ): PotentialProblem {
return { text, severity, color: SEVERITY_COLOR[severity], relevantLink }; return { text, severity, relevantLink };
} }
// matches SKIPPED_DETECTIONS_PCT in frigate/stats/emitter.py // matches SKIPPED_DETECTIONS_PCT in frigate/stats/emitter.py
@@ -122,20 +110,13 @@ export default function useStats(stats: FrigateStats | undefined) {
} }
}); });
// check camera cpu usages // check for skipped detections
Object.entries(memoizedStats["cameras"]).forEach(([name, cam]) => { Object.entries(memoizedStats["cameras"]).forEach(([name, cam]) => {
// Skip replay cameras // Skip replay cameras
if (isReplayCamera(name)) { if (isReplayCamera(name)) {
return; return;
} }
const ffmpegAvg = parseFloat(
memoizedStats["cpu_usages"][cam["ffmpeg_pid"]]?.cpu_average,
);
const detectAvg = parseFloat(
memoizedStats["cpu_usages"][cam["pid"]]?.cpu_average,
);
const cameraName = config?.cameras?.[name]?.friendly_name ?? name; const cameraName = config?.cameras?.[name]?.friendly_name ?? name;
if ( if (
@@ -153,32 +134,6 @@ export default function useStats(stats: FrigateStats | undefined) {
), ),
); );
} }
if (!isNaN(ffmpegAvg) && ffmpegAvg >= CameraFfmpegThreshold.error) {
problems.push(
problem(
"error",
t("stats.ffmpegHighCpuUsage", {
camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
ffmpegAvg,
}),
"/system#cameras",
),
);
}
if (!isNaN(detectAvg) && detectAvg >= CameraDetectThreshold.error) {
problems.push(
problem(
"error",
t("stats.detectHighCpuUsage", {
camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
detectAvg,
}),
"/system#cameras",
),
);
}
}); });
// Add message if debug replay is active // Add message if debug replay is active
+74
View File
@@ -0,0 +1,74 @@
import { useEmbeddingsReindexProgress } from "@/api/ws";
import {
StatusBarMessagesContext,
StatusMessage,
} from "@/context/statusbar-context";
import useStats, { useAutoFrigateStats } from "@/hooks/use-stats";
import { ProblemSeverity } from "@/types/stats";
import { useContext, useEffect, useMemo } from "react";
import { useTranslation } from "react-i18next";
const SEVERITY_ORDER: Record<ProblemSeverity, number> = {
error: 0,
warning: 1,
info: 2,
};
/**
* Publishes the stats problems and reindex progress to the status bar, then
* returns every status bar message, most severe first.
*/
export default function useStatusMessages(): StatusMessage[] {
const { t } = useTranslation(["views/system"]);
const { messages, addMessage, clearMessages } = useContext(
StatusBarMessagesContext,
)!;
const stats = useAutoFrigateStats();
const { potentialProblems } = useStats(stats);
useEffect(() => {
clearMessages("stats");
potentialProblems.forEach((problem) => {
addMessage(
"stats",
problem.text,
problem.severity,
undefined,
problem.relevantLink,
);
});
}, [potentialProblems, addMessage, clearMessages]);
const { payload: reindexState } = useEmbeddingsReindexProgress();
useEffect(() => {
if (reindexState) {
if (reindexState.status == "indexing") {
clearMessages("embeddings-reindex");
addMessage(
"embeddings-reindex",
t("stats.reindexingEmbeddings", {
processed: Math.floor(
(reindexState.processed_objects / reindexState.total_objects) *
100,
),
}),
);
}
if (reindexState.status === "completed") {
clearMessages("embeddings-reindex");
}
}
}, [reindexState, addMessage, clearMessages, t]);
return useMemo(
() =>
Object.values(messages)
.flat()
.sort(
(a, b) => SEVERITY_ORDER[a.severity] - SEVERITY_ORDER[b.severity],
),
[messages],
);
}
+10 -3
View File
@@ -27,16 +27,23 @@ export type HealthProblem = {
externalLink?: string; externalLink?: string;
/** render with a spinner instead of the severity icon (stream check running) */ /** render with a spinner instead of the severity icon (stream check running) */
pending?: boolean; pending?: boolean;
onDismiss?: () => void; /** why a hidden row is hidden */
hidden?: "acknowledged" | "muted";
/** hide until the next occurrence; only for kinds that repeat */
onAcknowledge?: () => void;
/** hide for good */
onMute?: () => void;
/** show a hidden row again */
onUnhide?: () => void;
}; };
/** What the Health tab's filter shows. */ /** What the Health tab's filter shows. */
export type NoticeFilter = { export type NoticeFilter = {
showDismissed: boolean; showHidden: boolean;
severities: HealthSeverity[]; severities: HealthSeverity[];
}; };
export const DEFAULT_NOTICE_FILTER: NoticeFilter = { export const DEFAULT_NOTICE_FILTER: NoticeFilter = {
showDismissed: false, showHidden: false,
severities: ["error", "warning", "info"], severities: ["error", "warning", "info"],
}; };
+9 -4
View File
@@ -13,11 +13,16 @@ export type Notice = {
first_seen: number; first_seen: number;
last_seen: number; last_seen: number;
count: number; count: number;
dismissed_at: number | null; /** whether the kind repeats, so acknowledging it can hide it until next time */
acknowledgeable: boolean;
/** hidden until the next occurrence */
acknowledged_at: number | null;
/** hidden for good */
muted_at: number | null;
}; };
/** a config or stream check row an admin dismissed */ /** a config or stream check row an admin muted */
export type DismissedCheck = { export type MutedCheck = {
id: string; id: string;
dismissed_at: number; muted_at: number;
}; };
-1
View File
@@ -129,7 +129,6 @@ export type ProblemSeverity = "error" | "warning" | "info";
export type PotentialProblem = { export type PotentialProblem = {
text: string; text: string;
severity: ProblemSeverity; severity: ProblemSeverity;
color: string;
relevantLink?: string; relevantLink?: string;
}; };
+10 -1
View File
@@ -256,7 +256,13 @@ export function detectionRows({
// ------------------------------------------------------------------ hwaccel // ------------------------------------------------------------------ hwaccel
export type HwaccelFamilyKey = export type HwaccelFamilyKey =
"nvidia" | "vaapi" | "intel-qsv" | "rkmpp" | "jetson" | "rpi"; | "nvidia"
| "vaapi"
| "intel-qsv"
| "rkmpp"
| "jetson"
| "rpi"
| "apple-silicon";
export type HwaccelClass = export type HwaccelClass =
| { kind: "none" } | { kind: "none" }
@@ -270,6 +276,7 @@ const PRESET_FAMILIES: [string, HwaccelFamilyKey][] = [
["preset-rk", "rkmpp"], ["preset-rk", "rkmpp"],
["preset-jetson", "jetson"], ["preset-jetson", "jetson"],
["preset-rpi", "rpi"], ["preset-rpi", "rpi"],
["preset-apple-silicon", "apple-silicon"],
]; ];
export function hwaccelFamily(value: string | string[]): HwaccelClass { export function hwaccelFamily(value: string | string[]): HwaccelClass {
@@ -294,6 +301,8 @@ const FAMILY_VENDORS: Record<HwaccelFamilyKey, GpuVendor[]> = {
vaapi: ["intel", "amd"], vaapi: ["intel", "amd"],
rkmpp: ["rockchip"], rkmpp: ["rockchip"],
rpi: ["rpi"], rpi: ["rpi"],
// lighter reports no decoder usage
"apple-silicon": [],
}; };
function decoderUsage( function decoderUsage(
+1 -2
View File
@@ -17,7 +17,6 @@ import {
useUserPersistence, useUserPersistence,
deleteUserNamespacedKey, deleteUserNamespacedKey,
} from "@/hooks/use-user-persistence"; } from "@/hooks/use-user-persistence";
import { isSafari } from "react-device-detect";
import { import {
Select, Select,
SelectContent, SelectContent,
@@ -132,7 +131,7 @@ export default function UiSettingsView() {
const { auth } = useContext(AuthContext); const { auth } = useContext(AuthContext);
const username = auth?.user?.username; const username = auth?.user?.username;
const PLAYBACK_RATE_DEFAULT = isSafari ? [0.5, 1, 2] : [0.5, 1, 2, 4, 8, 16]; const PLAYBACK_RATE_DEFAULT = [0.5, 1, 2, 4, 8, 16];
const clearStoredLayouts = useCallback(() => { const clearStoredLayouts = useCallback(() => {
if (!config) { if (!config) {