{Cognitive Services} az cognitiveservices agent logs show: Support console log streaming
#32701
+655
−31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…agent logs show` Add console log streaming commands and options for hosted agents: - Add new `az cognitiveservices agent logs show` command to stream console output (stdout/stderr) or system events from agent containers - Add --show-logs flag to `az cognitiveservices agent create` to stream logs during deployment for troubleshooting - Add --show-logs and --timeout flags to `az cognitiveservices agent start` to stream logs during startup Implementation details: - Implement _stream_agent_logs() using HTTP streaming with Bearer auth - Create _BackgroundLogStreamer context manager for reusable log streaming - Add retry logic to handle container startup delays - Extract helper functions for auth and URL building - Add unit tests for new functionality
eamonoreilly
requested review from
jiasli,
jsntcy and
kairu-ms
as code owners
️✔️AzureCLI-FullTest
|
|
| rule | cmd_name | rule_message | suggest_message |
|---|---|---|---|
| cognitiveservices agent create | cmd cognitiveservices agent create added parameter show_logs |
||
| cognitiveservices agent logs | sub group cognitiveservices agent logs added |
||
| cognitiveservices agent start | cmd cognitiveservices agent start added parameter show_logs |
||
| cognitiveservices agent start | cmd cognitiveservices agent start added parameter timeout |
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
requested review from
wangzelin007 and
yonzhan
microsoft-github-policy-service
bot
added
the
Cognitive Services
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds console log streaming capabilities for hosted Cognitive Services agents in Azure CLI, enabling users to stream container logs for troubleshooting during deployment and startup, and via a dedicated logs command.
Changes:
- Introduces
_stream_agent_logsand_BackgroundLogStreamerto implement HTTP log streaming with retry logic, plus a newagent_logs_showcustom command andcognitiveservices agent logscommand group. - Extends
agent_createandagent_startwith--show-logsand--timeoutoptions, wiring them into_deploy_agent_versionand background log streaming for richer troubleshooting during deployment/startup. - Adds CLI argument wiring, help text, and both unit and live scenario tests to cover new signatures, options, and end-to-end log streaming behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
src/azure-cli/azure/cli/command_modules/cognitiveservices/custom.py |
Implements log streaming helpers, background log streamer context manager, integrates streaming into agent_create deployment path and agent_start, and adds the agent_logs_show handler. |
src/azure-cli/azure/cli/command_modules/cognitiveservices/tests/latest/test_agent.py |
Adds unit tests for new function signatures and live scenario tests for agent logs show and agent start --show-logs. |
src/azure-cli/azure/cli/command_modules/cognitiveservices/commands.py |
Registers the new cognitiveservices agent logs show custom command on the cf_ai_projects client. |
src/azure-cli/azure/cli/command_modules/cognitiveservices/_params.py |
Wires new --show-logs, --timeout, and log-streaming-specific arguments (--type, --tail, --follow) into the corresponding commands. |
src/azure-cli/azure/cli/command_modules/cognitiveservices/_help.py |
Updates help text and examples for agent create, agent start, and adds help for the new agent logs group and agent logs show command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Distinguish transient errors (ConnectionError, Timeout) from unexpected errors - Track last error and show warning to user after all retries exhausted - Provides actionable feedback when --show-logs cannot establish connection
necusjz
changed the title
az cognitiveservices agent logs showaz cognitiveservices agent logs show: Support console log streaming
necusjz
approved these changes
Jan 27, 2026
kairu-ms
approved these changes
Jan 27, 2026
necusjz
changed the title
az cognitiveservices agent logs show: Support console log streamingaz cognitiveservices agent logs show: Support console log streaming
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add console log streaming commands and options for hosted agents:
az cognitiveservices agent logs showcommand to stream console output (stdout/stderr) or system events from agent containersaz cognitiveservices agent createto stream logs during deployment for troubleshootingaz cognitiveservices agent startto stream logs during startupImplementation details:
Related command
az cognitiveservices agent logs showaz cognitiveservices agent createaz cognitiveservices agent startDescription
Add console log streaming support for hosted agents in AI Foundry. This enables users to troubleshoot agent startup issues and monitor agent behavior by streaming container logs in real-time.
Key features:
az cognitiveservices agent logs showcommand to stream console output (stdout/stderr) or system events from agent containers--show-logsflag onaz cognitiveservices agent createto stream logs during deployment--show-logsand--timeoutflags onaz cognitiveservices agent startto stream logs during startupTesting Guide
History Notes
[Cognitive Services]
az cognitiveservices agent logs show: Add console log streaming for hosted agents[Cognitive Services]
az cognitiveservices agent create: Add--show-logsflag for deployment troubleshooting[Cognitive Services]
az cognitiveservices agent start: Add--show-logsand--timeoutflagsThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.