mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-11-11 08:03:01 +03:00
Implement opt-in analytics (#24440)
* Add analytics opt-in setting, prompt notice kind, and notice watermarks * Add the analytics report schema * Add the analytics state file * Add the install and hardware analytics collectors * Add the detection analytics collector * Add the cameras analytics collector * Add the features analytics collector * Add the health analytics collector * Build analytics reports from the section collectors * Add the analytics report transport * Send the daily analytics report from the main process * Add the analytics preview API * Generate the analytics schema and check it in CI * Record the image variant in each Dockerfile * Show the analytics preview in telemetry settings * Document anonymous analytics * change wording * fixes * update network requirements docs * adapt analytics to free-form model scenes, split notice counts, and peewee 4 * fixes * change log levels * docstrings * docstrings * honor file-only analytics opt-outs and skip pre-consent notices An opt-out saved through the YAML editor's "Save only" or a hand edit never reached the live config, so reports kept going out under the old install ID until a restart. The reporter now reads telemetry.analytics from the config file when a report is due, validated with TelemetryConfig so yes, on, and 1 still count as consent, and an opt-out there deletes the state file and skips the send. The first report under a new install ID also carried every notice since the counters started, including ones from before the opt-in, so a fresh state file now resets the notice watermarks before the report's snapshot. * take the notice baseline at opt-in instead of the first send The watermark reset ran at the first send attempt, so notices raised between the opt-in and that send, up to 45 minutes after a startup, were absorbed into the reset and never reported. The reporter now writes the new install ID and resets the watermarks as soon as it sees consent without a state file. * report notice counts cumulatively from a database baseline Moving watermarks after each accepted send kept the install ID and the notice baseline out of step: pre-consent notices went out, notices raised before the first send were dropped, and a send that finished after an off/on toggle overwrote the new identity's baseline. health.notices now carries cumulative counts since the install ID was created. Creating an ID copies the lifetime counts into the existing reported_* columns before the state file names it, and nothing is written after a send, so the backend diffs consecutive reports per install ID. * write held notice repeats before the analytics baseline reset Repeats of batched kinds like failed_login wait in memory until the stats emitter flushes them, so a baseline reset taken while some were held left them out, and the next flush counted those pre-opt-in repeats as post-consent. The reset now writes held repeats to the notice history under the same lock before copying the counts. * seed detector inference speed from the first inference The average started at 0 so idle detectors read 0, but that made every detector's speed climb from 0 for its first couple dozen inferences after a start. Detectors now use the same InferenceSpeed helper as enrichments, so the first inference seeds the average and idle detectors still read 0.
This commit is contained in:
@@ -0,0 +1,61 @@
|
||||
"""Generate the analytics report JSON Schema from the Pydantic models.
|
||||
|
||||
The committed docs/static/frigate-analytics-schema.json documents every field
|
||||
for the ingest Worker's aggregation job and the docs page. It is exact for this
|
||||
version only, so the Worker validates just the envelope against it. Never edit
|
||||
it by hand, and never run a formatter over it.
|
||||
|
||||
Usage (from the repository root):
|
||||
|
||||
python3 generate_analytics_schema.py # write the schema
|
||||
python3 generate_analytics_schema.py --check # CI guard: fail if stale
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from frigate.analytics.schema import SCHEMA_VERSION, AnalyticsReport
|
||||
|
||||
OUTPUT = Path(__file__).parent / "docs" / "static" / "frigate-analytics-schema.json"
|
||||
|
||||
|
||||
def render() -> str:
|
||||
"""The JSON Schema for the current report models."""
|
||||
schema = AnalyticsReport.model_json_schema()
|
||||
schema["$schema"] = "https://json-schema.org/draft/2020-12/schema"
|
||||
schema["$id"] = "https://docs.frigate.video/frigate-analytics-schema.json"
|
||||
schema["x-schema-version"] = SCHEMA_VERSION
|
||||
return json.dumps(schema, indent=2, sort_keys=True) + "\n"
|
||||
|
||||
|
||||
def main() -> int:
|
||||
"""Write or check the schema file; returns the process exit code."""
|
||||
parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
|
||||
parser.add_argument(
|
||||
"--check", action="store_true", help="fail if the committed schema is stale"
|
||||
)
|
||||
args = parser.parse_args()
|
||||
rendered = render()
|
||||
|
||||
if args.check:
|
||||
current = OUTPUT.read_text() if OUTPUT.exists() else ""
|
||||
|
||||
if current != rendered:
|
||||
print(
|
||||
f"{OUTPUT} is out of date, run python3 generate_analytics_schema.py",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 1
|
||||
|
||||
print(f"{OUTPUT} is up to date")
|
||||
return 0
|
||||
|
||||
OUTPUT.write_text(rendered)
|
||||
print(f"Wrote {OUTPUT}")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Reference in New Issue
Block a user