MetricClient¶

Helper class for inserting (custom) metrics

log_metric¶

log_metric(self, metric_name, labels, value)

Log a metric to the UbiOps API

Description¶

Method to insert metrics.

Example¶

• Use system environment variables

  from ubiops.utils.metrics import MetricClient
  
  # Set environment variables (these are set automatically for you when running inside UbiOps)
  # - INT_API_TOKEN: "Token <YOUR_API_TOKEN>"
  # - INT_API_URL: "https://api.ubiops.com/v2.1"
  
  project_name = 'project_name_example' # str
  
  metric_client = MetricClient(project_name=project_name)
  metric_client.start()
  
  metric_client.log_metric(metric_name="custom.metric", labels={"test": "test"}, value=1.0)
  
  metric_client.stop()
  

• Use authorization parameters

  import ubiops
  from ubiops.utils.metrics import MetricClient
  
  configuration = ubiops.Configuration()
  # Configure API token authorization
  configuration.api_key['Authorization'] = 'Token <YOUR_API_TOKEN>'
  
  # Defining host is optional and default to https://api.ubiops.com/v2.1
  configuration.host = "https://api.ubiops.com/v2.1"
  # Enter a context with an instance of the API client
  api_client = ubiops.ApiClient(configuration)
  
  project_name = 'project_name_example' # str
  
  metric_client = MetricClient(project_name=project_name, api_client=api_client)
  metric_client.start()
  
  metric_client.log_metric(metric_name="custom.metric", labels={"test": "test"}, value=1.0)
  
  metric_client.stop()
  

Parameters¶

[Back to top]

start¶

start()

Start the MetricClient thread

Description¶

The MetricClient will run as a daemon tread and periodically send inserted metrics to the UbiOps API.

[Back to top]

stop¶

stop()

Stop the MetricClient thread

Description¶

The MetricClient will terminate gracefully and send any remaining metrics to the UbiOps API.

[Back to top]