Unified Monitoring¶

class dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring(client)¶

Handle to interact with Unified Monitoring

Warning

Do not create this class directly, use dataikuapi.dssclient.DSSClient.get_unified_monitoring()

list_monitored_project_deployments()¶

Lists the monitored project deployments

Returns:: The list of monitored projects
Return type:: list of dataikuapi.dss.unifiedmonitoring.MonitoredProjectDeployment

list_monitored_api_endpoints(remove_duplicated_external_endpoints=True)¶

Lists the monitored API endpoints

Parameters:: remove_duplicated_external_endpoints (boolean) – if True, an endpoint that is both in a Deploy Anywhere Infrastructure and in an External endpoint scope will be listed only once, under the Deploy Anywhere Infrastructure. Optional
Returns:: The list of monitored API endpoints
Return type:: list of Union[dataikuapi.dss.unifiedmonitoring.MonitoredManagedApiEndpoint, dataikuapi.dss.unifiedmonitoring.MonitoredExternalApiEndpoint]

list_monitored_api_endpoint_with_activity_metrics(endpoints_to_filter_on=None, remove_duplicated_external_endpoints=True)¶

Lists the monitored API endpoints with their activity metrics

Parameters:

endpoints_to_filter_on (list of Union[dataikuapi.dss.unifiedmonitoring.DSSApiEndpointMonitoring, dataikuapi.dss.unifiedmonitoring.ExternalApiEndpointMonitoring]. Optional) – endpoints for which monitoring and activity metrics should be retrieved. If None or empty, all endpoints are considered
remove_duplicated_external_endpoints (boolean) – if True, an endpoint that is both in a Deploy Anywhere Infrastructure and in an External Endpoint Scope will be listed only once, under the Deploy Anywhere Infrastructure. Optional

Returns:

The list of API endpoint monitorings with their activity metrics

Return type:

list of Union[dataikuapi.dss.unifiedmonitoring.DSSApiEndpointMonitoringWithActivityMetrics, dataikuapi.dss.unifiedmonitoring.ExternalApiEndpointMonitoringWithActivityMetrics]

Project Monitoring¶

class dataikuapi.dss.unifiedmonitoring.MonitoredProjectDeployment(data)¶

A handle on a monitored project deployment

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_project_deployments()

deployment_id¶: The deployment id

infrastructure_id¶: The infrastructure id

stage¶: The stage of the deployment

snapshot_timestamp¶: The timestamp of the snapshot

bundle_name¶: The bundle name

deployed_project_key¶: The deployed project key

published_project_key¶: The published project key

get_raw()¶

Get the raw monitored project

Return type:: dict

API Endpoint Monitoring¶

class dataikuapi.dss.unifiedmonitoring.MonitoredManagedApiEndpoint(client, data)¶

A handle on a monitored managed API endpoint

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoints()

deployment_id¶: The deployment id

infrastructure_id¶: The infrastructure id

stage¶: The stage of the deployment

snapshot_timestamp¶: The timestamp of the snapshot

endpoint_id¶: The endpoint id

type¶: ‘MANAGED_API_ENDPOINT’

get_activity_metrics()¶

Get the activity metrics of the monitored managed API endpoint

Returns:: The activity metrics
Return type:: dataikuapi.dss.unifiedmonitoring.ManagedApiEndpointActivityMetrics

get_raw()¶

Get the raw monitored managed API endpoint

Return type:: dict

class dataikuapi.dss.unifiedmonitoring.MonitoredExternalApiEndpoint(client, data)¶

A handle on a monitored external API endpoint

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoints()

external_endpoints_scope¶: The external endpoint scope configuration

stage¶: The stage of the deployment

snapshot_timestamp¶: The timestamp of the snapshot

endpoint_name¶: The endpoint name

type¶: ‘EXTERNAL_API_ENDPOINT’

get_activity_metrics()¶

Get the activity metrics of the monitored external API endpoint

Returns:: The activity metrics
Return type:: dataikuapi.dss.unifiedmonitoring.ExternalApiEndpointActivityMetrics

get_raw()¶

Get the raw monitored external API endpoint

Return type:: dict

class dataikuapi.dss.unifiedmonitoring.ManagedApiEndpointActivityMetrics(data)¶

A handle on the activity metrics of a managed API endpoint

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoint_with_activity_metrics()

deployment_id¶: The deployment id

endpoint_id¶: The endpoint id

period¶: The time period spanned by this DSSApiEndpointActivityMetrics

period_all_requests_count¶: The count of all requests in the period

period_error_rate¶: The request error rate in the period

period_response_time_ms¶: The average response time in the period

counts¶: Detailed number of requests per timestamp

get_raw()¶

Get the raw activity metrics of a managed API endpoint

Return type:: dict

class dataikuapi.dss.unifiedmonitoring.ExternalApiEndpointActivityMetrics(data)¶

A handle on the activity metrics of an external API endpoint

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoint_with_activity_metrics()

external_endpoints_scope_name¶: The name of the external endpoint scope

endpoint_name¶: The endpoint name

period¶: The time period spanned by this ExternalApiEndpointActivityMetrics

period_all_requests_count¶: The count of all requests in the period

period_error_rate¶: The request error rate in the period

period_response_time_ms¶: The average response time in the period

counts¶: Detailed number of requests per timestamp

get_raw()¶

Get the raw activity metrics of an external API endpoint

Return type:: dict

class dataikuapi.dss.unifiedmonitoring.MonitoredManagedApiEndpointWithActivityMetrics(client, data)¶

A handle on a monitored managed API endpoint and its activity metrics

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoint_with_activity_metrics()

endpoint_monitoring¶: The DSS API endpoint monitoring

activity_metrics¶: The DSS API endpoint activity metrics

type¶: ‘MANAGED_API_ENDPOINT’

get_raw()¶

Get the raw monitored managed API endpoint with its activity metrics

Return type:: dict

class dataikuapi.dss.unifiedmonitoring.MonitoredExternalApiEndpointWithActivityMetrics(client, data)¶

A handle on a monitored external API endpoint and its activity metrics

Warning

Do not create this class directly, instead use dataikuapi.dss.unifiedmonitoring.DSSUnifiedMonitoring.list_monitored_api_endpoint_with_activity_metrics()

endpoint_monitoring¶: The external API endpoint monitoring

activity_metrics¶: The external API endpoint activity metrics

type¶: ‘EXTERNAL_API_ENDPOINT’

get_raw()¶

Get the raw monitored external API endpoint with its activity metrics

Return type:: dict