| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="monitoring_v3.html">Cloud Monitoring API</a> . <a href="monitoring_v3.projects.html">projects</a> . <a href="monitoring_v3.projects.metricDescriptors.html">metricDescriptors</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a single metric descriptor. This method does not require a Workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists metric descriptors that match a filter. This method does not require a Workspace.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(name, body=None, x__xgafv=None)</code> |
| <pre>Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). |
| |
| Args: |
| name: string, Required. The project on which to execute the request. The format is: |
| projects/[PROJECT_ID_OR_NUMBER] |
| (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.The following are specific rules for service defined Monitoring metric descriptors: |
| # type, metric_kind, value_type, description, and display_name fields are all required. The unit field must be specified if the value_type is any of DOUBLE, INT64, DISTRIBUTION. |
| # Maximum of default 500 metric descriptors per service is allowed. |
| # Maximum of default 10 labels per metric descriptor is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. |
| "name": "A String", # The resource name of the metric descriptor. |
| "labels": [ # The set of labels that can be used to describe a specific instance of this metric type.The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "launchStage": "A String", # Optional. The launch stage of the metric definition. |
| "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. |
| "metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric. |
| "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. |
| "ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. |
| "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. |
| }, |
| "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) |
| # bit bit |
| # By byte |
| # s second |
| # min minute |
| # h hour |
| # d day |
| # 1 dimensionlessPrefixes (PREFIX) |
| # k kilo (10^3) |
| # M mega (10^6) |
| # G giga (10^9) |
| # T tera (10^12) |
| # P peta (10^15) |
| # E exa (10^18) |
| # Z zetta (10^21) |
| # Y yotta (10^24) |
| # m milli (10^-3) |
| # u micro (10^-6) |
| # n nano (10^-9) |
| # p pico (10^-12) |
| # f femto (10^-15) |
| # a atto (10^-18) |
| # z zepto (10^-21) |
| # y yocto (10^-24) |
| # Ki kibi (2^10) |
| # Mi mebi (2^20) |
| # Gi gibi (2^30) |
| # Ti tebi (2^40) |
| # Pi pebi (2^50)GrammarThe grammar also includes these connectors: |
| # / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). |
| # . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: |
| # Expression = Component { "." Component } { "/" Component } ; |
| # |
| # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
| # | Annotation |
| # | "1" |
| # ; |
| # |
| # Annotation = "{" NAME "}" ; |
| # Notes: |
| # Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. |
| # NAME is a sequence of non-blank printable ASCII characters not containing { or }. |
| # 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). |
| # % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). |
| # 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). |
| "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. |
| "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. |
| "A String", |
| ], |
| "description": "A String", # A detailed description of the metric, which can be used in documentation. |
| "type": "A String", # The metric type, including its DNS name prefix. The type is not URL-encoded.All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must follow: |
| # Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. |
| # The maximum number of characters allowed for the relative_metric_name is 100.All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.Metric types should use a natural hierarchical grouping. For example: |
| # "custom.googleapis.com/invoice/paid/amount" |
| # "external.googleapis.com/prometheus/up" |
| # "appengine.googleapis.com/http/server/response_latencies" |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.The following are specific rules for service defined Monitoring metric descriptors: |
| # type, metric_kind, value_type, description, and display_name fields are all required. The unit field must be specified if the value_type is any of DOUBLE, INT64, DISTRIBUTION. |
| # Maximum of default 500 metric descriptors per service is allowed. |
| # Maximum of default 10 labels per metric descriptor is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. |
| "name": "A String", # The resource name of the metric descriptor. |
| "labels": [ # The set of labels that can be used to describe a specific instance of this metric type.The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "launchStage": "A String", # Optional. The launch stage of the metric definition. |
| "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. |
| "metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric. |
| "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. |
| "ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. |
| "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. |
| }, |
| "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) |
| # bit bit |
| # By byte |
| # s second |
| # min minute |
| # h hour |
| # d day |
| # 1 dimensionlessPrefixes (PREFIX) |
| # k kilo (10^3) |
| # M mega (10^6) |
| # G giga (10^9) |
| # T tera (10^12) |
| # P peta (10^15) |
| # E exa (10^18) |
| # Z zetta (10^21) |
| # Y yotta (10^24) |
| # m milli (10^-3) |
| # u micro (10^-6) |
| # n nano (10^-9) |
| # p pico (10^-12) |
| # f femto (10^-15) |
| # a atto (10^-18) |
| # z zepto (10^-21) |
| # y yocto (10^-24) |
| # Ki kibi (2^10) |
| # Mi mebi (2^20) |
| # Gi gibi (2^30) |
| # Ti tebi (2^40) |
| # Pi pebi (2^50)GrammarThe grammar also includes these connectors: |
| # / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). |
| # . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: |
| # Expression = Component { "." Component } { "/" Component } ; |
| # |
| # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
| # | Annotation |
| # | "1" |
| # ; |
| # |
| # Annotation = "{" NAME "}" ; |
| # Notes: |
| # Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. |
| # NAME is a sequence of non-blank printable ASCII characters not containing { or }. |
| # 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). |
| # % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). |
| # 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). |
| "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. |
| "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. |
| "A String", |
| ], |
| "description": "A String", # A detailed description of the metric, which can be used in documentation. |
| "type": "A String", # The metric type, including its DNS name prefix. The type is not URL-encoded.All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must follow: |
| # Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. |
| # The maximum number of characters allowed for the relative_metric_name is 100.All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.Metric types should use a natural hierarchical grouping. For example: |
| # "custom.googleapis.com/invoice/paid/amount" |
| # "external.googleapis.com/prometheus/up" |
| # "appengine.googleapis.com/http/server/response_latencies" |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted. |
| |
| Args: |
| name: string, Required. The metric descriptor on which to execute the request. The format is: |
| projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] |
| An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric". (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # The JSON representation for Empty is empty JSON object {}. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a single metric descriptor. This method does not require a Workspace. |
| |
| Args: |
| name: string, Required. The metric descriptor on which to execute the request. The format is: |
| projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] |
| An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count". (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.The following are specific rules for service defined Monitoring metric descriptors: |
| # type, metric_kind, value_type, description, and display_name fields are all required. The unit field must be specified if the value_type is any of DOUBLE, INT64, DISTRIBUTION. |
| # Maximum of default 500 metric descriptors per service is allowed. |
| # Maximum of default 10 labels per metric descriptor is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. |
| "name": "A String", # The resource name of the metric descriptor. |
| "labels": [ # The set of labels that can be used to describe a specific instance of this metric type.The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "launchStage": "A String", # Optional. The launch stage of the metric definition. |
| "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. |
| "metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric. |
| "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. |
| "ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. |
| "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. |
| }, |
| "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) |
| # bit bit |
| # By byte |
| # s second |
| # min minute |
| # h hour |
| # d day |
| # 1 dimensionlessPrefixes (PREFIX) |
| # k kilo (10^3) |
| # M mega (10^6) |
| # G giga (10^9) |
| # T tera (10^12) |
| # P peta (10^15) |
| # E exa (10^18) |
| # Z zetta (10^21) |
| # Y yotta (10^24) |
| # m milli (10^-3) |
| # u micro (10^-6) |
| # n nano (10^-9) |
| # p pico (10^-12) |
| # f femto (10^-15) |
| # a atto (10^-18) |
| # z zepto (10^-21) |
| # y yocto (10^-24) |
| # Ki kibi (2^10) |
| # Mi mebi (2^20) |
| # Gi gibi (2^30) |
| # Ti tebi (2^40) |
| # Pi pebi (2^50)GrammarThe grammar also includes these connectors: |
| # / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). |
| # . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: |
| # Expression = Component { "." Component } { "/" Component } ; |
| # |
| # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
| # | Annotation |
| # | "1" |
| # ; |
| # |
| # Annotation = "{" NAME "}" ; |
| # Notes: |
| # Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. |
| # NAME is a sequence of non-blank printable ASCII characters not containing { or }. |
| # 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). |
| # % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). |
| # 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). |
| "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. |
| "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. |
| "A String", |
| ], |
| "description": "A String", # A detailed description of the metric, which can be used in documentation. |
| "type": "A String", # The metric type, including its DNS name prefix. The type is not URL-encoded.All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must follow: |
| # Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. |
| # The maximum number of characters allowed for the relative_metric_name is 100.All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.Metric types should use a natural hierarchical grouping. For example: |
| # "custom.googleapis.com/invoice/paid/amount" |
| # "external.googleapis.com/prometheus/up" |
| # "appengine.googleapis.com/http/server/response_latencies" |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(name, pageToken=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| <pre>Lists metric descriptors that match a filter. This method does not require a Workspace. |
| |
| Args: |
| name: string, Required. The project on which to execute the request. The format is: |
| projects/[PROJECT_ID_OR_NUMBER] |
| (required) |
| pageToken: string, If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. |
| pageSize: integer, A positive number that is the maximum number of results to return. |
| filter: string, If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): |
| metric.type = starts_with("custom.googleapis.com/") |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The ListMetricDescriptors response. |
| "nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. |
| "metricDescriptors": [ # The metric descriptors that are available to the project and that match the value of filter, if present. |
| { # Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.The following are specific rules for service defined Monitoring metric descriptors: |
| # type, metric_kind, value_type, description, and display_name fields are all required. The unit field must be specified if the value_type is any of DOUBLE, INT64, DISTRIBUTION. |
| # Maximum of default 500 metric descriptors per service is allowed. |
| # Maximum of default 10 labels per metric descriptor is allowed.The default maximum limit can be overridden. Please follow https://cloud.google.com/monitoring/quotas |
| "displayName": "A String", # A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. |
| "name": "A String", # The resource name of the metric descriptor. |
| "labels": [ # The set of labels that can be used to describe a specific instance of this metric type.The label key name must follow: |
| # Only upper and lower-case letters, digits and underscores (_) are allowed. |
| # Label name must start with a letter or digit. |
| # The maximum length of a label name is 100 characters.For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. |
| { # A description of a label. |
| "key": "A String", # The key for this label. The key must meet the following criteria: |
| # Does not exceed 100 characters. |
| # Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* |
| # The first character must be an upper- or lower-case letter. |
| # The remaining characters must be letters, digits, or underscores. |
| "description": "A String", # A human-readable description for the label. |
| "valueType": "A String", # The type of data that can be assigned to the label. |
| }, |
| ], |
| "launchStage": "A String", # Optional. The launch stage of the metric definition. |
| "metricKind": "A String", # Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. |
| "metadata": { # Additional annotations that can be used to guide the usage of a metric. # Optional. Metadata which can be used to guide usage of the metric. |
| "launchStage": "A String", # Deprecated. Must use the MetricDescriptor.launch_stage instead. |
| "ingestDelay": "A String", # The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. |
| "samplePeriod": "A String", # The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. |
| }, |
| "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) |
| # bit bit |
| # By byte |
| # s second |
| # min minute |
| # h hour |
| # d day |
| # 1 dimensionlessPrefixes (PREFIX) |
| # k kilo (10^3) |
| # M mega (10^6) |
| # G giga (10^9) |
| # T tera (10^12) |
| # P peta (10^15) |
| # E exa (10^18) |
| # Z zetta (10^21) |
| # Y yotta (10^24) |
| # m milli (10^-3) |
| # u micro (10^-6) |
| # n nano (10^-9) |
| # p pico (10^-12) |
| # f femto (10^-15) |
| # a atto (10^-18) |
| # z zepto (10^-21) |
| # y yocto (10^-24) |
| # Ki kibi (2^10) |
| # Mi mebi (2^20) |
| # Gi gibi (2^30) |
| # Ti tebi (2^40) |
| # Pi pebi (2^50)GrammarThe grammar also includes these connectors: |
| # / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). |
| # . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: |
| # Expression = Component { "." Component } { "/" Component } ; |
| # |
| # Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] |
| # | Annotation |
| # | "1" |
| # ; |
| # |
| # Annotation = "{" NAME "}" ; |
| # Notes: |
| # Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. |
| # NAME is a sequence of non-blank printable ASCII characters not containing { or }. |
| # 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). |
| # % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). |
| # 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). |
| "valueType": "A String", # Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. |
| "monitoredResourceTypes": [ # Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. |
| "A String", |
| ], |
| "description": "A String", # A detailed description of the metric, which can be used in documentation. |
| "type": "A String", # The metric type, including its DNS name prefix. The type is not URL-encoded.All service defined metrics must be prefixed with the service name, in the format of {service name}/{relative metric name}, such as cloudsql.googleapis.com/database/cpu/utilization. The relative metric name must follow: |
| # Only upper and lower-case letters, digits, '/' and underscores '_' are allowed. |
| # The maximum number of characters allowed for the relative_metric_name is 100.All user-defined metric types have the DNS name custom.googleapis.com, external.googleapis.com, or logging.googleapis.com/user/.Metric types should use a natural hierarchical grouping. For example: |
| # "custom.googleapis.com/invoice/paid/amount" |
| # "external.googleapis.com/prometheus/up" |
| # "appengine.googleapis.com/http/server/response_latencies" |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
