Skip to content

Commit d544388

Browse files
placerdaCopilot
andauthored
docs(tutorial): treat App Insights as already-connected by default (#191)
PO running through the tutorial pointed out that section 8's optional App Insights subsection reads as if the resource might not exist, when in fact step 3 (both Path A and Path B) already instructs the reader to attach App Insights to the dev project. Reframe accordingly: - Section 7 callout now leads with 'should already be wired from step 3' and gives a 10-second portal check to confirm. - Section 8 optional subsection now starts with 'you can skip this subsection', shows a 2-row decision table for the verification outcome, and only walks through the override case (a dedicated observability resource) at the end. Adds a 'just click Connect Application Insights in the Foundry portal' fallback for the rare case the resource was not created in step 3. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2a858c0 commit d544388

1 file changed

Lines changed: 51 additions & 26 deletions

File tree

docs/tutorial-prompt-agent-quickstart.md

Lines changed: 51 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -401,21 +401,24 @@ agent: travel-agent:2
401401
dataset: .agentops/data/travel-smoke.jsonl
402402
```
403403
404-
> **App Insights — usually automatic.** You normally do **not** need to
405-
> set `APPLICATIONINSIGHTS_CONNECTION_STRING` by hand. As long as your
406-
> Foundry project has an Application Insights resource connected (see
407-
> the prerequisite at the top of this tutorial), AgentOps runtime
408-
> commands and CI workflows discover the connection string through the
409-
> Azure AI Projects SDK at runtime. Only set it manually if:
404+
> **App Insights — should already be wired from step 3.** Step 3
405+
> (both Path A and Path B) instructs you to attach an Application
406+
> Insights resource to the **dev** Foundry project when you create it,
407+
> so by default this is already done and no manual env variable is
408+
> needed. AgentOps auto-discovers the connection string through the
409+
> Azure AI Projects SDK at runtime.
410410
>
411-
> - your Foundry project has no App Insights connected yet, or
412-
> - your identity cannot read the linked resource at runtime, or
413-
> - you intentionally want to point telemetry at a different App
414-
> Insights resource than the one Foundry has connected.
411+
> Verify in 10 seconds: open <https://ai.azure.com> → **`travel-agent-dev`**
412+
> project → left rail **Tracing** (sometimes under "Observability" /
413+
> "Monitoring"). If you see a linked Application Insights resource with
414+
> a "Copy connection string" button, you are done — skip the optional
415+
> subsection in section 8.
415416
>
416-
> The "where to find it" instructions in section 8 cover the manual
417-
> case. If you are not sure whether you need it, skip ahead to section 8
418-
> and come back if a later step complains about missing telemetry.
417+
> Only set `APPLICATIONINSIGHTS_CONNECTION_STRING` manually if the
418+
> Tracing tab shows "Connect Application Insights" (the resource was
419+
> not created in step 3), if your identity cannot read the linked
420+
> resource at runtime, or if you intentionally want telemetry to go to
421+
> a different resource. Section 8 covers all three cases.
419422

420423
## 8. Add the dev azd environment by hand
421424

@@ -435,23 +438,45 @@ Replace the endpoint with your real dev project endpoint from step 3.
435438

436439
### Optional: also set the dev project's App Insights connection string
437440

438-
You normally do **not** need to add this manually — AgentOps auto-discovers
439-
it through the Azure AI Projects SDK as long as the dev Foundry project
440-
has an Application Insights resource connected (see the prerequisite at
441-
the top of this tutorial). Only add the line below if auto-discovery
442-
fails or you want to override which resource telemetry goes to.
443-
444-
If you do need to set it manually, here is where to find the connection
445-
string. Pick whichever path is easiest for you:
441+
In most walkthroughs you can **skip this subsection**. Step 3 already
442+
attached an Application Insights resource to the **`travel-agent-dev`**
443+
Foundry project (either you did it manually in Path A or the
444+
`microsoft-foundry` skill did it in Path B, following the explicit
445+
"Attach or create an Application Insights resource for telemetry,
446+
starting with the dev project" instruction in the step 3 prompt), and
447+
AgentOps auto-discovers that connection string at runtime through the
448+
Azure AI Projects SDK. No env variable required.
449+
450+
**Quick verification (10 seconds):**
451+
452+
Open <https://ai.azure.com> → **`travel-agent-dev`** project → left
453+
rail **Tracing** (sometimes labeled **Observability** or **Monitoring**
454+
depending on the current portal layout). One of two things will be
455+
true:
456+
457+
| What you see | What it means | What to do |
458+
|---|---|---|
459+
| Linked Application Insights resource with a "Copy connection string" button | The resource exists and is connected. Auto-discovery will pick it up. | **You are done.** Skip the rest of this subsection and continue to section 9. |
460+
| A "Connect Application Insights" prompt or empty Tracing tab | The resource was not created in step 3. | Either connect/create one now (see below), or paste a connection string manually. |
461+
462+
**If the Tracing tab says the resource is missing**, the fastest fix is
463+
to connect one through the Foundry portal itself: click **Connect
464+
Application Insights** on the Tracing tab and either pick an existing
465+
resource or click **Create new** to provision one in the same resource
466+
group as the project. Once it appears as the linked resource, you can
467+
again skip the manual env variable — auto-discovery will pick it up.
468+
469+
**Only if you specifically want to override which resource telemetry
470+
goes to** (advanced case, e.g. you have a dedicated observability
471+
resource group), grab the connection string and paste it into
472+
`.azure\dev\.env`. Pick whichever path is easiest:
446473

447474
**Path A — Azure AI Foundry portal (recommended, no Azure Portal
448475
hopping):**
449476

450-
1. Open <https://ai.azure.com> and select the **dev** project.
451-
2. In the left rail, open **Tracing** (under "Observability" /
452-
"Monitoring", depending on the current portal layout).
453-
3. The page shows the connected Application Insights resource with a
454-
"Copy connection string" button. Copy the value.
477+
1. On the **Tracing** tab of `travel-agent-dev`, click the "Copy
478+
connection string" button next to the linked Application Insights
479+
resource.
455480

456481
**Path B — Azure Portal:**
457482

0 commit comments

Comments
 (0)