PrizmDoc® Viewer v13.28 Release - Updated
PrizmDoc OCR API / OCR API Reference / OCR Readers Metrics API
In This Topic
    OCR Readers Metrics API
    In This Topic

    Introduction

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

    Available URLs

    URL Description
    GET /prizmdoc/api/v1/metrics A request to get the Prometheus metrics of the server.

    GET /prizmdoc/api/v1/metrics

    Metrics are presented in a plain text format. The PrizmDoc OCR Metrics worker also exposes standard metrics associated with the .NET process.

    Success 200

    Field Description
    200 Server is healthy and exposes Prometheus metrics.

    Successful Response

    Response body

    Plain text body in Prometheus format.

    PrizmDoc OCR Metrics are described in the table below:

    Name Type Description
    worker_ocr_readers_fields_read_total Counter The total number of fields processed by the worker.
    worker_ocr_readers_reservation_update_errors_total Counter The total number of errors encountered while updating a reservation, labeled by reason (HTTP status code or Exception type).
    worker_ocr_readers_source_files_total Counter The total number of source files processed, labeled by file type.
    worker_ocr_readers_processes_total Counter The total number of completed processes, including errored processes.
    worker_ocr_readers_processes_errored_total Counter The total number of processes that failed due to input validation or other unrecoverable errors.
    worker_ocr_readers_workfile_http_requests_total Counter The total number of requests made to the PrizmDoc Viewer WorkFile API, labeled by request method and response status code.
    worker_ocr_readers_info Gauge The constant value exposing the process type and version supported by this worker.

    Examples

    Request

    GET /prizmdoc/api/v1/ocrReaders/metrics
    
    

    Successful Response

    Successful response omitting standard .NET process metrics:

    HTTP 200 OK
    Content-Type: text/plain
    # HELP worker_ocr_readers_reservation_update_errors_total The number of errors encountered while updating a reservation, by reason (HTTP status code or Exception type)
    # TYPE worker_ocr_readers_reservation_update_errors_total counter
    # HELP worker_ocr_readers_workfile_http_requests_total The number of requests made to the PrizmDoc Viewer WorkFile API, labeled by request method and response status code.
    # TYPE worker_ocr_readers_workfile_http_requests_total counter
    worker_ocr_readers_workfile_http_requests_total{method="POST",code="200"} 1
    worker_ocr_readers_workfile_http_requests_total{method="GET",code="200"} 1
    # HELP worker_ocr_readers_source_files_total The number of source files provided, by file type.
    # TYPE worker_ocr_readers_source_files_total counter
    worker_ocr_readers_source_files_total{file_type="png"} 1
    # HELP worker_ocr_readers_info The constant value “1”, exposing the process type and version supported by this worker.
    # TYPE worker_ocr_readers_info gauge
    worker_ocr_readers_info{type="ocr_readers",version="1.0",process="AtqqwuRS9uw9tigz"} 1
    # HELP worker_ocr_readers_processes_errored_total The number of processes that failed due to input validation or other unrecoverable errors.
    # TYPE worker_ocr_readers_processes_errored_total counter
    worker_ocr_readers_processes_errored_total 0
    # HELP worker_ocr_readers_processes_total The number of completed processes, including errored processes.
    # TYPE worker_ocr_readers_processes_total counter
    worker_ocr_readers_processes_total 1
    # HELP worker_ocr_readers_fields_read_total The number of fields processed.
    # TYPE worker_ocr_readers_fields_read_total counter
    worker_ocr_readers_fields_read_total 1
    
    ...