Introduction

The PrizmDoc AI Metrics REST API is used to fetch the Prometheus metrics of the server.

Available URLs

GET /metrics

Metrics are presented in a plain text format. The PrizmDoc AI Hub also exposes standard metrics associated with the process.

Success 200

Successful Response

Response body

Plain text body in Prometheus format.

PrizmDoc AI Metrics are described in the table below:

Examples

Request

GET /metrics

Successful Response

Successful response omitting standard .NET process metrics:

HTTP 200 OK
Content-Type: text/plain
# HELP worker_ai_tasks_reservation_update_errors_total The number of errors encountered while updating a reservation, by reason (HTTP status code or Exception type)
# TYPE worker_ai_tasks_reservation_update_errors_total counter
# HELP worker_ai_tasks_workfile_http_requests_total The number of requests made to the PrizmDoc WorkFile API, labeled by request method and response status code.
# TYPE worker_ai_tasks_workfile_http_requests_total counter
worker_ai_tasks_workfile_http_requests_total{method="POST",code="200"} 1
worker_ai_tasks_workfile_http_requests_total{method="GET",code="200"} 1
# HELP worker_ai_tasks_source_files_total The number of source files provided, by file type.
# TYPE worker_ai_tasks_source_files_total counter
worker_ai_tasks_source_files_total{file_type="txt"} 1
# HELP worker_ai_tasks_info The constant value "1", exposing the process type and version supported by this worker.
# TYPE worker_ai_tasks_info gauge
worker_ai_tasks_info{type="ai_tasks",version="1.0",process="AtqqwuRS9uw9tigz"} 1
# HELP worker_ai_tasks_processes_errored_total The number of processes that failed due to input validation or other unrecoverable errors.
# TYPE worker_ai_tasks_processes_errored_total counter
worker_ai_tasks_processes_errored_total 0
# HELP worker_ai_tasks_processes_total The number of completed processes, including errored processes.
# TYPE worker_ai_tasks_processes_total counter
worker_ai_tasks_processes_total 1

...