[Telemetry] Default native builds to 1DS by bmehta001 · Pull Request #32384 · microsoft/onnxruntime

bmehta001 · 2026-09-02T08:35:58Z

Description

This PR merges the current main telemetry-volume behavior and adds the Windows 1DS port:

applies deterministic 1% client-side sampling to session and high-volume events while keeping the once-per-process ProcessInfo event unsampled
makes 1DS the default telemetry backend for supported native builds, including Windows
preserves Windows TraceLogging behind --use_windows_telemetry / onnxruntime_USE_WINDOWS_TELEMETRY=ON
repairs malformed and oversized registry DeviceId values under a per-user mutex
falls back from LOCALAPPDATA to APPDATA, HOME, USERPROFILE, then HOMEDRIVE + HOMEPATH for Windows cache storage
preserves telemetry completion events for malformed model loads and early initialization failures

Backend selection

Build option	Backend
Default supported native build	1DS
`--use_windows_telemetry`	Windows TraceLogging
`--no_telemetry`	None
`-Donnxruntime_USE_TELEMETRY=ON`	1DS
`-Donnxruntime_USE_WINDOWS_TELEMETRY=ON`	Windows TraceLogging; telemetry is enabled automatically

Validation

repository lint on all changed C++/Python/CMake files
Visual Studio 2026 RelWithDebInfo build of onnxruntime_test_all with default Windows 1DS telemetry
Visual Studio 2026 RelWithDebInfo build of onnxruntime_test_all with explicit Windows TraceLogging
42 focused Windows DeviceId, telemetry context, environment, no-throw, redaction, sampling, adapter, and driver payload tests
Linux/WSL RelWithDebInfo build of the onnxruntime_common production target
python -m unittest tools.ci_build.test_build_args (10 tests)

Upgrade cpp_client_telemetry to 3.10.240.1 so public builds use the supported cross-platform backend by default while preserving explicit TraceLogging and no-telemetry modes. Add Windows persistent device identity and retain the hashed platform adapter identity as a separate telemetry field. Propagate Apple system SQLite and zlib requirements through static package metadata. Files changed: telemetry platform implementations; CMake and vcpkg dependency wiring; build arguments and tests; Windows pipeline defaults. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9e493808-b0e7-4c22-baa6-696ce165f920

Copilot

🟡 Changes recommended

The vcpkg version is unresolvable, and Windows backend selection and persistence have unresolved defects.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Defaults supported native builds to 1DS while retaining explicit Windows TraceLogging and telemetry-free modes.

Changes:

Upgrades and simplifies 1DS dependency integration.
Adds Windows 1DS support and persistent device identity.
Updates Apple linkage and package metadata.

File summaries

File	Description
`tools/ci_build/test_build_args.py`	Tests telemetry argument selection.
`tools/ci_build/github/windows/set_telemetry_var.ps1`	Updates Windows CI telemetry defaults.
`tools/ci_build/build.py`	Selects and configures telemetry backends.
`tools/ci_build/build_args.py`	Adds the TraceLogging option.
`onnxruntime/core/platform/windows/env.h`	Hosts Windows telemetry providers.
`onnxruntime/core/platform/windows/env.cc`	Returns the selected provider.
`onnxruntime/core/platform/windows/device_id.cc`	Implements registry-backed device identity.
`onnxruntime/core/platform/posix/telemetry.cc`	Adds Windows support to 1DS telemetry.
`onnxruntime/core/platform/posix/env.cc`	Renames the 1DS compile guard.
`onnxruntime/core/platform/posix/device_id.h`	Documents Windows storage.
`cmake/vcpkg.json`	Updates telemetry dependencies.
`cmake/vcpkg-ports/cpp-client-telemetry/vcpkg.json`	Removes the custom manifest.
`cmake/vcpkg-ports/cpp-client-telemetry/portfile.cmake`	Removes the overlay port.
`cmake/vcpkg-configuration.json`	Documents the required SDK version.
`cmake/patches/cpp_client_telemetry/cpp_client_telemetry.patch`	Removes the former SDK patch.
`cmake/onnxruntime.cmake`	Propagates Apple system libraries.
`cmake/onnxruntime_unittests.cmake`	Adjusts telemetry test selection.
`cmake/onnxruntime_common.cmake`	Builds and links selected telemetry providers.
`cmake/external/telemetry_linux_http.cmake`	Removes the custom Linux transport.
`cmake/external/onnxruntime_external_deps.cmake`	Uses upstream 1DS dependency controls.
`cmake/deps.txt`	Pins 1DS 3.10.240.1.
`cmake/CMakeLists.txt`	Adds direct CMake backend selection.
`build.bat`	Enables default telemetry behavior.

