concourse/datadog-event-resource

Datadog Event Resource 镜像文档

1. 镜像概述和主要用途

Datadog Event Resource 是一个用于与 Datadog 事件系统交互的工具镜像，主要功能是在自动化流程（如 CI/CD 管道）中获取（Fetch） 或发送（Emit） Datadog 事件。该镜像通常与 Concourse CI/CD 平台集成，作为资源类型（Resource Type）使用，实现事件驱动的流程控制或监控告警通知。

2. 核心功能和特性

核心功能

• 发送事件到 Datadog：支持向 Datadog 事件流推送自定义事件（如构建结果、部署状态等）。
• 从 Datadog 获取事件：支持根据查询条件从 Datadog 检索历史或实时事件，用于触发后续流程。

主要特性

• 与 Datadog API 深度集成，支持标准事件属性（标题、内容、优先级、标签等）。
• 兼容 Concourse CI/CD 管道模型，可作为 in（输入）或 out（输出）资源使用。
• 支持自定义 Datadog 站点（如美国、欧盟、私有部署）的 API 端点配置。

3. 使用场景和适用范围

典型使用场景

• CI/CD 流程监控：构建/部署成功/失败时自动发送事件到 Datadog，实现监控告警。
• 事件驱动的流程触发：根据 Datadog 中特定事件（如告警触发、指标异常）触发 Concourse 管道步骤。
• 事件数据同步：定期从 Datadog 获取事件数据，用于日志聚合或审计。

适用范围

• 使用 Concourse CI/CD 平台的团队。
• 需要与 Datadog 事件系统集成的自动化流程。
• 需实现事件通知、事件驱动调度的场景。

4. 使用方法和配置说明

4.1 资源类型定义

在 Concourse 管道中，需先定义该镜像为资源类型。

yaml
resource_types:
- name: datadog-event
  type: docker-image
  source:
    repository: concourse/datadog-event-resource
    tag: latest  # 建议使用具体版本号，如 v1.2.0

4.2 资源配置

在管道中定义具体资源，配置与 Datadog 的连接信息及事件参数。

基本结构

yaml
resources:
- name: my-datadog-event
  type: datadog-event
  source:
    # Datadog 连接配置
    api_key: ((datadog-api-key))  # Datadog API 密钥（必填）
    app_key: ((datadog-app-key))  # Datadog 应用密钥（必填）
    dd_url: https://api.datadoghq.eu  # 可选，Datadog API URL（默认：https://api.datadoghq.com）

4.3 in 动作（获取事件）

通过 get 步骤从 Datadog 获取事件，结果输出为 JSON 文件供后续步骤使用。

配置参数

示例：获取特定标签的事件

yaml
jobs:
- name: fetch-datadog-events
  plan:
  - get: my-datadog-event
    params:
      query: "tags:ci AND status:error"  # 查询标签包含 "ci" 且状态为 "error" 的事件
      start: "2024-01-01T00:00:00Z"
      limit: 50

4.4 out 动作（发送事件）

通过 put 步骤向 Datadog 发送事件，支持自定义事件内容和属性。

配置参数

示例：发送构建成功事件

yaml
jobs:
- name: notify-build-success
  plan:
  - put: my-datadog-event
    params:
      title: "Concourse 构建成功: prod-api-v1.2.3"
      text: "构建流水线完成，镜像已推送至 registry.example.com/prod-api:v1.2.3"
      priority: "normal"
      tags: ["env:prod", "pipeline:api-build", "version:v1.2.3"]
      alert_type: "success"
      source_type_name: "concourse-ci"

5. 配置参数说明

5.1 Source 配置（资源基础配置）

6. 示例：完整 Concourse Pipeline 配置

yaml
resource_types:
- name: datadog-event
  type: docker-image
  source:
    repository: concourse/datadog-event-resource
    tag: latest

resources:
- name: datadog-events
  type: datadog-event
  source:
    api_key: ((datadog-api-key))
    app_key: ((datadog-app-key))
    dd_url: https://api.datadoghq.eu  # 欧盟站点示例

jobs:
- name: send-and-fetch-events
  plan:
  # 步骤 1: 发送部署事件
  - put: datadog-events
    params:
      title: "生产环境部署: user-service-v2.1.0"
      text: "部署完成，流量已切换至新版本"
      tags: ["env:prod", "service:user-service", "deploy:v2.1.0"]
      alert_type: "success"
  
  # 步骤 2: 获取最近 1 小时的部署事件
  - get: datadog-events
    params:
      query: "tags:deploy AND service:user-service"
      start: "{{ 1h ago | to_unix_time }}"
      limit: 10

7. 参考链接

• 源代码及完整文档：https://github.com/concourse/datadog-event-resource
• Datadog 事件 API 文档：[***]
• Concourse 资源类型文档：[***]