Metrics

curl --request GET \
  --url https://api.private-ai.com/community/metrics \
  --header 'x-api-key: <api-key>'

"# HELP cpu_usage_percent Multiprocess metric\n# TYPE cpu_usage_percent gauge\ncpu_usage_percent 53.9\n# HELP cpu_memory_used_bytes Multiprocess metric\n# TYPE cpu_memory_used_bytes gauge\ncpu_memory_used_bytes 2.260492288e+010\n# HELP cpu_memory_total_bytes Multiprocess metric\n# TYPE cpu_memory_total_bytes gauge\ncpu_memory_total_bytes 6.7373068288e+010\n# HELP cpu_load_percent Multiprocess metric\n# TYPE cpu_load_percent gauge\ncpu_load_percent{duration=\"1m\"} 1.1666666666666667cpu_load_percent{duration=\"5m\"} 0.8333333333333334cpu_load_percent{duration=\"15m\"} 0.9583333333333335# HELP http_request_size_bytes Multiprocess metric\n# TYPE http_request_size_bytes summary\nhttp_request_size_bytes_count{handler=\"/v3/process/text\",method=\"GET\",status=\"2xx\"} 3.0\n# HELP http_requests_total Multiprocess metric\n# TYPE http_requests_total counter\nhttp_requests_total{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 3.0\n# HELP http_request_duration_seconds Multiprocess metric\n# TYPE http_request_duration_seconds histogram\nhttp_request_duration_seconds_sum{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 0.8316442219074816\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.1\",method=\"POST\",status=\"2xx\"} 0.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.25\",method=\"POST\",status=\"2xx\"} 2.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.5\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"1.0\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_count{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 3.0"

API Reference

Metrics

This endpoint serves Prometheus metrics via a HTTP-based interface that provides access to metrics data in a format suitable for scraping by Prometheus servers. The endpoint provides real-time insights into how the system is functioning. The endpoint exposed the metrics in a time-series format, allowing you to track various types of data, including system resources usage, application performance, and other custom metrics.

Currently following metrics are available:

cpu_usage_percent (CPU usage in percentage.)
cpu_memory_used_bytes (Used CPU memory, in bytes.)
cpu_memory_total_bytes (Total CPU memory, in bytes.)
cpu_load_percent (CPU load, in percentage. Calculated for last 1m, 5m & 15m.)
http_request_size_bytes (HTTP request sizes in bytes grouped by method, status and handler.)
http_requests_total (Total number of requests grouped by method, status and handler.)
http_request_duration_seconds (The HTTP request latencies in seconds.)

GET

metrics

Metrics

curl --request GET \
  --url https://api.private-ai.com/community/metrics \
  --header 'x-api-key: <api-key>'

"# HELP cpu_usage_percent Multiprocess metric\n# TYPE cpu_usage_percent gauge\ncpu_usage_percent 53.9\n# HELP cpu_memory_used_bytes Multiprocess metric\n# TYPE cpu_memory_used_bytes gauge\ncpu_memory_used_bytes 2.260492288e+010\n# HELP cpu_memory_total_bytes Multiprocess metric\n# TYPE cpu_memory_total_bytes gauge\ncpu_memory_total_bytes 6.7373068288e+010\n# HELP cpu_load_percent Multiprocess metric\n# TYPE cpu_load_percent gauge\ncpu_load_percent{duration=\"1m\"} 1.1666666666666667cpu_load_percent{duration=\"5m\"} 0.8333333333333334cpu_load_percent{duration=\"15m\"} 0.9583333333333335# HELP http_request_size_bytes Multiprocess metric\n# TYPE http_request_size_bytes summary\nhttp_request_size_bytes_count{handler=\"/v3/process/text\",method=\"GET\",status=\"2xx\"} 3.0\n# HELP http_requests_total Multiprocess metric\n# TYPE http_requests_total counter\nhttp_requests_total{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 3.0\n# HELP http_request_duration_seconds Multiprocess metric\n# TYPE http_request_duration_seconds histogram\nhttp_request_duration_seconds_sum{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 0.8316442219074816\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.1\",method=\"POST\",status=\"2xx\"} 0.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.25\",method=\"POST\",status=\"2xx\"} 2.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"0.5\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_bucket{handler=\"/v3/process/text\",le=\"1.0\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_count{handler=\"/v3/process/text\",method=\"POST\",status=\"2xx\"} 3.0"

Authorizations

x-api-key

string

header

required

Response

200 - text/plain

Successful Response

The response is of type string.

Get Version

3.9.0

Authorizations

Response