Metrics
curl --request GET \
--url https://api.private-ai.com/community/metrics \
--header 'x-api-key: <api-key>'import requests
url = "https://api.private-ai.com/community/metrics"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.private-ai.com/community/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.private-ai.com/community/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.private-ai.com/community/metrics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.private-ai.com/community/metrics")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.private-ai.com/community/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body"# 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=\"/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=\"/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=\"/process/text\",method=\"POST\",status=\"2xx\"} 0.8316442219074816\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.1\",method=\"POST\",status=\"2xx\"} 0.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.25\",method=\"POST\",status=\"2xx\"} 2.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.5\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"1.0\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_count{handler=\"/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>'import requests
url = "https://api.private-ai.com/community/metrics"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.private-ai.com/community/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.private-ai.com/community/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.private-ai.com/community/metrics"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.private-ai.com/community/metrics")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.private-ai.com/community/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body"# 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=\"/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=\"/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=\"/process/text\",method=\"POST\",status=\"2xx\"} 0.8316442219074816\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.1\",method=\"POST\",status=\"2xx\"} 0.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.25\",method=\"POST\",status=\"2xx\"} 2.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"0.5\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_bucket{handler=\"/process/text\",le=\"1.0\",method=\"POST\",status=\"2xx\"} 3.0\nhttp_request_duration_seconds_count{handler=\"/process/text\",method=\"POST\",status=\"2xx\"} 3.0"Authorizations
Response
200 - text/plain
Successful Response
The response is of type string.
⌘I