本文档介绍如何使用 Google Cloud 控制台、Logging API 和 Google Cloud CLI 创建基于日志的计数器类型指标。
计数器指标用于计算与指定过滤条件匹配的日志条目的数量。例如,您可以创建一个基于日志的指标,用于统计包含特定错误消息的日志条目的数量。基于日志的指标可以应用于单个 Google Cloud 项目或日志存储桶。
如需简要了解基于日志的指标,请参阅基于日志的指标概览。
准备工作
如需使用基于日志的指标,您必须拥有一个已启用结算功能的 Google Cloud 项目:
- 登录您的 Google Cloud 账号。如果您是 Google Cloud 新手,请创建一个账号来评估我们的产品在实际场景中的表现。新客户还可获享 $300 赠金,用于运行、测试和部署工作负载。
-
在 Google Cloud Console 中的项目选择器页面上,选择或创建一个 Google Cloud 项目。
-
在 Google Cloud Console 中的项目选择器页面上,选择或创建一个 Google Cloud 项目。
确保您的 Identity and Access Management 角色包含创建和查看基于日志的指标以及创建提醒政策所需的权限。如需了解详情,请参阅针对基于日志的指标的权限。
创建计数器类型基于日志的指标
该指标计算由您提供的过滤条件标识的日志条目数。您可以在过滤器中使用正则表达式,我们建议您添加资源类型。过滤条件的长度不能超过 20,000 个字符。
不要将敏感信息放入过滤器。过滤器将被视为服务数据。
控制台
如需在 Google Cloud 控制台的 Google Cloud 项目中创建计数器指标,请按以下步骤操作:
-
在 Google Cloud 控制台的导航面板中,选择 Logging,然后选择基于日志的指标:
点击创建指标。此时会显示创建日志指标面板。
设置指标类型:选择计数器。
在详细信息部分中设置以下字段:
- 日志指标名称:选择一个在 Google Cloud 项目中基于日志的指标中具有唯一性的名称。您需遵循一些命名限制;如需了解详情,请参阅问题排查。
- 说明:输入此指标的说明。
- 单位:可将此字段留空或者插入数字 1。
在过滤器选择部分中,定义指标过滤器。
使用选择日志范围来选择过滤条件是针对所有 Google Cloud 项目日志,还是仅针对特定存储桶中的日志。
使用日志记录查询语言创建一个过滤器,用于仅收集要在指标中计数的日志条目。 您还可以使用正则表达式来创建指标的过滤器。
如需查看哪些日志条目与您的过滤条件匹配,请点击预览日志。
(可选)在标签部分中添加标签。如需了解如何创建标签,请参阅创建标签。
点击创建指标,以创建指标。
gcloud
您可以使用以下命令创建不带自定义标签的基于日志的指标:
gcloud logging metrics create METRIC_NAME \ --description="METRIC_DESCRIPTION" \ --log-filter="FILTER" \ [--bucket-name="BUCKET_NAME"]
例如,以下命令会创建一个名为 error_count
的项目级范围的基于日志的指标。
gcloud logging metrics create error_count \ --description "Errors in syslog." \ --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"
如需改为创建存储桶级的基于日志的指标,请提供 --bucket_name
标志:
gcloud logging metrics create error_count \ --description "Errors in syslog." \ --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \ --bucket-name projects/my-project/locations/global/buckets/my-test-bucket
如需了解如何创建标签,请参阅创建标签。
API
要创建计数器指标,请使用 Logging API 的 projects.metrics.create 方法。您可以试用 APIs Explorer 中的方法。请按以下步骤准备方法的参数:
将 parent 字段设置为要在其中创建指标的项目或存储桶:
- 对于项目级范围的基于日志的指标,请指定项目:
projects/PROJECT_ID
- 对于存储桶级基于日志的指标,请指定存储桶:
projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
将请求正文设置为
LogMetric
对象。以下是计数器指标的示例对象:{ name: "my-metric" description: "This is my metric." filter: "resource.type=gce_instance AND log_id(\"syslog\")", metricDescriptor: { labels: [ { key: "my-label", valueType: STRING, description: "This is my label.", } ] }, labelExtractors: { "my-label": "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")", ... }, }
备注:
选择对于项目中基于日志的指标而言唯一的指标名称。您需遵循一些命名限制;要了解详情,请参阅问题排查。
对于计数器指标,LogMetric 字段
valueExtractor
和bucketOptions
没有任何用途,已被省略。如果指标没有标签,则可以省略
metricDescriptor
和labelExtractors
字段。如果您的指标确实有标签,请参阅基于日志的指标标签,了解标签简介并详细了解如何在 API 中创建标签。
如需了解详情,请参阅 LogMetric 类型。
新指标的延迟时间
您的新指标会立即显示在日志浏览器指标列表和相关的 Monitoring 菜单中。数据通常会在不到一分钟的时间内提供。
检查基于日志的指标
如需列出 Google Cloud 项目中用户定义的基于日志的指标,或检查 Google Cloud 项目中的特定指标,请执行以下操作:
控制台
-
在 Google Cloud 控制台的导航面板中,选择 Logging,然后选择基于日志的指标:
在用户定义的指标窗格中,您会看到当前 Google Cloud 项目中用户定义的基于日志的指标:
如需查看基于日志的指标中的数据,请点击指标行中的 more_vert 菜单,然后选择在 Metrics Explorer 中查看。
gcloud
如需列出 Google Cloud 项目中用户定义的基于日志的指标,请使用以下命令:
gcloud logging metrics list
如需在 Google Cloud 项目中显示用户定义的基于日志的指标,请使用以下命令:
gcloud logging metrics describe METRIC_NAME
如需获取帮助,请使用以下命令:
gcloud logging metrics --help
您无法通过 Google Cloud CLI 读取指标的时序数据。
API
列出指标
如需列出 Google Cloud 项目中用户定义的基于日志的指标,请使用 projects.metrics.list API 方法。按如下所示填写方法的参数:
- parent:Google Cloud 项目的资源名称:
projects/PROJECT_ID
。 - pageSize:最大结果数。
- pageToken:获取下一页结果。如需了解如何使用页面令牌,请参阅 projects.metrics.list。
检索指标定义
要检索单个用户定义的基于日志的指标,请使用 projects.metrics.get API 方法。按如下所示填写方法的参数:
metricName:指标的资源名称:
projects/PROJECT_ID/metrics/METRIC_ID
读取指标数据
如需读取基于日志的指标中的时序数据,请使用 Cloud Monitoring API 中的 projects.timeseries.list。如需详细了解时序数据,请参阅读取时序。
如需读取单个用户定义的基于日志的指标,请使用此指标类型和标识符填充该方法的参数:
logging.googleapis.com/user/METRIC_ID
更新基于日志的指标
您可以修改用户定义的基于日志的指标,以更改其说明、过滤条件以及指标中引用的字段的名称。您可以为指标添加新标签,也可以更改用于提取指标及其标签值的正则表达式。如果您使用的是存储桶级指标,还可以更新指标的分桶。
您无法更改用户定义的基于日志的指标或其标签的名称或类型,也无法删除基于日志的指标中的现有标签。
如需修改基于日志的指标,请执行以下操作:
控制台
-
在 Google Cloud 控制台的导航面板中,选择 Logging,然后选择基于日志的指标:
在要修改的基于日志的指标的 more_vert 菜单中,点击修改指标。
更改指标中允许更改的项目。
点击更新指标。
gcloud
使用 Google Cloud CLI 更改计数器指标的说明、过滤查询和存储桶。您可以一次性更新任意或所有字段。
gcloud logging update METRIC_NAME \ --description="METRIC_DESCRIPTION" \ --log-filter="FILTER" \ --bucket-name=BUCKET_NAME
如果您更改与存储桶级指标关联的存储桶,则在更改之前收集的任何指标数据都将不再反映当前配置。为上一个存储桶收集的指标数据不会移除。
如需更新分布指标或其他计数器指标字段(不包括 METRIC_NAME),请创建一个文件,以 JSON 或 YAML 格式包含修改后的 LogMetric
规范。然后,使用 --config-from-file 字段调用 update
命令,并将 FILENAME 替换为您的 JSON 或 YAML 文件的名称,从而更新指标:
gcloud logging update METRIC_NAME --config-from-file FILENAME
如需了解详情,请使用以下命令:
gcloud logging metrics update --help
API
要修改基于日志的指标,请使用 API 中的 projects.metrics.update 方法。按如下方式设置字段:
metricName:指标的完整资源名称:
projects/PROJECT_ID/metrics/METRIC_ID
例如:
projects/my-gcp-project/metrics/my-error-metric
在请求正文中,添加与现有指标完全相同(要更改或新增的内容除外)的 LogMetric 对象。
删除基于日志的指标
如需删除用户定义的基于日志的指标,请执行以下操作:
控制台
-
在 Google Cloud 控制台的导航面板中,选择 Logging,然后选择基于日志的指标:
选择您要删除的指标,然后点击删除。
或者,在要删除的基于日志的指标的 more_vert 菜单中点击删除指标。
gcloud
使用以下命令删除当前 Google Cloud 项目中用户定义的基于日志的指标:
gcloud logging metrics delete METRIC_NAME For more details, use the following command:gcloud logging metrics delete --help
API
要删除用户定义的基于日志的指标,请使用 API 中的 projects.metrics.delete 方法。
此外,在 Google Cloud 控制台的基于日志的指标页面中,基于日志的指标界面的用户定义的指标窗格也提供了更多功能,可帮助您管理 Google Cloud 项目中用户定义的指标。如需了解详情,请参阅用户定义的指标窗格。