Try SpotterGather info for GCP Metric
Authors: Google Inc. (@googlecloudplatform)
preview | supported by community
Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2
collections:
- name: delowan.googlecloud
version: 1.0.2Gather info for GCP Metric
- name: get info on a metric
gcp_logging_metric_info:
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
scopes:
description:
- Array of scopes to be used
elements: str
type: list
project:
description:
- The Google Cloud Platform project to use.
type: str
env_type:
description:
- Specifies which Ansible environment you're running this module within.
- This should not be set unless you know what you're doing.
- This only alters the User Agent string for any API requests.
type: str
auth_kind:
choices:
- application
- machineaccount
- serviceaccount
description:
- The type of credential used.
required: true
type: str
service_account_file:
description:
- The path of a Service Account JSON file if serviceaccount is selected as type.
type: path
service_account_email:
description:
- An optional service account email address if machineaccount is selected and the
user does not wish to use the default email.
type: str
service_account_contents:
description:
- The contents of a Service Account JSON file, either in a dictionary or as a JSON
string that represents it.
type: jsonarg
resources:
contains:
bucketOptions:
contains:
explicitBuckets:
contains:
bounds:
description:
- The values must be monotonically increasing.
returned: success
type: list
description:
- Specifies a set of buckets with arbitrary widths.
returned: success
type: complex
exponentialBuckets:
contains:
growthFactor:
description:
- Must be greater than 1.
returned: success
type: str
numFiniteBuckets:
description:
- Must be greater than 0.
returned: success
type: int
scale:
description:
- Must be greater than 0.
returned: success
type: str
description:
- Specifies an exponential sequence of buckets that have a width that is
proportional to the value of the lower bound. Each bucket represents a
constant relative uncertainty on a specific value in the bucket.
returned: success
type: complex
linearBuckets:
contains:
numFiniteBuckets:
description:
- Must be greater than 0.
returned: success
type: int
offset:
description:
- Lower bound of the first bucket.
returned: success
type: str
width:
description:
- Must be greater than 0.
returned: success
type: int
description:
- Specifies a linear sequence of buckets that all have the same width (except
overflow and underflow).
- Each bucket represents a constant absolute uncertainty on the specific
value in the bucket.
returned: success
type: complex
description:
- The bucketOptions are required when the logs-based metric is using a DISTRIBUTION
value type and it describes the bucket boundaries used to create a histogram
of the extracted values.
returned: success
type: complex
description:
description:
- A description of this metric, which is used in documentation. The maximum
length of the description is 8000 characters.
returned: success
type: str
filter:
description:
- An advanced logs filter (U(https://cloud.google.com/logging/docs/view/advanced-filters))
which is used to match log entries.
returned: success
type: str
labelExtractors:
description:
- A map from a label key string to an extractor expression which is used to
extract data from a log entry field and assign as the label value. Each label
key specified in the LabelDescriptor must have an associated extractor expression
in this map. The syntax of the extractor expression is the same as for the
valueExtractor field.
returned: success
type: dict
metricDescriptor:
contains:
displayName:
description:
- 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.
returned: success
type: str
labels:
contains:
description:
description:
- A human-readable description for the label.
returned: success
type: str
key:
description:
- The label key.
returned: success
type: str
valueType:
description:
- The type of data that can be assigned to the label.
returned: success
type: str
description:
- The set of labels that can be used to describe a specific instance of
this metric type. 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.
returned: success
type: complex
metricKind:
description:
- Whether the metric records instantaneous values, changes to a value, etc.
- Some combinations of metricKind and valueType might not be supported.
- For counter metrics, set this to DELTA.
returned: success
type: str
type:
description:
- The metric type, including its DNS name prefix. The type is not URL-encoded.
- All user-defined metric types have the DNS name `custom.googleapis.com`
or `external.googleapis.com`.
returned: success
type: str
unit:
description:
- The unit in which the metric value is reported. It is only applicable
if the valueType is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The supported
units are a subset of [The Unified Code for Units of Measure](U(http://unitsofmeasure.org/ucum.html))
standard .
returned: success
type: str
valueType:
description:
- Whether the measurement is an integer, a floating-point number, etc.
- Some combinations of metricKind and valueType might not be supported.
- For counter metrics, set this to INT64.
returned: success
type: str
description:
- The metric descriptor associated with the logs-based metric.
returned: success
type: complex
name:
description:
- The client-assigned metric identifier. Examples - "error_count", "nginx/requests".
- Metric identifiers are limited to 100 characters and can include only the
following characters A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/.
The forward-slash character (/) denotes a hierarchy of name pieces, and it
cannot be the first character of the name.
returned: success
type: str
valueExtractor:
description:
- A valueExtractor is required when using a distribution logs-based metric to
extract the values to record from a log entry. Two functions are supported
for value extraction - EXTRACT(field) or REGEXP_EXTRACT(field, regex). The
argument are 1. field - The name of the log entry field from which the value
is to be extracted. 2. regex - A regular expression using the Google RE2 syntax
(U(https://github.com/google/re2/wiki/Syntax)) with a single capture group
to extract data from the specified log entry field. The value of the field
is converted to a string before applying the regex. It is an error to specify
a regex that does not include exactly one capture group.
returned: success
type: str
description: List of resources
returned: always
type: complex