Skip to content

AnomalyGuard documentation

Welcome. This site explains how to install, configure, and use AnomalyGuard — software that finds unusual patterns in time-series data stored in your databases (sales, occupancy, volumes, and similar metrics).

You do not need to read every page. Use this homepage to pick the right entry point, then follow the links for your role.

Start here

New to AnomalyGuard? Begin with the guided path:

How to start — what the product does, what you need, and the first steps to a working Home screen with anomalies.

Then continue with Installation & Setup when you are ready to deploy.

How the pieces fit together

Warehouse data
    → Connector (DB login)
        → Data view (query + categories + detectors)
            → Load & detect (jobs)
                → Anomalies
                    → Filters (saved views for HQ / region / team)
                        → Home (UI)  or  API / CLI / AI agents
Concept Meaning Guide
Connector Encrypted connection to your source database Connectors
Data view What to load, how to split series, which detectors to run Data Views
Detector Algorithm that flags spikes, gaps, shifts, seasonality, and more Detectors
Filter Named view over anomalies for a role or team Filters
Home Day-to-day screen with pinned filters and tiles / summary Home

Find your path

I install and administer the product

  1. How to start
  2. Install AnomalyGuard
  3. Setup Service Principal & Users (Entra ID sign-in)
  4. License (plan limits)
  5. ConnectorsData ViewsUsers
  6. Monitoring · API Keys

I configure analytics (data views & detectors)

I use results every day (analyst / business)

  • Home — pinned filters, tiles, summary, display options
  • Filters — how views are built (admins create; you consume & can pin shared ones)
  • Comments — notes that explain known events

I automate or integrate (CI, scripts, AI agents)

Full documentation map

Getting started

Page What you will find
How to start Plain-language onboarding and first-success checklist
Index (this page) Map of the whole site

Admin guide

Page What you will find
Install AnomalyGuard Deploy, bootstrap, health
Setup Service Principal & Users Entra ID app, roles, first admin
License Marketplace plans and data-view limits

User guide — set up analytics

Page What you will find
Connectors Create and test database connections
Data Views Full lifecycle: source, categories, analysis, deploy, jobs, YAML
Data Preview Validate series and detectors on sample data
Detectors Catalog of detector types (gap, WOW, spike, changepoint, …)
Users Assign which data views each person can see
API Keys Non-interactive access for pipelines and agents
Monitoring Track load / process jobs

User guide — use results

Page What you will find
Home Operational dashboard for pinned filters
Filters Build views, aggregation, SIN/SIM, AI summary, share / pin
Comments Operational notes on anomalies and periods

User guide — interfaces

Page What you will find
How to use the API REST /api/v1/…, auth, capability map
How to use the CLI Download, config, auth, command groups

Tutorials

Page What you will find
CI/CD with AnomalyGuard CLI Git YAML → Fact JSON → deploy → jobs
AI Agents & AnomalyGuard Agent + CLI morning-brief sample

Release notes

Page What you will find
Release 2.1 Current release highlights
Release 1.1 Earlier changes
Release 1.0 Initial release

Core capabilities (quick reference)

Capability In one sentence
Connectors Encrypted links to SQL Server, PostgreSQL, and other supported engines
Data views Versionable monitoring definitions (UI + YAML) with deploy lifecycle
Detectors Statistical and ML-style checks on loaded series
Filters & Home Role-specific views of the anomaly “cloud,” including optional LLM briefs
Comments Human context that also feeds summaries
API & CLI Same operations for automation, BI tools, and AI agents
Entra ID + API keys People sign in with Azure AD; machines use keys or tokens

Tip if you feel lost

Question Go to
Where do I begin? How to start
App will not start / install? Install AnomalyGuard
Nobody can sign in? Setup Service Principal & Users
No data / empty Home? Users (data-view access) · Filters (pin) · Monitoring (jobs)
How do I change detectors? Data Views · Detectors · Data Preview
How do I automate deploy? CI/CD tutorial
How does an AI agent call us? AI Agents tutorial