CTS API

The Cloud Trace Service Class

The CTS high-level interface is available through the cts member of a Connection object. The cts member will only be added if the otcextensions.sdk.register_otc_extensions(conn) method is called.

Trace Operations

class otcextensions.sdk.cts.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
traces(tracker='system', **query)

List all traces

Parameters:

  • tracker – The name or an tracker of Tracker

  • limit – default limit of resources

Returns:

A generator of tracker object of Trace

Trackers Operations

class otcextensions.sdk.cts.v1._proxy.Proxy(session: session.Session, *, service_type: str | None = None, service_name: str | None = None, interface: str | None = None, region_name: str | None = None, endpoint_override: str | None = None, version: str | None = None, auth: plugin.BaseAuthPlugin | None = None, user_agent: str | None = None, connect_retries: int | None = None, logger: logging.Logger | None = None, allow: dict[str, ty.Any] | None = None, additional_headers: collections.abc.MutableMapping[str, str] | None = None, client_name: str | None = None, client_version: str | None = None, allow_version_hack: bool | None = None, global_request_id: str | None = None, min_version: str | None = None, max_version: str | None = None, default_microversion: str | None = None, status_code_retries: int | None = None, retriable_status_codes: list[int] | None = None, raise_exc: bool | None = None, rate_limit: float | None = None, concurrency: int | None = None, connect_retry_delay: float | None = None, status_code_retry_delay: float | None = None, statsd_client: statsd_client.StatsClient | None = None, statsd_prefix: str | None = None, prometheus_counter: prometheus_client.Counter | None = None, prometheus_histogram: prometheus_client.Histogram | None = None, influxdb_config: dict[str, ty.Any] | None = None, influxdb_client: influxdb_client.InfluxDBClient | None = None)
get_tracker(tracker)

Get detail about a given tracker

Parameters:

tracker – The tracker id, name or an tracker of Tracker

Returns:

one object of class Tracker

create_tracker(**kwargs)

Create a tracker

Parameters:

kwargs (dict) – Keyword arguments which will be used to overwrite a Tracker

update_tracker(tracker, **attrs)

Update tracker with attributes

Parameters:

  • tracker – The value can be the ID of an tracker or a tracker tracker.

  • attrs (dict) – Keyword arguments which will be used to create a tracker, comprised of the properties on the tracker class.

Returns:

The updated tracker

Return type:

tracker

delete_tracker(tracker='system', ignore_missing=True)

Delete a tracker

Parameters:

  • tracker – The value can be the ID of a tracker or a Tracker instance

  • ignore_missing (bool) – When set to False ResourceNotFound will be raised when the backup_policy does not exist. When set to True, no exception will be set when attempting to delete a nonexistent backup_policy.

Returns:

tracker been deleted

Return type:

Tracker

last updated: UTC - commit: