Metrics

Cedana API for metrics

Get metrics (K8s)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns k8 metrics from duckdb

application/json

namestringRequired

500

Failed to connect/fetch from metrics table from database

application/json

get

/v2/metrics/k8

HTTPcURLJavaScriptPython

GET /v2/metrics/k8 HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "details": [
      {
        "collector": "text",
        "cpu_core": "text",
        "cpu_mode": "text",
        "filesystem": "text",
        "metric_name": "text",
        "mountpoint": "text",
        "resource": null,
        "timestamp": 1,
        "value": "text"
      }
    ],
    "name": "text"
  }
]

Get metrics (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns top 10 latest SLURM metrics from duckdb

application/json

counter_valuenumber · nullableOptional

gauge_valuenumber · nullableOptional

idinteger · int64Required

kindstring · nullableOptional

namestringRequired

tagsanyOptional

timestampintegerRequired

500

Failed to connect/fetch from SLURM metrics table in database

application/json

get

/v2/metrics/slurm

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "counter_value": null,
    "gauge_value": null,
    "id": 1,
    "kind": null,
    "name": "text",
    "tags": null,
    "timestamp": 1
  }
]

Get cluster overview (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns latest SLURM cluster overview statistics

application/json

cpu_loadnumber · nullableOptional

cpus_idlenumber · nullableOptional

cpus_totalnumber · nullableOptional

mem_allocnumber · nullableOptional

mem_freenumber · nullableOptional

mem_realnumber · nullableOptional

timestampintegerRequired

500

Failed to fetch SLURM cluster overview

application/json

get

/v2/metrics/slurm/overview

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/overview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cpu_load": null,
  "cpus_idle": null,
  "cpus_total": null,
  "mem_alloc": null,
  "mem_free": null,
  "mem_real": null,
  "timestamp": 1
}

Get state breakdown (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns state breakdown for CPUs and nodes

application/json

timestampintegerRequired

500

Failed to fetch SLURM state breakdown

application/json

get

/v2/metrics/slurm/overview/state

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/overview/state HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cpus_by_state": [
    {
      "state": "text",
      "value": 1
    }
  ],
  "nodes_by_state": [
    {
      "state": "text",
      "value": 1
    }
  ],
  "timestamp": 1
}

Get partition statistics (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns list of all partitions with their statistics

application/json

cpu_loadnumber · nullableOptional

free_memorynumber · nullableOptional

idle_cpusnumber · nullableOptional

idle_nodesnumber · nullableOptional

partition_namestringRequired

real_memorynumber · nullableOptional

timestampintegerRequired

total_cpusnumber · nullableOptional

500

Failed to fetch partition statistics

application/json

get

/v2/metrics/slurm/partitions

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/partitions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "cpu_load": null,
    "free_memory": null,
    "idle_cpus": null,
    "idle_nodes": null,
    "partition_name": "text",
    "real_memory": null,
    "timestamp": 1,
    "total_cpus": null
  }
]

Get partition time series (Slurm)

get

Returns CPU load and free memory time series for the specified partition over the last 10 data points

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Partition name to query timeseries for

Responses

200

Returns time series data for the specified partition

application/json

partition_namestringRequired

500

Failed to fetch partition time series

application/json

get

/v2/metrics/slurm/partitions/{name}/timeseries

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/partitions/{name}/timeseries HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "cpu_load": [
    {
      "timestamp": 1,
      "value": 1
    }
  ],
  "free_memory": [
    {
      "timestamp": 1,
      "value": 1
    }
  ],
  "partition_name": "text"
}

Get CPU load time series (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns CPU load time series (last 10 data points)

application/json

timestampintegerRequired

valuenumber · doubleRequired

500

Failed to fetch CPU load time series

application/json

get

/v2/metrics/slurm/timeseries/cpu-load

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/timeseries/cpu-load HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "timestamp": 1,
    "value": 1
  }
]

Get memory time series (Slurm)

get

Authorizations

Token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns memory time series (last 10 data points for free and allocated)

application/json

500

Failed to fetch memory time series

application/json

get

/v2/metrics/slurm/timeseries/memory

HTTPcURLJavaScriptPython

GET /v2/metrics/slurm/timeseries/memory HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "allocated_memory": [
    {
      "timestamp": 1,
      "value": 1
    }
  ],
  "free_memory": [
    {
      "timestamp": 1,
      "value": 1
    }
  ]
}