google.cloud.gcp_logging_metric_info 模块 – 收集 GCP 指标信息

注意

此模块是 google.cloud 集合（版本 1.4.1）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：google.cloud.gcp_logging_metric_info。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅讨论主题。

概要

• 收集 GCP 指标的信息

要求

执行此模块的主机需要以下要求。

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / elements=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典形式或表示它的 JSON 字符串形式。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可选的服务帐户电子邮件地址。
service_account_file 路径	如果选择了 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

注释

注意

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。

• 对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。

• 对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。

• 对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。

• 对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。

• 只有在未设置 playbook 值时，才会使用环境变量值。

• service_account_email 和 service_account_file 选项是互斥的。

示例

- name: get info on a metric
  gcp_logging_metric_info:
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

返回值

常见返回值记录在 此处，以下是此模块独有的字段

键	描述
资源 复杂	资源列表 已返回：始终
bucketOptions 复杂	当基于日志的指标使用 DISTRIBUTION 值类型时，需要 bucketOptions，它描述了用于创建提取值直方图的 bucket 边界。 已返回：成功
explicitBuckets 复杂	指定一组具有任意宽度的 bucket。 已返回：成功
bounds 列表 / elements=字符串	这些值必须单调递增。 已返回：成功
exponentialBuckets 复杂	指定一系列指数 bucket，其宽度与下限值成比例。每个 bucket 表示 bucket 中特定值的恒定相对不确定性。 已返回：成功
growthFactor 字符串	必须大于 1。 已返回：成功
numFiniteBuckets 整数	必须大于 0。 已返回：成功
scale 字符串	必须大于 0。 已返回：成功
linearBuckets 复杂	指定一系列线性 bucket，它们都具有相同的宽度（溢出和下溢除外）。 每个 bucket 表示 bucket 中特定值的恒定绝对不确定性。 已返回：成功
numFiniteBuckets 整数	必须大于 0。 已返回：成功
offset 字符串	第一个 bucket 的下限。 已返回：成功
width 整数	必须大于 0。 已返回：成功
description 字符串	此指标的描述，用于文档中。描述的最大长度为 8000 个字符。 已返回：成功
filter 字符串	用于匹配日志条目的高级日志过滤器（https://cloud.google.com/logging/docs/view/advanced-filters）。 已返回：成功
labelExtractors 字典	从标签键字符串到提取器表达式的映射，该表达式用于从日志条目字段中提取数据并将其分配为标签值。LabelDescriptor 中指定的每个标签键都必须在此映射中具有关联的提取器表达式。提取器表达式的语法与 valueExtractor 字段的语法相同。 已返回：成功
metricDescriptor 复杂	与基于日志的指标关联的指标描述符。 已返回：成功
displayName 字符串	指标的简洁名称，可以在用户界面中显示。使用句子大小写，不带结尾句点，例如“请求计数”。此字段是可选的，但建议为与用户可见的概念（如配额）关联的任何指标设置此字段。 已返回：成功
labels 复杂	可用于描述此指标类型特定实例的标签集。例如，appengine.googleapis.com/http/server/response_latencies 指标类型具有 HTTP 响应代码的标签 response_code，因此您可以查看成功响应或仅查看失败响应的延迟。 已返回：成功
description 字符串	标签的人类可读描述。 已返回：成功
key 字符串	标签键。 已返回：成功
valueType 字符串	可以分配给标签的数据类型。 已返回：成功
metricKind 字符串	指标记录的是瞬时值、值的变化等等。 某些 metricKind 和 valueType 的组合可能不受支持。 对于计数器指标，请将其设置为 DELTA。 已返回：成功
类型 字符串	指标类型，包括其 DNS 名称前缀。该类型未进行 URL 编码。 所有用户定义的指标类型都具有 DNS 名称 `custom.googleapis.com` 或 `external.googleapis.com`。 已返回：成功
单位 字符串	报告指标值时使用的单位。仅当 valueType 为 `INT64`、`DOUBLE` 或 `DISTRIBUTION` 时适用。支持的单位是 [统一测量单位代码](http://unitsofmeasure.org/ucum.html) 标准的子集。 已返回：成功
valueType 字符串	测量值是整数、浮点数等等。 某些 metricKind 和 valueType 的组合可能不受支持。 对于计数器指标，请将其设置为 INT64。 已返回：成功
名称 字符串	客户端分配的指标标识符。示例 - “error_count”、“nginx/requests”。 指标标识符限制为 100 个字符，并且只能包含以下字符 A-Z、a-z、0-9 和特殊字符 _-.,+!*’,()%/。正斜杠字符 (/) 表示名称片段的层次结构，并且不能作为名称的第一个字符。 已返回：成功
valueExtractor 字符串	当使用基于分布日志的指标从日志条目中提取要记录的值时，需要 valueExtractor。值提取支持两个函数 - EXTRACT(field) 或 REGEXP_EXTRACT(field, regex)。参数是：1. field - 要从中提取值的日志条目字段的名称。2. regex - 使用 Google RE2 语法 (https://github.com/google/re2/wiki/Syntax) 的正则表达式，带有一个捕获组，用于从指定的日志条目字段中提取数据。在应用正则表达式之前，字段的值将转换为字符串。指定不包含恰好一个捕获组的正则表达式是错误的。 已返回：成功

作者

• Google Inc. (@googlecloudplatform)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）