Add Streaming Token Tracking (#208)

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>

Author: simonkurtz-MSFT

.github/copilot-instructions.md

@@ -10,3 +10,12 @@ applyTo: '**/*.json'
 - If $schema is defined, ensure that all changes are validated.
 - Use two spaces for indentation. Do not use tabs.
 - Sort properties alphabetically.
+
+## $schema URLs
+
+- Always reference JSON schemas from `raw.githubusercontent.com`, never from `github.com/.../blob/...`. The `blob/` URL serves an HTML preview page, not the schema JSON, so editors and validators cannot fetch or validate against it.
+- Use the `refs/heads/<branch>` form (or a pinned tag/commit) so the URL is unambiguous and stable.
+- Example — Azure Monitor Workbook:
+  - ✅ `https://raw.githubusercontent.com/Microsoft/Application-Insights-Workbooks/refs/heads/master/schema/workbook.json`
+  - ❌ `https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json`
+- When adding or updating a `$schema` value in any JSON file, convert any `github.com/<org>/<repo>/blob/<ref>/<path>` URL to `raw.githubusercontent.com/<org>/<repo>/refs/heads/<ref>/<path>` (or the appropriate `refs/tags/<tag>` form for pinned versions).

.github/json.instructions.md

@@ -1,6 +1,6 @@
 ---
 description: 'Python coding conventions and guidelines'
-applyTo: '**/*.py'
+applyTo: '**/*.py,**/*.ipynb'
 ---
 
 # Copilot Instructions (Python)
@@ -18,9 +18,10 @@ This ensures all code changes comply with the project's linting standards from t
 ## Ruff Expectations
 
 - Use explicit imports (avoid `from module import *`), especially in notebooks, to prevent `F403/F405`.
-- Keep lines within the configured length limit (see `pyproject.toml`), and wrap long strings or calls.
+- Keep lines within the configured length limit (**150 characters** per `pyproject.toml`), and wrap long strings or calls. **Inline comments on assignments are the most commonly missed line-length offender** — when `var = value  # comment` would exceed 150 chars, move the comment to its own line(s) above the assignment.
 - Avoid f-strings without placeholders (e.g., `F541`).
 - **Ruff gap:** `PLC0415` (`import-outside-toplevel`) only flags imports inside functions and classes. It does **not** flag imports inside module-level `if` / `else` / `try` blocks. Ruff will not catch those, so the top-of-file import rule below must be enforced manually.
+- **Notebook cells follow the same rules** as `.py` files except for `F821` and `F401` (suppressed via per-file-ignores because notebook cells share kernel state). Line-length, quote style, and import placement still apply. After editing notebook cells, run `get_errors` and resolve any ruff `compileError` entries; ignore only the `"X" is not defined` cross-cell false positives.
 
 ## Goals
 

.github/python.instructions.md

@@ -189,6 +189,8 @@ Assert that the deployment was successful by making calls to the deployed APIs.
 
 ### Cell 6: Python - Verification
 
+Use `ApimRequests` and `ApimTesting` for structured test verification with verbose logging. If the sample also needs **traffic generation loops** (multi-caller simulation, load generation, etc.), add separate cells that use `requests.Session()` instead — see the "Testing and Traffic Generation" section in `copilot-instructions.md` for the session pattern.
+
 ```python
 from apimrequests import ApimRequests
 from apimtesting import ApimTesting
@@ -213,6 +215,8 @@ print_ok('All done!')
 
 ## Step 5: Create main.bicep
 
+> **Always reuse infrastructure-provided resources.** The infrastructure deployment already creates an APIM service, a Log Analytics workspace, and an Application Insights component (the latter wired to APIM as the `apim-logger`). Sample `main.bicep` files must consume these via `existing` resource references — **do not** redeploy them. Only deploy a sample-local copy of one of these resources when the sample has a documented reason that satisfies one of the exceptions in `.github/copilot-instructions.md` ("Always reuse infrastructure-provided resources"). When wiring API-level diagnostics, omit the `apimLoggerName` parameter so APIs inherit the infrastructure logger automatically.
+
 Use this template:
 
 ```bicep

.github/skills/sample-creator/SKILL.md

@@ -30,6 +30,10 @@ labs-in-progress/
 .env*
 !.env-example
 
+# Local-only ground-truth / sample-run artefacts (gitignored). Used by samples to
+# persist run data such as request counts so users can cross-check workbook output.
+*.local.json
+
 # Coverage data and reports
 .coverage
 .coverage.*

.gitignore

@@ -10,6 +10,14 @@ This repository provides resources to deploy Azure API Management infrastructure
 - **Samples**: Real-world policy examples that can be deployed to any supported infrastructure
 - **Shared Resources**: Reusable Bicep modules, Python helpers, and policy templates
 
+## Accessibility Baseline
+
+All repository contributions should treat accessibility as a first-class quality requirement.
+
+- Use WCAG 2.0 AA as the default baseline for user-facing outputs, including documentation, web content, workbook/dashboard visuals, and presentation materials.
+- Do not rely on color alone to convey meaning; pair color cues with labels, text, icons, or structure.
+- Preserve or improve contrast and readability when editing existing assets.
+
 ## Repository Structure
 
 ```text
@@ -120,6 +128,7 @@ Skills provide templates, patterns, and step-by-step workflows.
 - **Folder**: kebab-case (e.g., `oauth-validation`, `rate-limiting`)
 - **API prefix**: Short, unique, with trailing hyphen (e.g., `oauth-`, `rl-`)
 - **Policy files**: Descriptive, kebab-case (e.g., `token-validation.xml`)
+- **Workbook files**: Azure Monitor Workbook JSON files use the `<name>.workbook.json` suffix (e.g., `costing.workbook.json`). One workbook per file, stored in the sample folder, loaded into Bicep via `loadJsonContent('<name>.workbook.json')`, and pushed back to Azure via a sample-local `update-workbook.ps1`. See the *Azure Monitor Workbook File Convention* section in `.github/copilot-instructions.md`.
 - **Admin APIs**: Samples needing admin/operational endpoints use path `{api_prefix}admin` with `subscriptionRequired=True` and kebab-case operation paths (e.g., `/load-cache`)
 
 ### Infrastructure Constants

AGENTS.md

@@ -67,7 +67,7 @@ It's quick and easy to get started!
 | [AuthX][sample-authx]                                       | Authentication and role-based authorization in a mock HR API.                                                       | All infrastructures           |
 | [AuthX Pro][sample-authx-pro]                               | Authentication and role-based authorization in a mock product with multiple APIs and policy fragments.              | All infrastructures           |
 | [Azure Maps][sample-azure-maps]                             | Proxying calls to Azure Maps with APIM policies.                                                                    | All infrastructures           |
-| [Costing][sample-costing]                                   | Track and allocate API costs per business unit using APIM subscriptions, Entra ID application tracking, and AI Gateway token/PTU tracking via Log Analytics and Cost Management. | All infrastructures           |
+| [Costing][sample-costing]                                   | Track and allocate API costs per business unit using APIM subscriptions, Entra ID application tracking, and AI Gateway token/PTU tracking including streaming (SSE) token usage, which is not simple to capture correctly in APIM. | All infrastructures           |
 | [Dynamic CORS][sample-dynamic-cors]                         | Dynamic per-API CORS origin validation using custom policy fragments and a maintainable origin mapping. | All infrastructures           |
 | [Egress Control][sample-egress-control]                     | Control APIM outbound internet traffic by routing it through a Network Virtual Appliance (NVA) in a hub/spoke topology. | appgw-apim, appgw-apim-pe     |
 | [General][sample-general]                                   | Basic demo of APIM sample setup and policy usage.                                                                   | All infrastructures           |

README.md

@@ -1117,8 +1117,8 @@ <h4>Azure Maps</h4>
         <p>Proxying calls to Azure Maps through APIM policies.</p>
       </div>
       <div class="arch-card">
-        <h4>Costing &amp; Showback</h4>
-        <p>Track API costs per business unit via subscriptions, Entra ID apps &amp; AI Gateway tokens.</p>
+        <h4>Costing</h4>
+        <p>Track API costs per business unit via subscriptions, Entra ID apps, and AI Gateway tokens, including streaming token usage (not simple to capture correctly in APIM).</p>
       </div>
       <div class="arch-card">
         <h4>Dynamic CORS</h4>

assets/APIM-Samples-Slide-Deck.html

@@ -447,7 +447,7 @@ <h3>Azure Maps</h3>
 
           <a class="sample-card" href="https://github.com/Azure-Samples/Apim-Samples/tree/main/samples/costing" target="_blank" rel="noopener">
             <h3>Costing</h3>
-            <p>Track and allocate API costs per business unit using subscriptions, Entra ID application tracking, and AI Gateway token/PTU tracking via Log Analytics and Cost Management.</p>
+            <p>Track and allocate API costs per business unit using subscriptions, Entra ID application tracking, and AI Gateway token/PTU tracking including streaming (SSE) token usage, which is not simple to capture correctly in APIM.</p>
             <span class="infra-tag">All infrastructures</span>
           </a>