docs(tutorial): explain where to find App Insights connection string#190
Merged
Merged
Conversation
Section 8 told readers to add APPLICATIONINSIGHTS_CONNECTION_STRING to .azure/dev/.env but never said where the string comes from. Reword to: - Lead with the fact that the manual step is optional - AgentOps auto-discovers the connection string through the Azure AI Projects SDK when the dev Foundry project has App Insights connected. - Document three discovery paths for the manual case: Foundry portal (Tracing tab), Azure Portal (App Insights Overview), and az CLI. - Promote the section 7 callout to set the same expectation earlier. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
In the prompt-agent quickstart tutorial, section 8 told readers to paste
into
.azure/dev/.envbut never said where that string actually comes from, nor whether the manual step was even necessary. PO doing a real run-through of the tutorial got stuck here and asked whether this could be done through the portal.What changed
Only
docs/tutorial-prompt-agent-quickstart.md— two sections reworded, no code or template changes.Section 7 callout (right after the wizard) now leads with the fact that the manual step is normally unnecessary because AgentOps auto-discovers the connection string through the Azure AI Projects SDK, and lists the three cases where you would need to set it (no resource attached, identity can't read it, or you want to override the target).
Section 8 (
Add the dev azd environment by hand) keeps the endpoint setup as before, then adds a newOptional: also set the dev project's App Insights connection stringsubsection that gives three concrete discovery paths:az monitor app-insights component show --app <name> --resource-group <rg> --query connectionString -o tsv.The intent is that a reader who is unsure can skip the optional subsection entirely and only come back if a later step complains; a reader who does need it gets a clear answer in whichever portal/CLI they prefer.
Validation
Documentation-only change, no tests required. Reviewed the rendered section in-place to verify it still threads cleanly into the surrounding sections 7, 8 (topology block), and 9 (prompt promotion).