[release/10.0] Merge main to release/10.0

.github/copilot-instructions.md

@@ -0,0 +1,165 @@
+# dotnet-monitor Repository - Copilot Instructions
+
+## Project Overview
+
+`dotnet-monitor` is a diagnostic tool for capturing diagnostic artifacts from .NET applications in an operator-driven or automated manner. It provides a unified HTTP API for collecting diagnostics regardless of where the application runs (local, Docker, Kubernetes).
+
+**Key Features:**
+- HTTP API for on-demand collection of diagnostic artifacts (dumps, traces, logs, metrics)
+- Collection Rules for automated, rule-based artifact collection based on triggers
+- Egress providers for storing artifacts in various destinations
+- Cross-platform support (Windows, Linux, macOS)
+
+## Technology Stack
+
+- **Primary Language:** C# 
+- **.NET SDK:** 10.0
+- **Target Frameworks:** .NET 8.0, 9.0, 10.0
+- **ASP.NET Core:** Multi-version support (8.0, 9.0, 10.0)
+- **Build System:** MSBuild with .NET Arcade SDK
+- **Native Code:** C++ (for profilers and native components)
+- **Testing:** xUnit
+- **Documentation:** Markdown
+- **Package Management:** NuGet with Central Package Management
+
+## Repository Structure
+
+- **`src/Tools/dotnet-monitor/`** - Main dotnet-monitor tool
+- **`src/Microsoft.Diagnostics.Monitoring.WebApi/`** - Core Web API implementation
+- **`src/Microsoft.Diagnostics.Monitoring.Options/`** - Configuration options
+- **`src/Microsoft.Diagnostics.Monitoring.StartupHook/`** - Startup hook for in-process features
+- **`src/Extensions/`** - Extension implementations (Azure Blob, S3 storage, etc.)
+- **`src/Profilers/`** - Native profiler implementations
+- **`src/Tests/`** - All test projects
+- **`documentation/`** - User-facing documentation
+- **`eng/`** - Build and engineering infrastructure
+
+## Build and Test Commands
+
+### Build
+```bash
+# Windows
+.\Build.cmd
+
+# Linux/macOS
+./build.sh
+```
+
+### Test
+```bash
+# Windows
+.\Test.cmd
+
+# Linux/macOS  
+./test.sh
+```
+
+### Restore Dependencies
+```bash
+# Windows
+.\Restore.cmd
+
+# Linux/macOS
+./restore.sh
+```
+
+## Coding Guidelines
+
+### C# Code Style
+
+1. **File Headers:** All C# files must include the .NET Foundation license header:
+   ```csharp
+   // Licensed to the .NET Foundation under one or more agreements.
+   // The .NET Foundation licenses this file to you under the MIT license.
+   ```
+
+2. **Language Version:** Use `Latest` C# language features
+
+3. **Code Style Preferences:**
+   - Do NOT use `var` - use explicit types
+   - Prefer explicit types for locals, parameters, and member access
+   - Use `this.` qualification: NO (avoid using `this.` unless necessary)
+   - Expression-bodied members: Use for properties, accessors, indexers, lambdas
+   - Expression-bodied members: DO NOT use for methods, constructors, operators
+   - Pattern matching: Prefer pattern matching over `as` with null checks
+   - Null-checking: Use null-conditional operators and null-coalescing
+   - Using directives: Place outside namespace
+   - Namespace style: Use block-scoped namespaces (not file-scoped)
+   - Braces: Always use braces even for single-line blocks
+
+4. **Modifier Order:**
+   ```
+   public, private, protected, internal, static, extern, new, virtual, 
+   abstract, sealed, override, readonly, unsafe, volatile, async
+   ```
+
+5. **Documentation:** Generate XML documentation files for all projects
+
+6. **Warnings:** Treat all warnings as errors (`TreatWarningsAsErrors=true`)
+
+7. **Code Style Enforcement:** Code style rules are enforced during build (`EnforceCodeStyleInBuild=true`)
+
+### Formatting
+
+- **Indentation:** 4 spaces (2 spaces for XML/YAML/JSON config files)
+- **Line Endings:** Insert final newline
+- **Trailing Whitespace:** Trim trailing whitespace
+- **C++ Code:** Use Allman brace style
+
+### Testing
+
+- All test projects are in `src/Tests/`
+- Use xUnit for unit tests
+- Test project naming: `<Component>.UnitTests` or `<Component>.IntegrationTests`
+- Always add tests when adding new features
+- Start with a failing test when fixing bugs
+
+## Security Considerations
+
+1. **Authentication:** dotnet-monitor supports API Key authentication (recommended) and Windows authentication
+2. **Sensitive Data:** Never commit secrets or API keys to source code
+3. **Security Documentation:** See `documentation/security-considerations.md` for security topics
+
+## Pull Request Process
+
+1. Create an issue for non-trivial changes
+2. Fork the repository and create a feature branch from `main`
+3. Make focused, minimal changes
+4. Add tests for new features or bug fixes
+5. Ensure builds are clean and all tests pass
+6. Sign the .NET Foundation CLA (automated on first PR)
+7. Wait for review from Microsoft team members
+8. Address feedback and iterate
+
+## Key Configuration Files
+
+- **`Directory.Build.props`** - Common MSBuild properties for all projects
+- **`Directory.Packages.props`** - Central package version management
+- **`.editorconfig`** - Code style and formatting rules
+- **`global.json`** - .NET SDK version pinning
+- **`NuGet.config`** - NuGet feed configuration
+
+## Common Patterns
+
+1. **Options Pattern:** Use strongly-typed options classes in `Microsoft.Diagnostics.Monitoring.Options`
+2. **Collection Rules:** Implement triggers and actions following existing patterns
+3. **Egress Providers:** Extend `IEgressProvider` for new storage backends
+4. **API Endpoints:** Follow RESTful conventions in `Microsoft.Diagnostics.Monitoring.WebApi`
+5. **Configuration:** Use IConfiguration with JSON/environment variable support
+6. **Learning Paths:** Guidance for developers on the various components in `dotnet-monitor`. It may need to be updated based on product changes.
+
+## Documentation
+
+- User documentation in `documentation/` directory
+- API documentation at `documentation/api/`
+- Configuration schema: `documentation/schema.json`
+- Keep documentation synchronized with code changes
+- Follow existing markdown structure and formatting
+
+## Useful Links
+
+- [Contributing Guidelines](CONTRIBUTING.md)
+- [Building Instructions](documentation/building.md)
+- [Security Policy](SECURITY.md)
+- [API Documentation](documentation/api/README.md)
+- [Configuration Guide](documentation/configuration/README.md)

