Documentation > Logs & Analytics

API - Live server metrics (stream_server_data)

Logs & Analytics

Streams the health of the server your Opensolr Index runs on: CPU, memory, disk and load, one reading every few seconds.

Endpointhttps://opensolr.com/solr_manager/api/stream_server_data
MethodGET
Authemail and api_key of your account, as GET or POST parameters: Authentication.
In the panelServer monitor

01 · Parameters

core_nameRequired

The name of an index on the server (index_name works too).

maxRequired

How many readings, then the stream ends. Without it the stream ends at once.

intervalOptional

Seconds between readings, a whole number.

02 · Example

curl -sN "https://opensolr.com/solr_manager/api/stream_server_data?email=YOUR_EMAIL&api_key=YOUR_API_KEY&core_name=my_index&interval=5&max=12"

03 · Answer

Plain text, one JSON object per reading, each on its own line, with blank padding between them: split on new lines and skip the blank ones.

{
    "cpu": "12.5",
    "mem": "41.2",
    "disk": "37",
    "load": "0.42, 0.51, 0.48",
    "time": "14:05:10",
    "hardware": {
        "total_ram_gb": 32,
        "total_disk_gb": 400,
        "cpu_cores": 8
    }
}
cpu, mem, disk

Percent used.

load

The load average of the last 1, 5 and 15 minutes.

hardware

In the first reading only: memory, disk and CPU cores of the server.

On a shared server these are the numbers of the whole server, not of your index alone.

04 · Errors

An index that is not yours answers {"status": false, "msg": "No such index"} and the stream ends.

ERROR_AUTHENTICATION_FAILEDHTTP 403

The email and API key do not match.

ERROR_RATE_LIMIT_PER_MINUTEHTTP 429

Too many calls. Wait for the Retry-After seconds: Rate limits.

05 · Related

The requests of the index, live: stream_solr_log.

Every error code and HTTP status of the API: API errors. Calls per minute and per hour: Rate limits.