Skip to content

Metrics

UbiOps generates metrics based on activity in the platform.

The recommended way to access the metrics is through the WebApp (available at https://app.ubiops.com for our SaaS solution). It is also possible to access the metrics via Client libraries:

    import ubiops
    api_client = ubiops.ApiClient(configuration)
    api = ubiops.CoreApi(api_client)

    api.metrics_get(
        project_name={your_project_name},
        metric={desired_metric},
        start_date='2023-7-19 12:00:00',
        end_date='2023-7-19 12:03:00',
        object_type='deployment_version'
        )
Have a look at our Swagger page to see all available metrics.

In the WebApp metrics can be found under Monitoring in the left navigation panel. This will show an overview of project level metrics. It is possible to filter metrics on date, or on properties like deployment_name.

Metrics can be found under Monitoring in the left navigation panel. This will show an overview of project level metrics. It is possible to filter metrics on date, or on properties like deployment_name.

Metrics

Many objects in UbiOps (like deployments and pipelines) have a Metrics button which will show the metrics relevant to the object.

The following metrics are available.

Deployment metrics

Metric1 Unit Description
active_time seconds (float) Time in seconds that the deployment is active
credits - Usage of Credits 2
instances instances (float) Average number of active deployment instances
input_volume bytes (int) Volume of incoming data in bytes
output_volume bytes (int) Volume of outgoing data in bytes
compute3 seconds (float) Average time in seconds for a request to complete
memory_peak bytes (int) Peak memory used during a request
requests requests (int) Number of requests made to the object
failed_requests requests (int) Number of failed requests made to the object
outputs items (int) Number of outgoing data items
express_queue_size items(int) Average number of queued express requests
batch_queue_size items(int) Average number of queued batch requests
express_queue_time4 items(int) Average time in seconds for an express request to start processing
batch_queue_time4 items(int) Average time in seconds for a batch request to start processing

Pipeline metrics

Metric1 Unit Description
requests requests (int) Number of requests made to the object
failed_requests requests (int) Number of failed requests made to the object
request_duration3 seconds (float) Average time in seconds for a pipeline request to complete
input_volume bytes (int) Volume of incoming data in bytes
output_volume bytes (int) Volume of outgoing data in bytes
object_requests requests (int) Number of requests made to deployments in a pipeline
object_failed_requests requests (int) Number of failed requests made to deployments in a pipeline

Token and user specific metrics

It is possible to see metrics which are generated by a specific user or a service user (API token). Navigate to the Users & API tokens tab in the Monitoring page in the WebApp.

  1. Deployment and pipeline metrics are sampled every 60s ↩↩

  2. credits is the amount of credits used by the active instance. The ratio will be different based on the instance type. ↩

  3. compute is the actual time spend on calling the 'request' function of a deployment. In contrast, request_duration is the actual time spent on executing a pipeline request and also depends on the shape of a pipeline (e.g. parallel or serial deployments) ↩↩

  4. If your deployment version is not showing the express_queue_time and batch_queue_time metrics it may be needed to re-upload your deployment package to start making use of this feature. ↩↩