google_api_cloud_monitoring

v0.0.1

google_api_cloud_monitoring v0.0.1 GoogleApi.CloudMonitoring.V2beta2.Api.Timeseries View Source

API calls for all endpoints tagged Timeseries.

Link to this section Summary

Functions

cloudmonitoring_timeseries_list(connection, project, metric, youngest, opts \\ [])

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken

cloudmonitoring_timeseries_write(connection, project, opts \\ [])

Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time

Link to this section Functions

Link to this function cloudmonitoring_timeseries_list(connection, project, metric, youngest, opts \\ []) View Source 
cloudmonitoring_timeseries_list(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.CloudMonitoring.V2beta2.Model.ListTimeseriesResponse.t} |
  {:error, Tesla.Env.t}

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

Parameters

  • connection (GoogleApi.CloudMonitoring.V2beta2.Connection): Connection to server
  • project (String): The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.
  • metric (String): Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.
  • youngest (String): End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :aggregator (String): The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.
    • :count (Integer): Maximum number of data points per page, which is used for pagination of results.
    • :labels (List[String]): A collection of labels for the matching time series, which are represented as: - key==value: key equals the value - key=~value: key regex matches the value - key!=value: key does not equal the value - key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify: label=cloud.googleapis.com%2Flocation=~us-central1.*
    • :oldest (String): Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]
    • :page_token (String): The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.
    • :timespan (String): Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: - s: second - m: minute - h: hour - d: day - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].
    • :window (String): The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: - m: minute - h: hour - d: day - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.
    • :body (ListTimeseriesRequest):

Returns

{:ok, %GoogleApi.CloudMonitoring.V2beta2.Model.ListTimeseriesResponse{}} on success {:error, info} on failure

Link to this function cloudmonitoring_timeseries_write(connection, project, opts \\ []) View Source 
cloudmonitoring_timeseries_write(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.CloudMonitoring.V2beta2.Model.WriteTimeseriesResponse.t} |
  {:error, Tesla.Env.t}

Put data points to one or more time series for one or more metrics. If a time series does not exist, a new time series will be created. It is not allowed to write a time series point that is older than the existing youngest point of that time series. Points that are older than the existing youngest point of that time series will be discarded silently. Therefore, users should make sure that points of a time series are written sequentially in the order of their end time.

Parameters

  • connection (GoogleApi.CloudMonitoring.V2beta2.Connection): Connection to server
  • project (String): The project ID. The value can be the numeric project ID or string-based project name.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (WriteTimeseriesRequest):

Returns

{:ok, %GoogleApi.CloudMonitoring.V2beta2.Model.WriteTimeseriesResponse{}} on success {:error, info} on failure