Disk and memory distribution, and bytes per record. Memory is reported as separate anonymous and file-backed figures and is never totalled. Admin only.
Output
application/jsonbytesPerRecord
ref#pair
Optional
No description available.
diskBytes
ref#pair
Optional
No description available.
have
integer
Optional
No description available.
instances
integer
Optional
No description available.
memoryAnon
ref#pair
Optional
Anonymous memory. Never summed with memoryFile.
memoryFile
ref#pair
Optional
File-backed memory, dominated by page cache. Its own figure: adding it to memoryAnon is how a healthy instance is diagnosed as leaking.
need
integer
Optional
No description available.
sources
ref#sources
Optional
No description available.
status
string
Required
Why a figure is absent. Branch on this, never on field presence.
ok, accruing, withheldunit
string
Optional
No description available.
days, snapshotswindowDays
integer
Optional
No description available.
Errors
AuthRequired
This endpoint requires an authenticated caller. Forbidden
The caller is not a HappyProto admin. Upstream
The telemetry store could not be queried. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Disk and memory distribution, and bytes per record. Memory is reported as separate anonymous and file-backed figures and is never totalled. Admin only.",
"errors": [
{
"description": "This endpoint requires an authenticated caller.",
"name": "AuthRequired"
},
{
"description": "The caller is not a HappyProto admin.",
"name": "Forbidden"
},
{
"description": "The telemetry store could not be queried.",
"name": "Upstream"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"bytesPerRecord": {
"ref": "#pair",
"type": "ref"
},
"diskBytes": {
"ref": "#pair",
"type": "ref"
},
"have": {
"type": "integer"
},
"instances": {
"type": "integer"
},
"memoryAnon": {
"description": "Anonymous memory. Never summed with memoryFile.",
"ref": "#pair",
"type": "ref"
},
"memoryFile": {
"description": "File-backed memory, dominated by page cache. Its own figure: adding it to memoryAnon is how a healthy instance is diagnosed as leaking.",
"ref": "#pair",
"type": "ref"
},
"need": {
"type": "integer"
},
"sources": {
"ref": "#sources",
"type": "ref"
},
"status": {
"description": "Why a figure is absent. Branch on this, never on field presence.",
"knownValues": [
"ok",
"accruing",
"withheld"
],
"type": "string"
},
"unit": {
"knownValues": [
"days",
"snapshots"
],
"type": "string"
},
"windowDays": {
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
},
"type": "query"
}