Review details

Files reviewed: 23/23 changed files
Comments generated: 4
Review effort level: Balanced

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sample routine 1DS telemetry at 1%, remove redundant periodic events, and consolidate 1DS lifecycle pairs into duration-bearing completion events so projected growth remains within the ingestion budget. Add a delayed, ORT-only DeviceCensus event that batches versions for each active UTC day and uploads the completed census on the next active day. Files changed: telemetry interfaces and platform providers; session and EP-registration instrumentation; POSIX census persistence; sampling and census tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Emit DeviceCensus immediately when a DeviceId is created or repaired, and persist the emitted state so a later active day does not resend the same census. Files changed: census state serialization; POSIX DeviceId persistence; ProcessInfo census trigger; census unit tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 39dd1605-0e50-4029-9ed7-44fdb27545d8

Parenthesize the vector comparison so EXPECT_EXIT does not interpret the initializer-list comma as another macro argument. Files changed: - onnxruntime/test/platform/posix/device_id_test.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 39dd1605-0e50-4029-9ed7-44fdb27545d8

Bind persisted census state to the transmitted device identity, including the 1DS mobile platform identity, and persist rollover state before emission to avoid duplicates. Advance census state from recurring inference activity and ensure malformed model loads and early initialization failures reach completion telemetry. Files changed: device census persistence and parsing, POSIX telemetry scheduling, inference-session completion paths, and focused census tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Keep immediate census emissions pending until persistence succeeds and respect runtime telemetry disablement. Resolve census test paths through the platform storage helper so they work on macOS. Files changed: - onnxruntime/core/platform/posix/telemetry.cc - onnxruntime/core/platform/posix/telemetry.h - onnxruntime/test/platform/posix/device_id_test.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2f0ab518-b6d4-47f8-928f-dc214284a697

Route POSIX duration and inventory data through separate virtual hooks so the Windows telemetry implementation, event schemas, payloads, and emission cadence remain unchanged. Files changed: - onnxruntime/core/platform/posix/telemetry.cc - onnxruntime/core/platform/posix/telemetry.h - onnxruntime/core/platform/telemetry.cc - onnxruntime/core/platform/telemetry.h - onnxruntime/core/platform/windows/telemetry.cc - onnxruntime/core/platform/windows/telemetry.h - onnxruntime/core/session/environment.cc - onnxruntime/core/session/inference_session.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 2f0ab518-b6d4-47f8-928f-dc214284a697

Keep 1DS identity and cache persistence available when LOCALAPPDATA is absent or invalid by checking roaming AppData and user-profile locations in order. Files changed: Windows DeviceId storage selection, Windows telemetry test registration, and fallback-path tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 49b5981f-971c-4991-9060-da1c74378cd8

Stack the reduced-volume telemetry work from #32425 onto the Windows 1DS draft and use the same identity-bound, persist-before-emit census transition logic for registry-backed Windows state. Files changed: shared census state handling and tests; POSIX telemetry sampling and completion events; Windows DeviceId census persistence; session telemetry lifecycle handling. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 49b5981f-971c-4991-9060-da1c74378cd8

