Get the operational metrics snapshot in Prometheus format

Returns the same snapshot as GET /api/v1/finger/metrics as Prometheus text exposition (version 0.0.4).

• HTTP level series (traffic, saturation, latency and the per-endpoint breakdown) use the facephi_ prefix, for example facephi_requests_total, facephi_window_error_rate{window} or facephi_total_latency_ms{window,stat}.

• The blocks owned by the service use the facephi_finger_ prefix:

Series	Type	Content
facephi_finger_service_info{name,version,role,path_base,schema_version}	gauge	service block, always 1
facephi_finger_configured_threads	gauge	service.configuredThreads
facephi_finger_snapshot_timestamp_seconds	gauge	timestamp as epoch seconds
facephi_finger_initialized, facephi_finger_license_valid	gauge	state.initialized and state.license.valid
facephi_finger_license_info{status_code}	gauge	state.license.statusCode, always 1
facephi_finger_state_classification{classification}	gauge	1 for the current state.classification, 0 for the other values
facephi_finger_engine_healthy, facephi_finger_engine_last_health_known, facephi_finger_engine_last_health_check_timestamp_seconds	gauge	state.engine block
facephi_finger_engine_service_configured{service}	gauge	One series per configured processing service, always 1
facephi_finger_usage_counters_enabled	gauge	usage.enabled
facephi_finger_usage_operations_total{operation}, facephi_finger_usage_total	counter	usage block; operation is extract or authenticate
facephi_finger_quality_samples{operation}, facephi_finger_quality_measured_samples{operation="extract"}	gauge	Samples of the quality block
facephi_finger_quality_score_samples, facephi_finger_quality_score_avg, facephi_finger_quality_score_min, facephi_finger_quality_score_max (labels operation, metric)	gauge	Quality summaries: metric is overallQuality or nfiq2 for extract, and similarity for authenticate
facephi_finger_authenticate_results_total{result}	counter	positive and negative authentications
facephi_finger_low_quality_samples, facephi_finger_low_quality_since_timestamp_seconds	gauge	quality.summary block
facephi_finger_alert_active{code,severity}, facephi_finger_alert_since_timestamp_seconds{code,severity}	gauge	alerts block: 1 for active alerts, 0 for the rest

The classification and alert series always publish every possible value, and the sample counts are published with 0 before the first operation, so no series appears or disappears between scrapes. The facephi_finger_quality_score_* series of a summary only appear once the JSON snapshot includes it. Instants are published as epoch seconds and are 0 while the snapshot has not recorded them. Free-form text (state.license.statusMessage, state.engine.lastError and alerts[].message) is only published in the JSON response. It never requires a JWT.

get

Respostas

200

Prometheus text exposition.

text/plain; version=0.0.4; charset=utf-8

stringOpcional

400

The service is not initialized (Service not initialized).

application/json

get/api/v1/finger/metrics/prometheus

GET /api/v1/finger/metrics/prometheus HTTP/1.1
Host: 127.0.0.1:6982/
Accept: */*

# TYPE facephi_requests_total counter
facephi_requests_total 42
# TYPE facephi_finger_service_info gauge
facephi_finger_service_info{name="facephi-finger-service",version="2.2.1",role="master",path_base="/api/v1/finger",schema_version="1.0"} 1
# TYPE facephi_finger_state_classification gauge
facephi_finger_state_classification{classification="ok"} 1
facephi_finger_state_classification{classification="idle"} 0
# TYPE facephi_finger_usage_operations_total counter
facephi_finger_usage_operations_total{operation="extract"} 12
facephi_finger_usage_operations_total{operation="authenticate"} 7