文档 Grafana Alloy 参考 组件 prometheus prometheus.exporter.cloudwatch

prometheus.exporter.cloudwatch

prometheus.exporter.cloudwatch 组件嵌入了 yet-another-cloudwatch-exporter，让您能够以 Prometheus 兼容格式收集 Amazon CloudWatch 指标。

此组件允许您在称为作业的一组配置中抓取 CloudWatch 指标。作业有两种类型：发现作业和静态作业。

认证

Alloy 必须运行在可以访问 AWS 的环境中。导出器使用 AWS SDK for Go，并通过 AWS 默认凭证链提供认证。无论使用何种方法获取凭证，导出器工作都需要一些权限。

text 复制

"tag:GetResources",
"cloudwatch:GetMetricData",
"cloudwatch:GetMetricStatistics",
"cloudwatch:ListMetrics"

Transit Gateway 附件（tgwa）指标需要以下 IAM 权限才能工作。

text 复制

"ec2:DescribeTags",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeTransitGateway*"

发现带有标签的 API Gateway REST API 需要以下 IAM 权限

text 复制

"apigateway:GET"

发现带有标签的 Database Migration Service (DMS) 复制实例和任务需要以下 IAM 权限

text 复制

"dms:DescribeReplicationInstances",
"dms:DescribeReplicationTasks"

要使用所有集成功能，请使用以下 AWS IAM 策略

json 复制

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "Stmt1674249227793",
      "Action": [
        "tag:GetResources",
        "cloudwatch:GetMetricData",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics",
        "ec2:DescribeTags",
        "ec2:DescribeInstances",
        "ec2:DescribeRegions",
        "ec2:DescribeTransitGateway*",
        "apigateway:GET",
        "dms:DescribeReplicationInstances",
        "dms:DescribeReplicationTasks"
      ],
      "Effect": "Allow",
      "Resource": "*"
    }
  ]
}

用法

alloy 复制

prometheus.exporter.cloudwatch "queues" {
    sts_region      = "us-east-2"
    aws_sdk_version_v2 = false
    discovery {
        type        = "AWS/SQS"
        regions     = ["us-east-2"]
        search_tags = {
            "scrape" = "true",
        }

        metric {
            name       = "NumberOfMessagesSent"
            statistics = ["Sum", "Average"]
            period     = "1m"
        }

        metric {
            name       = "NumberOfMessagesReceived"
            statistics = ["Sum", "Average"]
            period     = "1m"
        }
    }
}

参数

您可以将以下参数与 prometheus.exporter.cloudwatch 一起使用

如果您在 discovery_exported_tags 参数中定义 ["name", "type"] 在 "AWS/EC2" 下，它会将 name 和 type 标签及其值作为所有指标中的标签导出。这会影响所有发现作业。

块

您可以将以下块与 prometheus.exporter.cloudwatch 一起使用

> 符号表示更深的嵌套级别。例如，discovery > role 指的是在 discovery 块中定义的 role 块。

discovery

discovery 块允许组件仅使用 AWS 服务和该服务/命名空间下的指标列表来抓取 CloudWatch 指标。Alloy 会找到指定服务中的 AWS 资源，抓取指标，适当地为其添加标签，然后将它们导出到 Prometheus。以下示例配置展示了如何从所有 AWS EC2 实例抓取 CPU 利用率和网络流量指标

alloy 复制

prometheus.exporter.cloudwatch "discover_instances" {
    sts_region = "us-east-2"

    discovery {
        type    = "AWS/EC2"
        regions = ["us-east-2"]

        metric {
            name       = "CPUUtilization"
            statistics = ["Average"]
            period     = "5m"
        }

        metric {
            name       = "NetworkPacketsIn"
            statistics = ["Average"]
            period     = "5m"
        }
    }
}

您可以配置 discovery 块一次或多次，以从不同的服务或使用不同的 search_tags 抓取指标。

static

static 块配置组件以抓取一组特定的 CloudWatch 指标。指标需要用以下规范完全限定

1. namespace：例如，AWS/EC2，AWS/EBS，如果是自定义指标，则是 CoolApp 等。
2. dimensions：CloudWatch 通过一组维度来标识指标，这些维度本质上是标签/值对。例如，所有 AWS/EC2 指标都由 InstanceId 维度和标识符本身来标识。
3. metric：指标名称和统计量。

以下示例配置展示了如何抓取发现示例中相同的指标，但针对特定的 AWS EC2 实例

alloy 复制

prometheus.exporter.cloudwatch "static_instances" {
    sts_region = "us-east-2"

    static "instances" {
        regions    = ["us-east-2"]
        namespace  = "AWS/EC2"
        dimensions = {
            "InstanceId" = "i01u29u12ue1u2c",
        }

        metric {
            name       = "CPUUsage"
            statistics = ["Sum", "Average"]
            period     = "1m"
        }
    }
}

如上所示，static 块必须指定一个标签，该标签在导出的指标中转换为 name 标签。

alloy 复制

static "<LABEL>" {
    regions    = ["us-east-2"]
    namespace  = "AWS/EC2"
    // ...
}

您可以配置 static 块一次或多次，以抓取具有不同 dimensions 集的指标。

抓取单个指标时，必须指定所有维度，如上例所示。例如，AWS/Logs 指标需要指定 Resource、Service、Class 和 Type 维度。这同样适用于 CloudWatch 自定义指标，保存到 CloudWatch 时附加到指标的所有维度都是必需的。

custom_namespace

custom_namespace 块允许组件仅使用命名空间名称和该命名空间下的指标列表来抓取自定义命名空间中的 CloudWatch 指标。例如

alloy 复制

prometheus.exporter.cloudwatch "discover_instances" {
    sts_region = "eu-west-1"

    custom_namespace "customEC2Metrics" {
        namespace = "CustomEC2Metrics"
        regions   = ["us-east-1"]

        metric {
            name       = "cpu_usage_idle"
            statistics = ["Average"]
            period     = "5m"
        }

        metric {
            name       = "disk_free"
            statistics = ["Average"]
            period     = "5m"
        }
    }
}

您可以配置 custom_namespace 块多次，以从不同的命名空间抓取指标。

metric

必需

表示要抓取的 AWS 指标。

可以多次指定 metric 块以定义多个目标指标。有关详细的指标信息，请参阅 Amazon CloudWatch 文档中的查看可用指标主题。

period 和 length

period 主要控制用于聚合从 CloudWatch 收集的指标的时间桶宽度。length 控制每次 Alloy 抓取时 CloudWatch 指标回溯的时间。如果同时配置了这两个设置，调用 CloudWatch API 时的时间参数如下

如果同一静态作业或发现作业下的多个指标具有不同的 period 或 length，则配置所有 period 的最小值和所有 length 的最大值。

另一方面，如果未配置 length，则 period 和 length 设置均根据必需的 period 配置属性计算得出。

如果作业（发现或静态）中的所有指标配置了相同的 period 值，则请求 CloudWatch API 获取从抓取时间到过去 period 秒的指标。这些值会导出到 Prometheus。

另一方面，如果单个作业下配置了具有不同 period 的指标，则情况不同。首先，计算两个变量来聚合所有 period：length，取所有 period 的最大值；以及新的 period 值，取所有 period 的最小值。然后，请求 CloudWatch API 获取从 now - length 到 now 的指标，将每个指标按 period 秒的时间聚合为样本。对于每个指标，将最新的样本导出到 CloudWatch。

role

表示一个 AWS IAM Role。如果省略，则使用与环境中配置的凭证对应的 AWS 角色。

当使用一对凭证从不同的 AWS 账户抓取指标时，多个角色会很有用。在这种情况下，为 Alloy 配置不同的角色，使其在调用 AWS API 之前承担该角色。因此，系统中配置的凭证需要具备 asumir 目标角色所需的权限。有关如何配置此功能的更多信息，请参阅 AWS IAM 文档中的授予用户切换角色的权限。

decoupled_scraping

decoupled_scraping 块配置一个可选功能，用于按计划的间隔在后台抓取 CloudWatch 指标。启用此功能后，CloudWatch 指标会按计划的间隔异步收集，而不是在抓取 CloudWatch 组件时同步收集。

解耦抓取功能减少了发送到 AWS 的 API 请求数量。此功能还可防止在收集大量 CloudWatch 指标时组件抓取超时。

导出字段

以下字段会被导出，可由其他组件引用。

例如，可以将 targets 传递给 discovery.relabel 组件来重写目标的标签集，或传递给 prometheus.scrape 组件来收集暴露的指标。

导出的目标使用 run 命令指定的已配置的内存中流量地址。

组件健康状态

只有在配置无效时，prometheus.exporter.cloudwatch 才会被报告为不健康。在这种情况下，导出字段会保留其上一个健康状态值。

调试信息

prometheus.exporter.cloudwatch 不会暴露任何组件特定的调试信息。

调试指标

prometheus.exporter.cloudwatch 不会暴露任何组件特定的调试指标。

示例

有关详细示例，请参阅发现作业和静态作业部分。

发现作业中支持的服务

cloudwatch_exporter 发现作业支持以下 AWS 服务。配置发现作业时，请确保每个 discovery_job 的 type 字段与所需的作业命名空间匹配。

兼容组件

prometheus.exporter.cloudwatch 具有可由以下组件使用的导出项

• 使用 Targets 的组件