Consolidate census state handling and fold inventory and duration data into existing telemetry calls so telemetry-disabled minimal builds do not retain extra virtual wrappers. Files changed: telemetry providers and session call sites; shared census state and platform device IDs; telemetry unit-test registration and coverage. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: c1532bdc-a17f-4d16-8468-4b3aa947ce4b

Preserve the reviewed remote census commits while retaining the smaller telemetry call surface required by Android minimal builds. Files changed: merge ancestry only; overlapping telemetry sources retain the size-reduced implementations. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: c1532bdc-a17f-4d16-8468-4b3aa947ce4b

Remove the persisted census path because ephemeral hosts cannot provide reliable device identity. Keep ProcessInfo unsampled while preserving existing sampling for every other event family. Files changed: - onnxruntime/core/platform/device_census.h - onnxruntime/core/platform/posix/device_id.cc - onnxruntime/core/platform/posix/device_id.h - onnxruntime/core/platform/posix/telemetry.cc - onnxruntime/core/platform/windows/device_id.cc - onnxruntime/test/platform/posix/device_id_test.cc - onnxruntime/test/platform/telemetry_sampling_test.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Preserve the intended telemetry backends while fixing the Android and warnings-as-errors build failures. - expose the Android 1DS bridge header only to onnxruntime_common - retain an updated mbedTLS-only vcpkg overlay and remove unrelated manifest churn - select TraceLogging when CI provides its private telemetry GUID - avoid shadowing the ORT model-load status Files: cmake/external/onnxruntime_external_deps.cmake, cmake/onnxruntime_common.cmake, cmake/vcpkg-configuration.json, cmake/vcpkg.json, cmake/vcpkg-ports/cpp-client-telemetry/portfile.cmake, cmake/vcpkg-ports/cpp-client-telemetry/vcpkg.json, onnxruntime/core/session/inference_session.cc, tools/ci_build/github/windows/set_telemetry_var.ps1 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Make Android's FetchContent fallback explicitly use bundled zlib even under a vcpkg toolchain, and keep the WindowsEnv layout independent of target-private telemetry macros. Files: cmake/external/onnxruntime_external_deps.cmake, onnxruntime/core/platform/windows/env.h, onnxruntime/core/platform/windows/env.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 18d20bc2-fee6-431a-b940-b1184677fa48

Centralize the 1DS backend condition and use compile-time provider ownership so no-telemetry builds avoid unnecessary telemetry implementation and allocation overhead. Files changed: - cmake/CMakeLists.txt and telemetry CMake wiring - POSIX telemetry declarations and Windows-only events - Windows environment telemetry provider ownership Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: a9e28009-b56c-4d6b-b8ae-de5603e7ddfb

Avoid Network List Manager initialization because netprofm.dll retains an allocation at process exit under Application Verifier. Files changed: - onnxruntime/core/platform/posix/telemetry.cc: disable the Windows 1DS network detector before log manager creation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 90d1ead3-317b-47ff-bae3-e516f413e980

Preserve the current telemetry volume behavior while enabling Windows 1DS by default, repairing invalid registry device IDs, validating legacy backend targets, and covering Windows integration paths. Files changed: telemetry CMake and vcpkg integration; POSIX and Windows telemetry/device ID implementations; Windows telemetry tests; build argument and CI telemetry selection. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b7025dd7-76ed-481f-a1cd-8c9b3842c33b

Copilot

Copilot review overview

🟡 Changes recommended

The current implementation has class-layout mismatches, unsampled process telemetry, incorrect ARM64EC reporting, and no described daily DeviceCensus implementation.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 · 4

Open (5)

Propagate telemetry configuration to keep WindowsEnv layouts consistent · New
Return detailed Windows OS version information · New
Exclude ARM64EC from x64 architecture detection · New
Restore process-event sampling gate · New
Implement daily identity-bound DeviceCensus emission · New

Resolved since last review (4)

