配置 Amazon Q 开发者Datadog插件 - Amazon Q 开发者版
先决条件机密和服务角色配置Datadog插件配置用户权限使用Datadog插件聊天

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

配置 Amazon Q 开发者Datadog插件

Datadog是一个监控和安全平台，提供基础架构、应用程序和网络监控和分析。如果您使用Datadog监控 AWS 应用程序，则可以使用 Amazon Q Developer 聊天中的Datadog插件访问监控信息，而无需离开 AWS Management Console。

您可以使用该Datadog插件来了解Datadog、了解它如何与 AWS 服务配合使用，并询问您的Datadog案例和监视器。收到回复后，您可以提出后续问题，包括如何解决问题或有关Datadog资源的详细信息。

要配置插件，您需要提供Datadog账户中的身份验证凭证，以启用 Amazon Q 和之间的连接Datadog。配置插件后，您可以通过在 Amazon Q 聊天中将问题@datadog添加到问题的开头来访问Datadog指标。

警告

DatadogAmazon Q 中的Datadog插件无法检测到用户权限。当管理员在账户中配置Datadog插件时，在该 AWS 账户中拥有插件权限的用户可以访问该账户中可由该Datadog插件检索的任何资源。

您可以配置 IAM 策略来限制用户可以访问哪些插件。有关更多信息，请参阅 配置用户权限。

先决条件

添加权限

要配置插件，需要以下管理员级别的权限：

获取凭证

在开始之前，请记下您Datadog账户中的以下信息。配置插件时，这些身份验证凭据将存储在 AWS Secrets Manager 密钥中。

  • 网站参数-您使用的Datadog网站参数。例如 us3.datadoghq.com。有关更多信息，请参阅Datadog文档中的Datadog网站入门。

  • API 密钥和应用程序密钥 — 允许 Amazon Q 调用 Datadog API 来访问事件和指标的访问密钥。您可以在Datadog账户的 “组织设置” 下找到这些内容。有关更多信息，请参阅Datadog文档中的 API 和应用程序密钥。

机密和服务角色

AWS Secrets Manager 秘密

配置插件时，Amazon Q 会为您创建一个用于存储Datadog身份验证凭证的新 AWS Secrets Manager 密钥。或者，您可以使用自己创建的现有密钥。

如果您自己创建密钥，请确保它包含以下凭证并使用以下 JSON 格式：

{ 
   "ApiKey": "<your-api-key>", 
   "AppKey": "<your-applicaiton-key>" 
}

有关创建密钥的更多信息，请参阅AWS Secrets Manager 用户指南中的创建密钥。

服务角色

要在 Amazon Q Developer 中配置Datadog插件，您需要创建一个服务角色来授予 Amazon Q 访问您的 Secrets Manager 密钥的权限。Amazon Q 扮演此角色来访问存储您的Datadog凭证的密钥。

在 AWS 控制台中配置插件时，您可以选择创建新密钥或使用现有密钥。如果您创建了新密钥，则会为您创建关联的服务角色。如果您使用现有密钥和现有服务角色，请确保您的服务角色包含以下权限并附加了以下信任策略。所需的服务角色取决于您的秘密加密方法。

如果您的密钥使用 AWS 托管 KMS 密钥加密，则需要以下 IAM 服务角色：

JSON
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetSecretValue"
            ],
            "Resource": [
                "arn:aws:secretsmanager:us-east-1:{{your-account-id}}:secret:[[secret-id]]"
            ]
        }
    ]
}
显示更多显示更少

如果您的密钥使用客户托管密 AWS KMS 钥加密，则需要以下 IAM 服务角色：

JSON
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "secretsmanager:GetSecretValue"
            ],
            "Resource": "arn:aws:secretsmanager:us-east-1:{{accountId}}:secret:{{secretId}}"
        },
        {
            "Effect": "Allow",
            "Action": [
                "kms:Decrypt"
            ],
            "Resource": "arn:aws:kms:us-east-1:{{accountId}}:key/{{keyId}}",
            "Condition": {
                "StringEquals": {
                    "kms:ViaService": "secretsmanager.us-east-1.amazonaws.com"
                }
            }
        }
    ]
}
显示更多显示更少

要允许 Amazon Q 担任服务角色，该服务角色需要以下信任策略：

注意

codewhisperer 前缀是与 Amazon Q Developer 合并前的服务的旧名称。有关更多信息，请参阅 Amazon Q 开发者版重命名：变更摘要。

JSON
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "q.amazonaws.com"
      },
      "Action": ["sts:AssumeRole", "sts:SetContext"],
      "Condition": {
        "StringEquals": {
          "aws:SourceAccount": "{{accountId}}",
          "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/{{profileId}}"
        }
      }
    }
  ]
}
显示更多显示更少

有关服务角色的更多信息，请参阅《AWS Identity and Access Management 用户指南》中的创建角色以向 AWS 服务委派权限。

