AWS bedrock-agentcore documentation change
Summary
Updated documentation formatting and structure for observability configuration, including renumbering steps, adding example sections, adjusting heading syntax, and minor text corrections (e.g., apostrophe changes).
Security assessment
The changes are purely structural and editorial, focusing on improving readability and documentation formatting. No evidence of addressing a security vulnerability, weakness, or incident. The changes include step renumbering, heading adjustments, and punctuation fixes without introducing or modifying security-related content.
Diff
diff --git a/bedrock-agentcore/latest/devguide/observability-configure.md b/bedrock-agentcore/latest/devguide/observability-configure.md index bb6e6818c..7006d37ff 100644 --- a//bedrock-agentcore/latest/devguide/observability-configure.md +++ b//bedrock-agentcore/latest/devguide/observability-configure.md @@ -53,0 +54,2 @@ Use one of the following procedures to enable Transaction Search. +###### Example + @@ -57 +59 @@ CloudWatch console -###### To enable CloudWatch Transaction Search in the CloudWatch console + 1. ====== To enable CloudWatch Transaction Search in the CloudWatch console @@ -59 +61 @@ CloudWatch console - 1. Open the [CloudWatch](https://console.aws.amazon.com/cloudwatch) console. + 2. Open the [CloudWatch](https://console.aws.amazon.com/cloudwatch) console. @@ -61 +63 @@ CloudWatch console - 2. In the navigation pane, expand **Application Signals (APM)** and choose **Transaction search**. + 3. In the navigation pane, expand **Application Signals (APM)** and choose **Transaction search**. @@ -63 +65 @@ CloudWatch console - 3. Choose **Enable Transaction Search**. + 4. Choose **Enable Transaction Search**. @@ -65 +67 @@ CloudWatch console - 4. Select the checkbox to ingest spans as structured logs. + 5. Select the checkbox to ingest spans as structured logs. @@ -67 +69 @@ CloudWatch console - 5. Choose **Save**. + 6. Choose **Save**. @@ -75 +77 @@ API -###### To enable CloudWatch Transaction Search using an API + 1. ====== To enable CloudWatch Transaction Search using an API @@ -77 +79 @@ API - 1. When using the AWS CLI or an AWS SDK to enable Transaction Search, first configure the necessary permissions to ingest spans in CloudWatch Logs by adding a resource-based policy with [PutResourcePolicy](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html). + 2. When using the AWS CLI or an AWS SDK to enable Transaction Search, first configure the necessary permissions to ingest spans in CloudWatch Logs by adding a resource-based policy with [PutResourcePolicy](https://docs.aws.amazon.com/xray/latest/api/API_PutResourcePolicy.html). @@ -85,3 +86,0 @@ For clarity, the inline JSON policy in this command is shown expanded in the fol -**** - - @@ -114,3 +113 @@ For clarity, the inline JSON policy in this command is shown expanded in the fol - - - 2. Configure the destination of your trace segments using [UpdateTraceSegmentDestination](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html). + 3. Configure the destination of your trace segments using [UpdateTraceSegmentDestination](https://docs.aws.amazon.com/xray/latest/api/API_UpdateTraceSegmentDestination.html). @@ -122 +119 @@ To use the AWS CLI, run the following command. - 3. (Optional) Configure your desired sampling percentage using [UpdateIndexingRule](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html). + 4. (Optional) Configure your desired sampling percentage using [UpdateIndexingRule](https://docs.aws.amazon.com/xray/latest/api/API_UpdateIndexingRule.html). @@ -152 +149 @@ To view this data in the CloudWatch console generative AI observability page and -With AgentCore, you can also view metrics for agents that aren't running in the AgentCore runtime. Additional setup steps are required to configure telemetry outputs for non-AgentCore agents. See the instructions in Enabling observability for agents hosted outside of AgentCore to learn more. +With AgentCore, you can also view metrics for agents that aren’t running in the AgentCore runtime. Additional setup steps are required to configure telemetry outputs for non-AgentCore agents. See the instructions in Enabling observability for agents hosted outside of AgentCore to learn more. @@ -156 +153 @@ To add ADOT support and enable AgentCore observability, follow the steps in the -###### Add observability to your AgentCore agent +**Add observability to your AgentCore agent** @@ -160 +157 @@ To add ADOT support and enable AgentCore observability, follow the steps in the - 2. Add the ADOT SDK and boto3 to your agent's dependencies. For Python, add the following to your `requirements.txt` file: + 2. Add the ADOT SDK and boto3 to your agent’s dependencies. For Python, add the following to your `requirements.txt` file: @@ -216,2 +213 @@ OTEL environment variables - -Replace `<agent-name>` with your agent's name and `<agent-id>` with a unique identifier for your agent. +Replace `<agent-name>` with your agent’s name and `<agent-id>` with a unique identifier for your agent. @@ -221,14 +217 @@ Replace `<agent-name>` with your agent's name and `<agent-id>` with a unique ide -(Optional) For Agent Frameworks other than Strands, LangChain, CrewAI: - -You may need to add an additional SDK and code to send Generative AI semantic conventions telemetry and spans. CloudWatch AgentCore Observability supports use of the following instrumentation libraries in your agent framework: - - * [OpenInference](https://github.com/Arize-ai/openinference) - - * [Openllmetry](https://github.com/traceloop/openllmetry) - - * [OpenLit](https://github.com/openlit/openlit) - - * [Traceloop](https://www.traceloop.com/docs/introduction) - - - +(Optional) For Agent Frameworks other than Strands, LangChain, CrewAI: You may need to add an additional SDK and code to send Generative AI semantic conventions telemetry and spans. CloudWatch AgentCore Observability supports use of the following instrumentation libraries in your agent framework: * [OpenInference](https://github.com/Arize-ai/openinference) * [Openllmetry](https://github.com/traceloop/openllmetry) * [OpenLit](https://github.com/openlit/openlit) * [Traceloop](https://www.traceloop.com/docs/introduction) @@ -248 +231 @@ To propagate session ID, you need to invoke using session identifier in the OTEL -When you create an AgentCore runtime resource (agent), by default, AgentCore runtime creates a CloudWatch log group for the service-provided logs. However, for memory, gateway, and built-in tool resources, AgentCore doesn't configure log destinations for you automatically. +When you create an AgentCore runtime resource (agent), by default, AgentCore runtime creates a CloudWatch log group for the service-provided logs. However, for memory, gateway, and built-in tool resources, AgentCore doesn’t configure log destinations for you automatically. @@ -256 +239 @@ To learn more about the log data output by AgentCore for memory and gateway reso -For built-in tool resources, the AgentCore service doesn't provide logs by default, but you can output your own logs from your code. If you supply your own log outputs, you need to manually configure log destinations to store this data. +For built-in tool resources, the AgentCore service doesn’t provide logs by default, but you can output your own logs from your code. If you supply your own log outputs, you need to manually configure log destinations to store this data. @@ -263,0 +247,2 @@ To configure log destinations for memory or gateway logs in the AgentCore consol +###### Example + @@ -267 +252 @@ Memory -###### To configure log delivery for memory resources (console) + 1. ====== To configure log delivery for memory resources (console) @@ -269 +254 @@ Memory - 1. Open the [Memory](https://console.aws.amazon.com/bedrock-agentcore/memory) page in the AgentCore console. + 2. Open the [Memory](https://console.aws.amazon.com/bedrock-agentcore/memory) page in the AgentCore console. @@ -271 +256 @@ Memory - 2. In the **Memory** pane, select the memory you want to configure a log destination for. + 3. In the **Memory** pane, select the memory you want to configure a log destination for. @@ -273 +258 @@ Memory - 3. Scroll down to the **Log delivery** pane and choose **Add**. + 4. Scroll down to the **Log delivery** pane and choose **Add**. @@ -275 +260 @@ Memory - 4. From the dropdown list, select the type of log destination you want to add (CloudWatch Logs group, Amazon S3 bucket, or Amazon Data Firehose). + 5. From the dropdown list, select the type of log destination you want to add (CloudWatch Logs group, Amazon S3 bucket, or Amazon Data Firehose). @@ -277 +262 @@ Memory - 5. For **Log type** , select **APPLICATION_LOGS**. + 6. For **Log type** , select **APPLICATION_LOGS**. @@ -279 +264 @@ Memory - 6. For Amazon S3 and Firehose destinations, enter a **Delivery destination ARN**. For CloudWatch Logs, the **Destination log group** is already populated with a default value. + 7. For Amazon S3 and Firehose destinations, enter a **Delivery destination ARN** . For CloudWatch Logs, the **Destination log group** is already populated with a default value. @@ -281 +266 @@ Memory - 7. (Optional) For CloudWatch Logs destinations, to change the default log group, enter a new log group name or select an existing log group under **Destination log group**. + 8. (Optional) For CloudWatch Logs destinations, to change the default log group, enter a new log group name or select an existing log group under **Destination log group**. @@ -283 +268 @@ Memory - 8. (Optional) To change the fields that are captured in each log record or the logs' output format, expand **Additional settings -_optional_** , and modify the **Field selection** , **Output format** , and **Field delimiter** to your desired configuration. + 9. (Optional) To change the fields that are captured in each log record or the logs' output format, expand **Additional settings - optional** , and modify the **Field selection** , **Output format** , and **Field delimiter** to your desired configuration. @@ -285 +270 @@ Memory - 9. Choose **Add**. + 10. Choose **Add**. @@ -293 +278 @@ Gateway -###### To configure log delivery for gateway resources (console) + 1. ====== To configure log delivery for gateway resources (console) @@ -295 +280 @@ Gateway - 1. Open the [Gateways](https://console.aws.amazon.com/bedrock-agentcore/toolsAndGateways) page in the AgentCore console. + 2. Open the [Gateways](https://console.aws.amazon.com/bedrock-agentcore/toolsAndGateways) page in the AgentCore console. @@ -297 +282 @@ Gateway - 2. In the **Gateways** pane, select the gateway you want to configure a log destination for. + 3. In the **Gateways** pane, select the gateway you want to configure a log destination for. @@ -299 +284 @@ Gateway - 3. Scroll down to the **Log delivery** pane and choose **Add**. + 4. Scroll down to the **Log delivery** pane and choose **Add**. @@ -301 +286 @@ Gateway - 4. From the dropdown list, select the type of log destination you want to add (CloudWatch Logs group, Amazon S3 bucket, or Amazon Data Firehose). + 5. From the dropdown list, select the type of log destination you want to add (CloudWatch Logs group, Amazon S3 bucket, or Amazon Data Firehose). @@ -303 +288 @@ Gateway - 5. For Amazon S3 and Firehose destinations, enter a **Delivery destination ARN**. For CloudWatch Logs, the **Destination log group** is already populated with a default value. + 6. For Amazon S3 and Firehose destinations, enter a **Delivery destination ARN** . For CloudWatch Logs, the **Destination log group** is already populated with a default value. @@ -305 +290 @@ Gateway - 6. (Optional) For CloudWatch Logs destinations, to change the default log group, enter a new log group name or select an existing log group under **Destination log group**. + 7. (Optional) For CloudWatch Logs destinations, to change the default log group, enter a new log group name or select an existing log group under **Destination log group**. @@ -307 +292 @@ Gateway - 7. (Optional) To change the fields that are captured in each log record or the logs' output format, expand **Additional settings -_optional_** , and modify the **Field selection** , **Output format** , and **Field delimiter** to your desired configuration. + 8. (Optional) To change the fields that are captured in each log record or the logs' output format, expand **Additional settings - optional** , and modify the **Field selection** , **Output format** , and **Field delimiter** to your desired configuration. @@ -309 +294 @@ Gateway - 8. Choose **Add**. + 9. Choose **Add**. @@ -317 +302 @@ Runtime -###### To configure log delivery for agent runtime resources (console) + 1. ====== To configure log delivery for agent runtime resources (console) @@ -319 +304 @@ Runtime - 1. Open the [Agent Runtime](https://console.aws.amazon.com/bedrock-agentcore/agents) page in the AgentCore console. + 2. Open the [Agent Runtime](https://console.aws.amazon.com/bedrock-agentcore/agents) page in the AgentCore console. @@ -321 +306 @@ Runtime - 2. In the **Runtime agents** pane, select the runtime agent for which you want to configure a log destination. + 3. In the **Runtime agents** pane, select the runtime agent for which you want to configure a log destination. @@ -323 +308 @@ Runtime - 3. Scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. + 4. Scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. @@ -325 +310 @@ Runtime - 4. Configure the following log delivery details and then choose **Add** : + 5. Configure the following log delivery details and then choose **Add** : @@ -335 +320 @@ Runtime - 5. Verify that the log delivery status is set to **Delivery active**. + 6. Verify that the log delivery status is set to **Delivery active**. @@ -343 +328 @@ Built-in tools -###### To configure log delivery for built-in tools resources (console) + 1. ====== To configure log delivery for built-in tools resources (console) @@ -345 +330 @@ Built-in tools - 1. Open the [Built-in tools](https://console.aws.amazon.com/bedrock-agentcore/builtInTools) page in the AgentCore console. + 2. Open the [Built-in tools](https://console.aws.amazon.com/bedrock-agentcore/builtInTools) page in the AgentCore console. @@ -347 +332 @@ Built-in tools - 2. In the **Built-in tools** pane, either in the **Code interperter tools** or the **Browser tools** tab, select the code interpreter tool or browser tool for which you want to configure a log destination. + 3. In the **Built-in tools** pane, either in the **Code interperter tools** or the **Browser tools** tab, select the code interpreter tool or browser tool for which you want to configure a log destination. @@ -349 +334 @@ Built-in tools - 3. Scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. + 4. Scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. @@ -351 +336 @@ Built-in tools - 4. Configure the following log delivery details and then choose **Add** : + 5. Configure the following log delivery details and then choose **Add** : @@ -361 +346 @@ Built-in tools - 5. Verify that the log delivery status is set to **Delivery active**. + 6. Verify that the log delivery status is set to **Delivery active**. @@ -369 +354 @@ Identity -WorkloadIdentity log delivery enablement is handled at the associated resource level, including agent runtime or agent gateway resources. + 1. WorkloadIdentity log delivery enablement is handled at the associated resource level, including agent runtime or agent gateway resources. @@ -371 +356 @@ WorkloadIdentity log delivery enablement is handled at the associated resource l -###### To configure WorkloadIdentity log delivery for associated resources (console) +**To configure WorkloadIdentity log delivery for associated resources (console)** @@ -373 +358 @@ WorkloadIdentity log delivery enablement is handled at the associated resource l - 1. Open either the [Gateway](https://console.aws.amazon.com/bedrock-agentcore/toolsAndGateways) or the [Agent Runtime](https://console.aws.amazon.com/bedrock-agentcore/agents) page in the AgentCore console and select an agent or a gateway for which you want to enable WorkloadIdentity logging. + 2. Open either the [Gateway](https://console.aws.amazon.com/bedrock-agentcore/toolsAndGateways) or the [Agent Runtime](https://console.aws.amazon.com/bedrock-agentcore/agents) page in the AgentCore console and select an agent or a gateway for which you want to enable WorkloadIdentity logging. @@ -375 +360 @@ WorkloadIdentity log delivery enablement is handled at the associated resource l - 2. In the **Identity** tab, scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. + 3. In the **Identity** tab, scroll down to the **Log delivery** pane and from the **Add** drop-down, choose the **Logging destination** \- either Amazon CloudWatch Logs, Amazon S3, or Amazon Data Firehose. @@ -377 +362 @@ WorkloadIdentity log delivery enablement is handled at the associated resource l - 3. Configure the following log delivery details and then choose **Add** : + 4. Configure the following log delivery details and then choose **Add** : @@ -387 +372 @@ WorkloadIdentity log delivery enablement is handled at the associated resource l - 4. Verify that the log delivery status is set to **Delivery active**. + 5. Verify that the log delivery status is set to **Delivery active**. @@ -395,0 +381,2 @@ This section describes how to enable trace delivery to CloudWatch to track the f +###### Example + @@ -399 +386 @@ Memory -###### To configure tracing for memory resources (console) + 1. ====== To configure tracing for memory resources (console) @@ -401 +388 @@ Memory - 1. Open the [Memory](https://console.aws.amazon.com/bedrock-agentcore/memory) page in the AgentCore console.