Both branches now publish an empty TelemetryOption. When TELEMETRYGUID is valid, the script…
This validates the build host rather than the selected target. On Windows, combinations such as…
An oversized registry value makes RegQueryValueExA return ERROR_MORE_DATA, which is classified…
The new predicate still contains AND NOT WIN32, so `NOT (WIN32 AND…

Propagate backend definitions to consumers so WindowsEnv has one layout, report manifest-independent Windows versions, and classify ARM64EC correctly. Files changed: cmake/onnxruntime_common.cmake; onnxruntime/core/platform/posix/telemetry.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b7025dd7-76ed-481f-a1cd-8c9b3842c33b

Copilot

Copilot review overview

🟡 Changes recommended

Static package configuration and Unicode Windows cache paths have unresolved correctness issues.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1

Open (1)

Avoid requiring MSTelemetry for bundled static package exports · New

Resolved since last review (5)

Propagate telemetry configuration to keep WindowsEnv layouts consistent
Implement daily identity-bound DeviceCensus emission
Restore process-event sampling gate
Exclude ARM64EC from x64 architecture detection
Return detailed Windows OS version information

Previously missed (1)

In code that hasn't changed since last review

Use Unicode-safe environment paths for the 1DS offline cache

onnxruntime/core/platform/windows/device_id.cc:202

These A APIs cannot represent an environment path containing characters outside the active ANSI code page. For example, a Unicode user profile can turn %LOCALAPPDATA% into a path containing ?, so EnsureStorageDirectory() creates the wrong location or disables the 1DS offline cache. Read the variables with GetEnvironmentVariableW and keep the path wide (or explicitly UTF-8 via u8path) through directory creation.

Avoid an external MSTelemetry requirement for bundled exports and preserve Unicode Windows cache paths through UTF-8 conversion and wide filesystem APIs. Files changed: cmake/CMakeLists.txt; onnxruntime/core/platform/windows/device_id.cc; onnxruntime/test/platform/windows_telemetry/device_id_test.cc Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: b7025dd7-76ed-481f-a1cd-8c9b3842c33b

Xavier Dupré (xadupre) requested a balanced review from Copilot September 2, 2026 09:41

Copilot started reviewing on behalf of Xavier Dupré (xadupre) September 2, 2026 09:42

View session

Copilot AI reviewed Sep 2, 2026

View reviewed changes

Comment thread cmake/onnxruntime_unittests.cmake Outdated

Comment thread onnxruntime/core/platform/windows/device_id.cc

Comment thread tools/ci_build/build_args.py Outdated

Comment thread tools/ci_build/github/windows/set_telemetry_var.ps1 Outdated

bmehta001 and others added 16 commits September 3, 2026 12:32

bmehta001 requested a balanced review from Copilot September 21, 2026 22:59

Copilot started reviewing on behalf of bmehta001 September 21, 2026 23:00

View session

Copilot AI reviewed Sep 21, 2026

View reviewed changes

bmehta001 requested a balanced review from Copilot September 21, 2026 23:50

Copilot started reviewing on behalf of bmehta001 September 21, 2026 23:51

View session

Copilot AI reviewed Sep 21, 2026

View reviewed changes

Comment thread cmake/CMakeLists.txt Outdated

bmehta001 requested a balanced review from Copilot September 22, 2026 00:17

Copilot started reviewing on behalf of bmehta001 September 22, 2026 00:19

View session

jordanhs-unlimit mentioned this pull request Oct 18, 2026

Dependencies: first monthly re-lock (about 60 packages have newer versions) thatskiff33/unminute#180

Open

Navigation Menu

Repository navigation

[Telemetry] Default native builds to 1DS - #32384

[Telemetry] Default native builds to 1DS#32384
bmehta001 merged 64 commits into
mainfrom
bhamehta/windows-1ds-telemetry-default

bmehta001 commented Sep 2, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

bmehta001 commented Sep 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Backend selection

Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bmehta001 commented Sep 2, 2026 •

edited

Loading