Get Metrics
A basic query for retrieving metrics. For a more complex and granular report, see the /v1/monitoring/metrics/aggregate endpoint.
Requires the monitor-view capability.
query Parameters
object Filter FieldThe filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. To search via labels, use |
Returns an array of metrics.
General error response from the platform
- 200
- default
{- "data": [
- {
- "time": "2021-01-30T08:30:00Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "tags": [
- "string"
], - "points": [
- [
- "2021-01-30T08:30:00Z"
]
], - "metadata": {
- "metric": "string",
- "type": "gauge",
- "origin": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "component": {
- "id": "651586fca6078e98982dbd90",
- "type": "string"
}, - "cluster": "string"
}
}
]
}Generate Aggregated Metrics
Generate a metric report using an aggregated pipeline query with Mongo. This endpoint provides ultimate flexibility in generating data for dashboards, charts, graphs, etc.
You should always provide a time range filter to this call, either through the filter parameter or in the critera body. The aggregate is limited to 25,000 input documents, so a time frame will give the best results.
Requires the monitor-view capability.
query Parameters
object Filter FieldThe filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. |
Request Body schema: application/json
The mongo syntax aggregate pipeline for querying metrics and formulating a report.
object The criteria to add to the first match. Cycle will automatically provide the hub ID. | |
Array of objects The aggregation pipeline. Supports Mongo-style syntax and operators. |
Returns an object matching the shape of the output of the aggregated pipeline output.
General error response from the platform
- Payload
{- "criteria": { },
- "pipeline": [
- { }
]
}- 200
- default
{- "data": [
- { }
]
}Get Events
A basic query for retrieving events. For a more complex and granular report, see the /v1/monitoring/events/aggregate endpoint.
Requires the monitor-view capability.
query Parameters
object Filter FieldThe filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. To search via labels, use |
Returns an array of events.
General error response from the platform
- 200
- default
{- "data": [
- {
- "time": "2021-01-30T08:30:00Z",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "tags": [
- "string"
], - "text": "string",
- "metadata": {
- "event": "api.security_violation",
- "type": "info",
- "priority": "critical",
- "origin": "string",
- "hub_id": "651586fca6078e98982dbd90",
- "component": {
- "id": "651586fca6078e98982dbd90",
- "type": "string"
}, - "cluster": "string"
}
}
]
}Generate Aggregated Events
Generate an events report using an aggregated pipeline query with Mongo. This endpoint provides ultimate flexibility in generating data for dashboards, charts, graphs, etc.
You should always provide a time range filter to this call, either through the filter parameter or in the critera body. The aggregate is limited to 25,000 input documents, so a time frame will give the best results.
Requires the monitor-view capability.
query Parameters
object Filter FieldThe filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for. |
Request Body schema: application/json
The mongo syntax aggregate pipeline for querying events and formulating a report.
object The criteria to add to the first match. Cycle will automatically provide the hub ID. | |
Array of objects The aggregation pipeline. Supports Mongo-style syntax and operators. |
Returns an object matching the shape of the output of the aggregated pipeline output.
General error response from the platform
- Payload
{- "criteria": { },
- "pipeline": [
- { }
]
}- 200
- default
{- "data": [
- { }
]
}Aggregate Logs
A query for retrieving container instance logs.
Allows aggregate narrowing through filtering, searching, and scope parameters.
If 'local' is set to true, only cached logs will be queried, and logs in object storage will be ignored. This leads to much faster performance.
Requires the monitor-view capability.
Request Body schema: application/json
Parameters for aggregating logs.
Returns an array of log lines.
General error response from the platform
- Payload
{- "scope": {
- "type": "container",
- "ids": [
- "651586fca6078e98982dbd90"
], - "date_range": { },
- "context_window": 5
}, - "search": [
- {
- "type": "raw",
- "match": "string"
}
], - "local": true,
- "limit": 1000
}- 200
- default
{- "data": [
- {
- "time": "2021-01-30T08:30:00Z",
- "source": "stdout",
- "message": "string",
- "instance_id": "string",
- "context_window": "string"
}
]
}Get Monitoring Monitors
Returns location information about the monitors used for Cycle's external monitoring service. These monitors are used for determining the latency between the public internet and environment load balancers.
Returns and array of monitor location information.
General error response from the platform
- 200
- default
{- "data": [
- {
- "node_id": "string",
- "country_short": "string",
- "country": "string",
- "region": "string",
- "city": "string",
- "latitude": 0,
- "longitude": 0
}
]
}