Add telemetry for wta#89
Conversation
There was a problem hiding this comment.
Pull request overview
Adds ETW-based telemetry instrumentation to the WTA (Windows Terminal Agent) Rust tool, emitting new events around agent prompt/response lifecycle and autofix outcomes, with build-time provider-group GUID injection for internal builds.
Changes:
- Introduces an ETW provider template + thin wrapper module for emitting WTA telemetry events.
- Emits new telemetry at key ACP client and UI action points (prompt sent, response received, response action executed, autofix resolution).
- Adds build-script logic to generate the provider source with optional provider-group GUID injection, plus new
win_etw_*dependencies.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/wta/src/telemetry.rs | Adds convenience wrappers around the generated ETW provider and tracks current agent id. |
| tools/wta/src/telemetry_template.rs | Defines the ETW provider + event schema used to generate the concrete provider at build time. |
| tools/wta/src/protocol/acp/client.rs | Wires telemetry into ACP prompt dispatch/completion and sets agent identity for events. |
| tools/wta/src/main.rs | Initializes telemetry during the main TUI entrypoints. |
| tools/wta/src/app.rs | Emits telemetry for autofix resolution and executing recommended actions. |
| tools/wta/Cargo.toml | Adds win_etw_macros and win_etw_provider dependencies. |
| tools/wta/Cargo.lock | Locks newly introduced transitive dependencies for ETW support. |
| tools/wta/build.rs | Generates telemetry_generated.rs and injects provider-group GUID when configured. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"] } | ||
| tracing-appender = "0.2" | ||
| which = "7" | ||
| win_etw_macros = "0.1.8" |
| tracing-appender = "0.2" | ||
| which = "7" | ||
| win_etw_macros = "0.1.8" | ||
| win_etw_provider = "0.1.8" |
| // and use `keyword = 0x0` (OSS placeholder — internal builds override via | ||
| // the crate feature / build-system injection). | ||
|
|
||
| use win_etw_macros::trace_logging_provider; |
This comment has been minimized.
This comment has been minimized.
@check-spelling-bot Report
|
| Dictionary | Entries | Covers | Uniquely |
|---|---|---|---|
| cspell:csharp/csharp.txt | 32 | 2 | 2 |
| cspell:aws/aws.txt | 232 | 2 | 2 |
| cspell:fonts/fonts.txt | 536 | 1 | 1 |
Consider adding to the extra_dictionaries array (in the .github/actions/spelling/config.json file):
"cspell:csharp/csharp.txt",
"cspell:aws/aws.txt",
"cspell:fonts/fonts.txt",
To stop checking additional dictionaries, put (in the .github/actions/spelling/config.json file):
"check_extra_dictionaries": []Forbidden patterns 🙅 (9)
In order to address this, you could change the content to not match the forbidden patterns (comments before forbidden patterns may help explain why they're forbidden), add patterns for acceptable instances, or adjust the forbidden patterns themselves.
These forbidden patterns matched content:
Should be nonexistent
\b[Nn]o[nt][- ]existent\b
Should be preexisting
[Pp]re[- ]existing
Should be ; otherwise or . Otherwise
https://study.com/learn/lesson/otherwise-in-a-sentence.html
, [Oo]therwise\b
Should probably be Otherwise,
(?<=\. )Otherwise\s
Complete sentences in parentheticals should not have a space before the period.
\s\.\)(?!.*\}\})
Should be set up (setup is a noun / set up is a verb)
\b[Ss]etup(?= (?:an?|the|to)\b)
Should be reentrant
[Rr]e[- ]entrant
Should be whether or not ...
(?i)\b(?:whe|ra)ther(?:\s\w+)+ or not\.
Should be WinGet
\bWinget\b
Pattern suggestions ✂️ (1)
You could add these patterns to .github/actions/spelling/patterns/dd5026bd5359d5870aa69592e0c186573819caad.txt:
# Automatically suggested patterns
# hit-count: 1 file-count: 1
# python
\b(?i)py(?!gment|gmy|lon|ramid|ro|th)(?=[a-z]{2,})
Alternatively, if a pattern suggestion doesn't make sense for this project, add a # to the beginning of the line in the candidates file with the pattern to stop suggesting it.
Errors, Warnings, and Notices ❌ (9)
See the 📂 files view, the 📜action log, 👼 SARIF report, or 📝 job summary for details.
See ❌ Event descriptions for more information.
✏️ Contributor please read this
By default the command suggestion will generate a file named based on your commit. That's generally ok as long as you add the file to your commit. Someone can reorganize it later.
If the listed items are:
- ... misspelled, then please correct them instead of using the command.
- ... names, please add them to
.github/actions/spelling/allow/names.txt. - ... APIs, you can add them to a file in
.github/actions/spelling/allow/. - ... just things you're using, please add them to an appropriate file in
.github/actions/spelling/expect/. - ... tokens you only need in one place and shouldn't generally be used, you can add an item in an appropriate file in
.github/actions/spelling/patterns/.
See the README.md in each directory for more information.
🔬 You can test your commits without appending to a PR by creating a new branch with that extra change and pushing it to your fork. The check-spelling action will run in response to your push -- it doesn't require an open pull request. By using such a branch, you can limit the number of typos your peers see you make. 😉
If the flagged items are 🤯 false positives
If items relate to a ...
-
binary file (or some other file you wouldn't want to check at all).
Please add a file path to the
excludes.txtfile matching the containing file.File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.
^refers to the file's path from the root of the repository, so^README\.md$would exclude README.md (on whichever branch you're using). -
well-formed pattern.
If you can write a pattern that would match it,
try adding it to thepatterns.txtfile.Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
Summary of the Pull Request
Adds 4 more events to the telemetry we emit:
AgentPromptSentAgentResponseReceivedAgentResponseActionErrorFixResolvedImplementation has been based off the implementation of telemetry events in the microsoft/sudo repo, since that also uses Rust and ships with Windows.
PR Checklist