Skip to main content

Metrics

Deployment metrics#

Dashboard's Deployment Metrics#

To get your deployment metrics, you'll first need to have a running deployment. At least 30 seconds must have passed before the metrics are available. You can access your metrics on the Arbitrium Dashboard in your deployment detail page:

img

UTC Datetime : The date that you enter in Arbitrium's dashboard or in Arbitrium's API must be in UTC timestamps.

You can specify some options with the metrics:

  1. Start At: When should the request start. This value must be higher or equal than the deployment time in UTC.
  2. End At: When should the request end. This value must be lower than right now in UTC.
  3. Interval: How much time between each points. Default to 1 minute.

Right now, Edgegap stores your deployment data for a maximum of 15 days. If you want to retrieve your metrics for internal analysis, you can make an API call to collect them.

Deployment Metrics with API#

To get metrics of your deployment with the API, you should already have your API token, if not you can generate one with this tutorial

Simple request#

curl --location --request GET 'https://api.edgegap.com/v1/metrics/REQUEST_ID' \
--header 'authorization: bearer YOUR_API_TOKEN'
Params#
  • start_time: When should the request start. This value must be higher or equal than the deployment time in UTC. Format: 2021-07-19 17:29:21 If not specified, it will default to the deployment start time in UTC.

  • end_time: When should the request end. This value must be lower than right now in UTC. Format: 2021-07-19 18:29:21 If not specified, it will default to now in UTC.

  • steps: How much time between each points. Default to 1m for a minute. Steps are specified as a number, followed by a unit. By increasing steps, data will be less precise but might be more appropriate for graphs. Example: 15h 1h30m 5m 10s

    • s: seconds
    • m: minutes
    • h: hours
    • d: days

Response example#

{
"total": {
"receive_total": {
"labels": [
"18:29:21"
],
"datasets": [
"2108992823"
],
"timestamps": [
"2021-07-19 18:29:21.894"
]
},
"transmit_total": {
"labels": [
"18:29:21"
],
"datasets": [
"2250453348"
],
"timestamps": [
"2021-07-19 18:29:21.979"
]
},
"disk_write_total": {
"labels": [],
"datasets": [],
"timestamps": []
},
"disk_read_total": {
"labels": [],
"datasets": [],
"timestamps": []
}
},
"cpu": {
"labels": [
"15:44:13",
...,
"18:29:13"
],
"datasets": [
1.7355475606609168,
...,
0.022917157634362317
],
"timestamps": [
"2021-07-19 15:44:13.155",
...,
"2021-07-19 18:29:13.155"
]
},
"mem": {
...
},
"network": {
"receive": {
...
},
"transmit": {
...
}
}
}