.github/workflows/check-learning-path-links.yml

@@ -17,7 +17,7 @@ jobs:
 
     steps:
       - name: Checkout head
-        uses: actions/checkout@v6.0.1
+        uses: actions/checkout@v6.0.2
         with:
           persist-credentials: true # need this for opening a PR
           fetch-depth: 0
@@ -30,7 +30,7 @@ jobs:
           echo "prev_sha=$prev_sha" >> $GITHUB_ENV
 
       - name: Checkout previous update
-        uses: actions/checkout@v6.0.1
+        uses: actions/checkout@v6.0.2
         with:
           persist-credentials: false
           ref:  ${{ env.prev_sha }}

.github/workflows/check-markdown-links.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
 

.github/workflows/cleanup-releases.yml

@@ -18,7 +18,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials inorder to open a PR.
 

.github/workflows/generate-release-notes.yml

@@ -21,7 +21,7 @@ jobs:
 
     steps:
       - name: Checkout release branch
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
           fetch-depth: 0 # Fetch the entire repo for the below git commit graph operations
@@ -65,7 +65,7 @@ jobs:
           BASELINE_TAG: ${{ inputs.baselineTag }}
 
       - name: Checkout main
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials to push the resulting changes upstream.
           ref: main

.github/workflows/post-release.yml

@@ -29,7 +29,7 @@ jobs:
     # It's simpler than trying to parse our `eng/Versions.prop` due to the conditionals in it.
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
 
@@ -52,7 +52,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
 
@@ -104,7 +104,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials inorder to open a PR.
           ref: bot/${{ env.TARGET_BRANCH_POSTFIX }}

.github/workflows/scan-for-to-do-comments.yml

@@ -27,7 +27,7 @@ jobs:
           COMMENT_AUTHOR: ${{ github.event.comment.user.login }}
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f
+        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f
         with:
           name: issue-todo
           path: issue/

.github/workflows/spellcheck.yml

@@ -13,27 +13,27 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
 
-      - uses: streetsidesoftware/cspell-action@24fa8d3096a314ce263f39578744e9d9f8d80acf
+      - uses: streetsidesoftware/cspell-action@9cd41bb518a24fefdafd9880cbab8f0ceba04d28
         name: Documentation spellcheck
         if: ${{ !cancelled() }}
         with:
             files: '**/*.md'
             inline: error
             incremental_files_only: true
 
-      - uses: streetsidesoftware/cspell-action@24fa8d3096a314ce263f39578744e9d9f8d80acf
+      - uses: streetsidesoftware/cspell-action@9cd41bb518a24fefdafd9880cbab8f0ceba04d28
         name: Resx spellcheck
         if: ${{ !cancelled() }}
         with:
             files: 'src/**/*.resx'
             inline: error
             incremental_files_only: true
 
