Monitoring

The license limits and usage of the deployment, and aggregated statistics about document processing and agent execution. Both operations require an admin API key.

📄️Get the license and its usage

Returns the details of the installed license and, for each object type that the license covers, the limit and the number of objects in use. Configuration objects, such as pipelines, agents and API keys, are counted exactly. Documents and fragments are estimated from the PostgreSQL table statistics, which can lag behind recent loads, and are marked with `estimated`. `valid` and `status` report the license as Foundation4 enforces the license, from counts that Foundation4 refreshes periodically, so `valid` can differ from a comparison of `used` with `limit` for a short time.

📄️Get monitoring statistics

Returns document processing and agent execution statistics for a time interval, aggregated from the Prometheus metrics of the API server and the workers, and the number of documents in the processing queue. A statistic whose Prometheus query fails is `null`, so that a failure is not read as no activity. A statistic for which Prometheus holds no data in the interval is 0. Each Prometheus query has a time limit of 10 seconds.