post https://api.tetrascience.com/v1/uda/systemmetric
TetraScience Agent can periodically upload system metrics of itself and the host environment the Agent is running. It requires a Cloud Data Connector (formerly known as a user-defined integration) and user-defined agent set up in the TetraScience Web UI. Uploaded system metric file should be new line delimited JSON file. See below for more details.
Below is an example of one row in system metric new line delimited JSON file:
{ "agentId": "94eb7d7c-e679-4a84-8e00-857bf86565e5", "agentVersion": "v1.0.1", "measuredAt": "2020-08-21T14:54:56Z", "detail": { "diskUsedPercent": [{ "diskName": "C", "value": 70 }, { "diskName": "D", "value": 76 }], "diskAvailable": [{ "diskName": "C", "value": 3.23 }, { "diskName": "D", "value": 0.5 }], "cpuUsedPercent": 33.9, "memoryUsedPercent": 55.8, "memoryAvailable": 305, "uploadErrorRate": 0.1, "scanAccessRate": 99.9 } }
NOTE:
- Unit for available disk space is given in GB
- Unit for available memory is given in MB
- All other units are percent values
JSON schema that describes one row of a system metric file is given below:
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "The root schema",
"description": "The root schema comprises the entire JSON document.",
"required": [
"agentId",
"agentVersion",
"measuredAt",
"detail"
],
"properties": {
"agentId": {
"type": "string",
"title": "The agentId schema",
"description": "ID of the agent",
"examples": [
"94eb7d7c-e679-4a84-8e00-857bf86565e5"
]
},
"agentVersion": {
"type": "string",
"title": "The agentVersion schema",
"description": "Agent version.",
"examples": [
"v1.0.1"
]
},
"measuredAt": {
"type": "string",
"title": "The measuredAt schema",
"description": "Time when metric is obtained in ISO format.",
"examples": [
"2020-08-21T14:54:56Z"
]
},
"detail": {
"type": "object",
"title": "The detail schema",
"description": "Details of the metric.",
"examples": [
{
"diskUsedPercent": [
{
"diskName": "C",
"value": 70
},
{
"diskName": "D",
"value": 76
}
],
"diskAvailable": [
{
"diskName": "C",
"value": 3.23
},
{
"diskName": "D",
"value": 0.5
}
],
"cpuUsedPercent": 33.9,
"memoryUsedPercent": 55.8,
"memoryAvailable": 305
}
],
"required": [
"diskUsedPercent",
"diskAvailable",
"cpuUsedPercent",
"memoryUsedPercent",
"memoryAvailable"
],
"properties": {
"diskUsedPercent": {
"type": "array",
"title": "The diskUsedPercent schema",
"description": "Array of disk usage given in percents.",
"examples": [
[
{
"diskName": "C",
"value": 70
},
{
"diskName": "D",
"value": 76
}
]
],
"items": {
"anyOf": [
{
"type": "object",
"title": "The first anyOf schema",
"description": "Single disk usage in percent.",
"examples": [
{
"diskName": "C",
"value": 70
}
],
"required": [
"diskName",
"value"
],
"properties": {
"diskName": {
"type": "string",
"title": "The diskName schema",
"description": "Disk label.",
"examples": [
"C"
]
},
"value": {
"type": "integer",
"title": "The value schema",
"description": "Usage in percent.",
"examples": [
70
]
}
}
}
]
}
},
"diskAvailable": {
"type": "array",
"title": "The diskAvailable schema",
"description": "Array of disk available spaces in GB.",
"examples": [
[
{
"diskName": "C",
"value": 3.23
},
{
"diskName": "D",
"value": 0.5
}
]
],
"items": {
"anyOf": [
{
"type": "object",
"title": "The first anyOf schema",
"description": "Available disk space in GB.",
"examples": [
{
"diskName": "C",
"value": 3.23
}
],
"required": [
"diskName",
"value"
],
"properties": {
"diskName": {
"type": "string",
"title": "The diskName schema",
"description": "Disk label.",
"examples": [
"C"
]
},
"value": {
"type": "number",
"title": "The value schema",
"description": "Available disk space in GB.",
"examples": [
3.23
]
}
}
}
]
}
},
"cpuUsedPercent": {
"type": "number",
"title": "The cpuUsedPercent schema",
"description": "CPU usage in percent.",
"examples": [
33.9
]
},
"memoryUsedPercent": {
"type": "number",
"title": "The memoryUsedPercent schema",
"description": "Memory usage in percent.",
"examples": [
55.8
]
},
"memoryAvailable": {
"type": "integer",
"title": "The memoryAvailable schema",
"description": "Available memory in MB.",
"default": 0,
"examples": [
305
]
},
"uploadErrorRate": {
"type": "number",
"title": "The uploadErrorRate schema",
"description": "Upload error rate since agent start.",
"default": 0,
"examples": [
0.1
]
},
"scanAccessRate": {
"type": "number",
"title": "The scanAccessRate schema",
"description": "Scan access rate for agent",
"default": 0,
"examples": [
99.9
]
}
}
}
}
}