For the complete documentation index, see llms.txt. This page is also available as Markdown.

Kubernetes

If you use our Helm charts, ServiceMonitor handles Prometheus configuration automatically.

General Information

Exporter Ports

Exporter
Port

API

api_pod:8000/metrics

statsd

api_pod:9102/metrics/app

TFSS

bio_pod:8501/metrics/tfss

Bio blackbox

bio_pod:9115

Healthcheck Paths

API

GET http://api:8000/api/version

GET http://api:8000/api/healthcheck

BIO

GET http://bio:8501/v1/models/{{model_name}}

POST http://bio:8501/v1/models/dummy:predict

method: POST
body: '{"inputs": {"images_bytes": [{"b64": "aaa"}]}}'

API

Metrics Overview

Metric
Description
Type
Labels

oz_api_versions_total (also available as oz_api_versions_created, oz_api_info_created, oz_api_info_total)

Displays API version info when you call /api/version

counter

lamb

core – core version

oz_api – API version

oz_api_analyses_total

Number of processed analyses

counter

analysis_result – analysis status (FINISHED, FAILED)

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

company_id – company identifier

resolution_status – analysis resolution (SUCCESS, DECLINED)

oz_api_analyses_created

Number of analyses that have been initiated

gauge

analysis_result – analysis status (FINISHED, FAILED)

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

company_id – company identifier

resolution_status – analysis resolution (SUCCESS, DECLINED)

oz_api_analyses_in_progress

Number of analyses currently processing

gauge

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

company_id – company identifier

oz_api_analyse_duration_seconds_bucket

A histogram for analysis duration. Default buckets: 0.1,0.5,1,1.5,2,2.5,3,3.5,4,4.5,5,6,7,8,10,12,15,20,30,inf

histogram

analysis_result – analysis status (FINISHED, FAILED)

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

resolution_status – analysis resolution (SUCCESS, DECLINED)

company_id – company identifier

le – bucket size

oz_api_analyse_duration_seconds_count

Sum of analyses' durations

counter

analysis_result – analysis status (FINISHED, FAILED)

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

resolution_status – analysis status (SUCCESS, DECLINED)

company_id – company identifier

oz_api_analyse_duration_seconds_sum

Number of analyses whose durations were counted

counter

analysis_result – analysis resolution (FINISHED, FAILED)

analysis_type – analysis type (QUALITY, BIOMETRY, DOCUMENTS)

resolution_status – analysis resolution (SUCCESS, DECLINED)

company_id – company identifier

oz_api_analyse_duration_seconds_created

Timestamp of beginning of duration metric counting

django_http_requests_total_by_transport_total

Number of requests by transport protocol

counter

transport – protocol (HTTP, HTTPS)

uid – user identifier

django_http_responses_before_middlewares_total

Number of Django responses before running middleware

counter

uid – user identifier

django_http_exceptions_total_by_type_total

Number of Django exceptions by type

counter

exception_type – type of exception

uid – user identifier

django_http_requests_latency_seconds_by_view_method_bucket

Histogram of request processing latency by views

histogram

method – HTTP method

uid – user identifier

view_name – view name

le – bucket size

django_http_requests_latency_seconds_by_view_method_count

Number of request processing durations by views

counter

method – HTTP method

uid – user identifier

view_name – view name

django_http_requests_latency_seconds_by_view_method_sum

Sum of request processing durations by views

counter

method – HTTP method

uid – user identifier

view_name – view name

Illustrative screenshots:

Analyses duration divided by average value / analysis type and quantile / analysis type. Discontinuity is caused by metric counter which starts for each analysis separately

Grafana Alerts


TFSS

Metrics Overview

Metric
Description

:tensorflow:serving:request_count

Total number of requests to TFSS

:tensorflow:serving:request_latency_bucket

Histogram of request processing time

:tensorflow:serving:request_latency_sum

Sum of request processing durations

:tensorflow:serving:request_latency_count

Total number of requests whose durations were counted

:tensorflow:cc:saved_model:load_attempt_count

Loaded models

Illustrative screenshots:

Total number of requests to TFSS per second and per minute, divided by models
0.95 (or the one you've defined in $quantile) quantile of request processing duration in TFSS
Average analysis processing time
The built-in blackbox sends requests to check states of models, should be 1; if not, probe_success in TFSS is not working properly

Grafana Alerts


nginx

Metrics Overview

Metric
Description

nginx_up

Shows whether nginx is running: 1 – service is up, 0 – service is down

nginx_connections_accepted

Number of connections accepted by nginx

nginx_connections_handled

Number of connections handled by nginx

nginx_connections_active

Active nginx connections

Illustrative screenshots:

Total number of requests to nginx
State of nginx connections. Check that there are no stale connections
Processing success rate. The numbers of accepted and handled connections should be equal

Grafana Alerts


API 6 no longer requires Celery or Redis, so the corresponding metrics are not covered in this guide.

You can customize the alerts according to your needs. Please proceed to our repository to find the alert files.

Last updated

Was this helpful?