設定 Amazon Q Developer Datadog 外掛程式 - Amazon Q Developer

設定 Amazon Q Developer Datadog 外掛程式

Datadog 是一種監控和安全平台,可提供基礎結構、應用程式和網路監控及分析。如果您使用 Datadog 來監控 AWS 應用程式,則可以在 Amazon Q Developer 聊天中使用 Datadog 外掛程式來存取監控資訊,而不需離開 AWS Management Console。

您可以使用 Datadog 外掛程式來了解 Datadog、了解其如何搭配 AWS 服務運作,以及詢問有關 Datadog 案例和監控的資訊。收到回應後,您可以提出後續問題,包括如何解決問題或取得有關 Datadog 資源的詳細資訊。

若要設定外掛程式,您可以從您的 Datadog 帳戶提供身分驗證憑證,以啟用 Amazon Q 與 Datadog 之間的連線。在您設定外掛程式之後,可以在 Amazon Q 聊天中於問題開頭加上 @datadog,以存取 Datadog 指標。

警告

Amazon Q 中的 Datadog 外掛程式不會偵測 Datadog 使用者許可。當管理員在 AWS 帳戶中設定 Datadog 外掛程式時,該帳戶中具有外掛程式許可的使用者將能夠存取該外掛程式可擷取之 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 會建立新的 AWS Secrets Manager 密碼,供您儲存 Datadog 身分驗證憑證。或者,您可以使用您自行建立的現有密碼。

如果您自行建立密碼,請確定密碼中包含下列憑證且使用下列 JSON 格式:

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

如需建立密碼的詳細資訊,請參閱《AWS Secrets Manager 使用者指南》中的建立密碼

服務角色

若要在 Amazon Q Developer 中設定 Datadog 外掛程式,您需要建立服務角色,以將存取 Secrets Manager 密碼的許可授與 Amazon Q。Amazon Q 會擔任此角色來存取儲存 Datadog 憑證所在的密碼。

在 AWS 主控台中設定外掛程式時,您可以選擇建立新的密碼或使用現有的密碼。如果您建立新的密碼,則會為您建立相關聯的服務角色。如果您使用現有密碼和現有服務角色,請確定您的服務角色包含下列許可,並已附加下列信任政策。所需的服務角色取決於您的密碼加密方法。

如果您的密碼使用 AWS 受管 KMS 金鑰加密,則需要下列 IAM 服務角色:

如果您的密碼使用客戶自管 AWS KMS 金鑰加密,則需要下列 IAM 服務角色:

服務角色需要下列信任政策,才能讓 Amazon Q 擔任服務角色:

注意

codewhisperer 字首是與 Amazon Q Developer 合併之服務的舊名稱。如需詳細資訊,請參閱 Amazon Q Developer 重新命名 - 變更摘要

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 Developer 主控台中設定外掛程式。Amazon Q 會使用儲存在 AWS Secrets Manager 中的憑證來啟用與 Datadog 的互動。

若要設定 Datadog 外掛程式,請完成下列程序:

  1. https://console.aws.amazon.com/amazonq/developer/home 開啟 Amazon Q Developer 主控台

  2. 在 Amazon Q Developer 主控台首頁上,選擇設定

  3. 在導覽列中,選擇外掛程式

  4. 在外掛程式頁面上,選擇 Datadog 面板上的加號。外掛程式組態頁面隨即開啟。

  5. 針對網站 URL,輸入您使用的 Datadog 網站 URL。

  6. 針對設定 AWS Secrets Manager,選擇建立新密碼使用現有密碼。Secrets Manager 密碼是儲存 Datadog 身分驗證憑證的位置。

    如果您建立新密碼,請輸入下列資訊:

    1. 針對 Datadog API 金鑰,輸入 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 許可。

當您將已設定的 Datadog 外掛程式存取權授與 IAM 身分時,此身分就能存取外掛程式可擷取之 Datadog 帳戶中的任何資源。外掛程式不會偵測 Datadog 使用者許可。如果您想要控制外掛程式的存取權,可以藉由在 IAM 政策中指定外掛程式 ARN 來達成此目的。

每次您建立或刪除並重新設定外掛程式時,都會為其指派新的 ARN。如果您在政策中使用外掛程式 ARN,則須在您要將存取權授與新設定的外掛程式時進行更新。

若要尋找 Datadog 外掛程式 ARN,請前往 Amazon Q Developer 主控台中的外掛程式頁面,然後選擇已設定的 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>?