a !f+@sldZddlmZddlmZddlmZddlmZddlmZddl m Z ddl m Z Gd d d eZ d S) aClient for interacting with the `Google Stackdriver Monitoring API (V3)`_. Example:: >>> from gcloud import monitoring >>> client = monitoring.Client() >>> query = client.query(minutes=5) >>> print(query.as_dataframe()) # Requires pandas. At present, the client supports querying of time series, metric descriptors, and monitored resource descriptors. .. _Google Stackdriver Monitoring API (V3): https://cloud.google.com/monitoring/api/v3/ ) JSONClient) ConnectionMetricDescriptor) MetricKind) ValueTypeQuery)ResourceDescriptorc@sheZdZdZeZejddddfddZe j e j ddddfdd Z d d Zdd d ZddZdddZdS)ClientavClient to bundle configuration needed for API requests. :type project: string :param project: The target project. If not passed, falls back to the default inferred from the environment. :type credentials: :class:`oauth2client.client.OAuth2Credentials` or :class:`NoneType` :param credentials: The OAuth2 Credentials to use for the connection owned by this client. If not passed (and if no ``http`` object is passed), falls back to the default inferred from the environment. :type http: :class:`httplib2.Http` or class that defines ``request()`` :param http: An optional HTTP object to make requests. If not passed, an ``http`` object is created that is bound to the ``credentials`` for the current object. NrcCst||||||dS)aConstruct a query object for retrieving metric data. Example:: >>> query = client.query(minutes=5) >>> print(query.as_dataframe()) # Requires pandas. :type metric_type: string :param metric_type: The metric type name. The default value is :data:`Query.DEFAULT_METRIC_TYPE `, but please note that this default value is provided only for demonstration purposes and is subject to change. See the `supported metrics`_. :type end_time: :class:`datetime.datetime` or None :param end_time: The end time (inclusive) of the time interval for which results should be returned, as a datetime object. The default is the start of the current minute. The start time (exclusive) is determined by combining the values of ``days``, ``hours``, and ``minutes``, and subtracting the resulting duration from the end time. It is also allowed to omit the end time and duration here, in which case :meth:`~gcloud.monitoring.query.Query.select_interval` must be called before the query is executed. :type days: integer :param days: The number of days in the time interval. :type hours: integer :param hours: The number of hours in the time interval. :type minutes: integer :param minutes: The number of minutes in the time interval. :rtype: :class:`~gcloud.monitoring.query.Query` :returns: The query object. :raises: :exc:`ValueError` if ``end_time`` is specified but ``days``, ``hours``, and ``minutes`` are all zero. If you really want to specify a point in time, use :meth:`~gcloud.monitoring.query.Query.select_interval`. .. _supported metrics: https://cloud.google.com/monitoring/api/metrics )end_timedayshoursminutesr)self metric_typer r rrrY/var/www/html/python-backend/venv/lib/python3.9/site-packages/gcloud/monitoring/client.pyquery>s4z Client.queryrc Cst||||||||dS)a Construct a metric descriptor object. Metric descriptors specify the schema for a particular metric type. This factory method is used most often in conjunction with the metric descriptor :meth:`~gcloud.monitoring.metric.MetricDescriptor.create` method to define custom metrics:: >>> descriptor = client.metric_descriptor( ... 'custom.googleapis.com/my_metric', ... metric_kind=MetricKind.GAUGE, ... value_type=ValueType.DOUBLE, ... description='This is a simple example of a custom metric.') >>> descriptor.create() Here is an example where the custom metric is parameterized by a metric label:: >>> label = LabelDescriptor('response_code', LabelValueType.INT64, ... description='HTTP status code') >>> descriptor = client.metric_descriptor( ... 'custom.googleapis.com/my_app/response_count', ... metric_kind=MetricKind.CUMULATIVE, ... value_type=ValueType.INT64, ... labels=[label], ... description='Cumulative count of HTTP responses.') >>> descriptor.create() :type type_: string :param type_: The metric type including a DNS name prefix. For example: ``"custom.googleapis.com/my_metric"`` :type metric_kind: string :param metric_kind: The kind of measurement. It must be one of :data:`MetricKind.GAUGE`, :data:`MetricKind.DELTA`, or :data:`MetricKind.CUMULATIVE`. See :class:`~gcloud.monitoring.metric.MetricKind`. :type value_type: string :param value_type: The value type of the metric. It must be one of :data:`ValueType.BOOL`, :data:`ValueType.INT64`, :data:`ValueType.DOUBLE`, :data:`ValueType.STRING`, or :data:`ValueType.DISTRIBUTION`. See :class:`ValueType`. :type labels: list of :class:`~gcloud.monitoring.label.LabelDescriptor` :param labels: A sequence of zero or more label descriptors specifying the labels used to identify a specific instance of this metric. :type unit: string :param unit: An optional unit in which the metric value is reported. :type description: string :param description: An optional detailed description of the metric. :type display_name: string :param display_name: An optional concise name for the metric. :rtype: :class:`MetricDescriptor` :returns: The metric descriptor created with the passed-in arguments. ) metric_kind value_typelabelsunit description display_namer)rtype_rrrrrrrrrmetric_descriptorvsEzClient.metric_descriptorcCs t||S)aLook up a metric descriptor by type. Example:: >>> METRIC = 'compute.googleapis.com/instance/cpu/utilization' >>> print(client.fetch_metric_descriptor(METRIC)) :type metric_type: string :param metric_type: The metric type name. :rtype: :class:`~gcloud.monitoring.metric.MetricDescriptor` :returns: The metric descriptor instance. :raises: :class:`gcloud.exceptions.NotFound` if the metric descriptor is not found. )r_fetch)rrrrrfetch_metric_descriptorszClient.fetch_metric_descriptorcCstj|||dS)aList all metric descriptors for the project. Examples:: >>> for descriptor in client.list_metric_descriptors(): ... print(descriptor.type) >>> for descriptor in client.list_metric_descriptors( ... type_prefix='custom.'): ... print(descriptor.type) :type filter_string: string or None :param filter_string: An optional filter expression describing the metric descriptors to be returned. See the `filter documentation`_. :type type_prefix: string or None :param type_prefix: An optional prefix constraining the selected metric types. This adds ``metric.type = starts_with("")`` to the filter. :rtype: list of :class:`~gcloud.monitoring.metric.MetricDescriptor` :returns: A list of metric descriptor instances. .. _filter documentation: https://cloud.google.com/monitoring/api/v3/filters ) type_prefix)r_list)r filter_stringr rrrlist_metric_descriptorsszClient.list_metric_descriptorscCs t||S)aLook up a monitored resource descriptor by type. Example:: >>> print(client.fetch_resource_descriptor('gce_instance')) :type resource_type: string :param resource_type: The resource type name. :rtype: :class:`~gcloud.monitoring.resource.ResourceDescriptor` :returns: The resource descriptor instance. :raises: :class:`gcloud.exceptions.NotFound` if the resource descriptor is not found. )r r)rZ resource_typerrrfetch_resource_descriptorsz Client.fetch_resource_descriptorcCs t||S)aList all monitored resource descriptors for the project. Example:: >>> for descriptor in client.list_resource_descriptors(): ... print(descriptor.type) :type filter_string: string or None :param filter_string: An optional filter expression describing the resource descriptors to be returned. See the `filter documentation`_. :rtype: list of :class:`~gcloud.monitoring.resource.ResourceDescriptor` :returns: A list of resource descriptor instances. .. _filter documentation: https://cloud.google.com/monitoring/api/v3/filters )r r!)rr"rrrlist_resource_descriptors sz Client.list_resource_descriptors)NN)N)__name__ __module__ __qualname____doc__rZ_connection_classr ZDEFAULT_METRIC_TYPErrZMETRIC_KIND_UNSPECIFIEDrZVALUE_TYPE_UNSPECIFIEDrrr#r$r%rrrrr (s 9 O r N)r)Z gcloud.clientrZgcloud.monitoring.connectionrZgcloud.monitoring.metricrrrZgcloud.monitoring.queryr Zgcloud.monitoring.resourcer r rrrrs