-      - uses: streetsidesoftware/cspell-action@24fa8d3096a314ce263f39578744e9d9f8d80acf
+      - uses: streetsidesoftware/cspell-action@9cd41bb518a24fefdafd9880cbab8f0ceba04d28
         name: Source code spellcheck
         if: ${{ !cancelled() }}
         with:

.github/workflows/submit-to-do-issue.yml

@@ -27,15 +27,15 @@ jobs:
             });
 
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: false
 
       # Download the artifact from the workflow that kicked off this one.
       # The default artifact download action doesn't support cross-workflow
       # artifacts, so use a 3rd party one.
       - name: 'Download linting results'
-        uses: dawidd6/action-download-artifact@0bd50d53a6d7fb5cb921e607957e9cc12b4ce392
+        uses: dawidd6/action-download-artifact@5c98f0b039f36ef966fdb7dfa9779262785ecb05
         with:
           workflow: ${{env.workflow_name}}
           run_id: ${{github.event.workflow_run.id }}

.github/workflows/sync-branches.yml

@@ -23,7 +23,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials to push the resulting changes upstream.
           fetch-depth: 0 # Fetch the entire repo for the below git operations
@@ -65,7 +65,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials to push the resulting changes upstream.
           fetch-depth: 0 # Fetch the entire repo for the below git operations

.github/workflows/update-release-version.yml

@@ -31,7 +31,7 @@ jobs:
 
     steps:
       - name: Checkout branch
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        uses: actions/checkout@0c366fd6a839edf440554fa01a7085ccba70ac98
         with:
           persist-credentials: true # We need to persist credentials to push the resulting changes upstream.
 

eng/Build-Native.cmd

@@ -12,14 +12,46 @@ set __ThisScriptDir="%~dp0"
 call "%__ThisScriptDir%"\native\init-vs-env.cmd
 if NOT '%ERRORLEVEL%' == '0' goto ExitWithError
 
-if defined VS160COMNTOOLS (
+set "__VSToolsRoot="
+set "__VCToolsRoot="
+
+if defined VS180COMNTOOLS (
+    set "__VSToolsRoot=%VS180COMNTOOLS%"
+    set "__VCToolsRoot=%VS180COMNTOOLS%\..\..\VC\Auxiliary\Build"
+) else if defined VS170COMNTOOLS (
+    set "__VSToolsRoot=%VS170COMNTOOLS%"
+    set "__VCToolsRoot=%VS170COMNTOOLS%\..\..\VC\Auxiliary\Build"
+) else if defined VS160COMNTOOLS (
     set "__VSToolsRoot=%VS160COMNTOOLS%"
     set "__VCToolsRoot=%VS160COMNTOOLS%\..\..\VC\Auxiliary\Build"
-    set __VSVersion=vs2019
 ) else if defined VS150COMNTOOLS (
     set "__VSToolsRoot=%VS150COMNTOOLS%"
     set "__VCToolsRoot=%VS150COMNTOOLS%\..\..\VC\Auxiliary\Build"
-    set __VSVersion=vs2017
+) else if defined VCINSTALLDIR (
+    set "__VCToolsRoot=%VCINSTALLDIR%Auxiliary\Build"
+)
+
+if defined VisualStudioVersion (
+    for /f "tokens=1 delims=." %%i in ("%VisualStudioVersion%") do set __VSMajorVersion=%%i
+    if !__VSMajorVersion! GEQ 18 (
+        set __VSVersion=vs2026
+    ) else if !__VSMajorVersion! EQU 17 (
+        set __VSVersion=vs2022
+    ) else if !__VSMajorVersion! EQU 16 (
+        set __VSVersion=vs2019
+    ) else if !__VSMajorVersion! EQU 15 (
+        set __VSVersion=vs2017
+    )
+)
+
+if not defined __VSVersion (
+    echo %__MsgPrefix%Error: Unsupported Visual Studio version. Visual Studio 2017 or later is required.
+    goto ExitWithError
+)
+
+if not defined __VCToolsRoot (
+    echo %__MsgPrefix%Error: Visual Studio C++ build tools path could not be determined.
+    goto ExitWithError
 )
 
 :: Set the default arguments for build
@@ -38,7 +70,7 @@ set __CrossArch=
 
 :: Set the various build properties here so that CMake and MSBuild can pick them up
 set "__ProjectDir=%~dp0"
-:: remove trailing slash 
+:: remove trailing slash
 if %__ProjectDir:~-1%==\ set "__ProjectDir=%__ProjectDir:~0,-1%"
 set "__ProjectDir=%__ProjectDir%\.."
 set "__SourceDir=%__ProjectDir%\src"