配置Datadog插件

您可以在 Amazon Q 开发者控制台中配置插件。Amazon Q 使用存储在中的凭证 AWS Secrets Manager 来实现与的交互Datadog。

要配置Datadog插件，请完成以下步骤：

  1. 在开发者/主页打开 Amazon Q https://console.aws.amazon.com/amazonq/开发者控制台

  2. 在 Amazon Q 开发者控制台主页上，选择设置。

  3. 在导航栏中，选择插件。

  4. 在插件页面上，选择Datadog面板上的加号。插件配置页面打开。

  5. 在 “站点 URL” 中，输入您使用的Datadog网站的 URL。

  6. 在 “配置” AWS Secrets Manager中，选择 “创建新密钥” 或 “使用现有密钥”。Secrets Manager 密钥是存储您的Datadog身份验证凭据的地方。

    如果您创建了新密钥，请输入以下信息：

    1. 对于 DatadogAPI 密钥，请输入您Datadog组织的 API 密钥。

    2. 对于Datadog应用程序密钥，请输入您Datadog账户的应用程序密钥。

    3. 将创建一个服务角色，Amazon Q 将使用该角色来访问存储您的Datadog凭证的密钥。请勿编辑为您创建的服务角色。

    如果您使用现有密钥，请从密钥下拉菜单中选择一个AWS Secrets Manager 密钥。该密钥应包含上一步中指定的Datadog身份验证凭证。

    有关所需凭证的更多信息，请参阅获取凭证 。

  7. 对于配置 AWS IAM 服务角色，选择创建新的服务角色或使用现有服务角色。

    注意

    如果您在步骤 6 中选择了创建新密钥，则无法使用现有的服务角色。将为您创建一个新角色。

    如果您创建新的服务角色，则会创建一个服务角色，Amazon Q 将使用该角色来访问存储您的Datadog凭证的密钥。请勿编辑为您创建的服务角色。

    如果您使用现有的服务角色，请从出现的下拉菜单中选择一个角色。确保您的服务角色具有中定义的权限和信任策略服务角色。

  8. 选择 Save configuration。

  9. Datadog插件面板出现在插件页面的已配置插件部分后，用户就可以访问该插件了。

如果要更新插件的凭据，则必须删除当前插件并配置一个新插件。删除插件会删除之前的所有规范。每当您配置新插件时，都会生成一个新的插件 ARN。

配置用户权限

要使用插件，需要以下权限：

  • 在控制台中与 Amazon Q 聊天的权限。有关授予聊天所需权限的 IAM 策略示例，请参阅允许用户与 Amazon Q 聊天。

  • q:UsePlugin 权限。

当您向 IAM 身份授予对已配置Datadog插件的访问权限时，该身份将获得该插件可检索的Datadog账户中任何资源的访问权限。 Datadog插件未检测到用户权限。如果您想控制对插件的访问权限，可以通过在 IAM 策略中指定插件 ARN 来实现。

每次创建、删除和重新配置插件时，都会为其分配一个新的 ARN。如果您在策略中使用插件 ARN，则需要对其进行更新，才能授予对新配置的插件的访问权限。

要找到Datadog插件 ARN，请前往 Amazon Q 开发者控制台中的插件页面，然后选择已配置Datadog的插件。在插件详情页面上，复制插件 ARN。您可以将此 ARN 添加到策略中，以允许或拒绝对插件的访问。Datadog

如果您创建了控制Datadog插件访问权限的策略，请在策略中Datadog为插件提供者指定。

有关控制插件访问的 IAM 策略的示例，请参阅允许用户使用来自一个提供商的插件聊天。

使用Datadog插件聊天

要使用该Datadog插件，请在有关Datadog您的 AWS 应用程序监视器和案例的问题开头输入@datadog。后续问题或对来自 Amazon Q 的问题的回复还必须包括@datadog。

以下是一些示例用例和相关问题，您可以询问以充分利用 Amazon Q Datadog 插件：

  • 了解如何在 AWS 工作负载中使用Datadog功能 — 询问Datadog功能如何与某些 AWS 服务配合使用。Amazon Q 可能会要求您提供更多信息，说明您正在尝试采取哪些措施来提供最佳答案。

    • @datadog how do I use APM on EC2?

  • 检索和汇总案例和监视器 — 询问特定案例或监视器，或指定属性以获取有关监视器和案例的信息，例如创建日期、状态或作者。有关属性的更多信息，请参阅Datadog文档中的属性。

    • @datadog summarize the global outage case

    • @datadog summarize my top cases

  • 检查处于警报状态的显示器 — 让 Amazon Q Datadog 插件查找处于警报状态的 AWS 应用程序监视器。您可以继续询问有关它列出的显示器的问题。

    • @datadog what monitors are in alarm?

    • @datadog what is the status for monitor <monitor ID>?