Celery Metrics Service

This service provides information about the tasks in celery queues.

GET Celery Metrics Service

This method is used to retrieve the number of tasks for each queue type in celery configuration.

Path: /api/v1/oms/celery-metrics/metrics/

Example Request

To retrieve the task count information, a GET request should be sent to /api/v1/oms/celery-metrics/metrics/ endpoint. No query parameter or body required.

import requests

url = "https://{oms_base_url}/api/v1/oms/celery-metrics/metrics/"
api_token = "f532eXXXXXXXXXXXXXXXXX201XXXXX9332d"

headers = {
'Accept': 'application/json',
'Authorization': 'Token {}'.format(api_token)
}

response = requests.request("GET", url, headers=headers)

print(response.json())

Example Response (200 OK)

In a successful response with a status code of 200 OK, the API returns the metric data in the JSON format.

Parameter	Data Type	Description
low	integer	The number of tasks in the queue named 'low'
high	integer	The number of tasks in the queue named 'high'
celery	integer	The number of tasks in the queue named 'celery'

This example response serves as a reference to understand the structure and data format of metric data.

{
    "low": 0,
    "high": 0,
    "celery": 0
}