Skip to content

Commit

Permalink
sync non-code with origin/main (#7687)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] authored Nov 18, 2024
1 parent c676ed0 commit 22703be
Show file tree
Hide file tree
Showing 14 changed files with 93 additions and 174 deletions.
2 changes: 0 additions & 2 deletions .github/dependabot.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
#@ return {
#@ "9": [ "net9.0", "net8.0", "net7.0", "net6.0" ],
#@ "8": [ "net8.0", "net7.0", "net6.0" ],
#@ "6": [ "net6.0", "netcoreapp3.1" ]
#@ }
#@ end

Expand All @@ -21,7 +20,6 @@
#@ struct.encode({"name": "main", "majorVersion": "8"}),
#@ struct.encode({"name": "feature/9.x", "majorVersion": "9"}),
#@ struct.encode({"name": "release/8.0", "majorVersion": "8"}),
#@ struct.encode({"name": "release/6.x", "majorVersion": "6"}),
#@ ]
#@ end

Expand Down
67 changes: 0 additions & 67 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -262,70 +262,3 @@ updates:
- Microsoft.Extensions.*
- Microsoft.NETCore.DotNetHost
- System.Text.Json
- package-ecosystem: nuget
directory: /eng/dependabot/independent
schedule:
interval: daily
target-branch: release/6.x
ignore:
- dependency-name: Microsoft.Extensions.*
update-types:
- version-update:semver-major
- dependency-name: Microsoft.IdentityModel.*
update-types:
- version-update:semver-major
- version-update:semver-minor
- dependency-name: Moq
commit-message:
prefix: '[release/6.x] '
groups:
azure-sdk-dependencies:
patterns:
- Azure.Core
- Azure.Identity
- Azure.Storage.*
identity-dependencies:
patterns:
- Microsoft.Identity.*
- Microsoft.IdentityModel.*
- package-ecosystem: nuget
directory: /eng/dependabot/nuget.org
schedule:
interval: daily
target-branch: release/6.x
commit-message:
prefix: '[release/6.x] '
- package-ecosystem: nuget
directory: /eng/dependabot/net6.0
schedule:
interval: daily
target-branch: release/6.x
ignore:
- dependency-name: '*'
update-types:
- version-update:semver-major
commit-message:
prefix: '[release/6.x] '
groups:
runtime-dependencies:
patterns:
- Microsoft.Extensions.*
- Microsoft.NETCore.DotNetHost
- System.Text.Json
- package-ecosystem: nuget
directory: /eng/dependabot/netcoreapp3.1
schedule:
interval: daily
target-branch: release/6.x
ignore:
- dependency-name: '*'
update-types:
- version-update:semver-major
commit-message:
prefix: '[release/6.x] '
groups:
runtime-dependencies:
patterns:
- Microsoft.Extensions.*
- Microsoft.NETCore.DotNetHost
- System.Text.Json
2 changes: 1 addition & 1 deletion .github/learning-path-sha.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c
17b6501236d7069e11dec7cf27bdb33a776214c6
34 changes: 11 additions & 23 deletions .github/releases.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,34 @@
"additionalMonthsOfSupportOnNewMinorRelease": 3,
"cleanupUnsupportedReleasesAfterMonths": 12
},
"preview": [
"9.0"
],
"preview": [],
"supported": [
"8.0",
"6.3"
"9.0",
"8.0"
],
"unsupported": [
"7.3",
"7.2"
"6.3"
],
"releases": {
"6.3": {
"tag": "v6.3.9",
"tag": "v6.3.10",
"minorReleaseDate": "2022-10-11T00:00:00.000Z",
"patchReleaseDate": "2024-10-08T00:00:00.000Z",
"patchReleaseDate": "2024-11-12T00:00:00.000Z",
"supportedFrameworks": [
"net6.0",
"netcoreapp3.1"
],
"outOfSupportDate": "2024-11-12T00:00:00.000Z"
},
"8.0": {
"tag": "v8.0.5",
"tag": "v8.0.6",
"minorReleaseDate": "2023-11-14T00:00:00.000Z",
"patchReleaseDate": "2024-10-08T00:00:00.000Z",
"patchReleaseDate": "2024-11-12T00:00:00.000Z",
"supportedFrameworks": [
"net8.0"
]
},
"7.2": {
"tag": "v7.2.3",
"minorReleaseDate": "2023-06-13T00:00:00.000Z",
"patchReleaseDate": "2023-10-10T00:00:00.000Z",
"supportedFrameworks": [
"net6.0",
"net7.0"
],
"outOfSupportDate": "2023-11-08T00:00:00.000Z"
},
"7.3": {
"tag": "v7.3.4",
"minorReleaseDate": "2023-08-08T00:00:00.000Z",
Expand All @@ -54,9 +42,9 @@
"outOfSupportDate": "2024-05-14T00:00:00.000Z"
},
"9.0": {
"tag": "v9.0.0-rc.2.24504.9",
"minorReleaseDate": "2024-10-08T00:00:00.000Z",
"patchReleaseDate": "2024-10-08T00:00:00.000Z",
"tag": "v9.0.0",
"minorReleaseDate": "2024-11-12T00:00:00.000Z",
"patchReleaseDate": "2024-11-12T00:00:00.000Z",
"supportedFrameworks": [
"net9.0"
]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sync-branches.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
if: github.repository == 'dotnet/dotnet-monitor'
strategy:
matrix:
branch: ["release/6.x", "release/8.0"]
branch: ["release/8.0"]
name: 'Sync non-code to ${{ matrix.branch }}'
runs-on: ubuntu-latest
permissions:
Expand Down
5 changes: 5 additions & 0 deletions documentation/compatibility/9.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@ If you are migrating your usage to `dotnet monitor` 9.0, the following changes m

| Area | Title | Introduced |
|--|--|--|
| Acquisition | [.NET tool installation requires .NET 9 SDK](#acquisition-net-tool-installation-requires-net-9-sdk) | Preview 1 |
| Configuration | [`TenantId` is now required when configuring Azure Active Directory authentication](#configuration-azure-active-directory-authentication) | RC 2 |

## Details

### Acquisition: .NET tool installation requires .NET 9 SDK

Acquisition of the tool through `dotnet tool` command requires the use of the .NET 9 SDK as the tool requires .NET 9 run. This has no impact on what applications can be monitored nor any impact on the `dotnet/monitor` Docker image.

### Configuration: Azure Active Directory Authentication

When using Azure Active Directory (Entra ID) for authentication, setting the `TenantId` option is now **required**. See [Azure Active Directory Authentication Configuration](../../configuration/azure-ad-authentication-configuration.md#configuration-options) for more details.
2 changes: 1 addition & 1 deletion documentation/learningPath/aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In addition to its availability as a .NET CLI tool, the `dotnet monitor` tool is

This workflow takes your local development copy of `dotnet-monitor`, patches it with a local development copy of the [.NET Core Diagnostics Repo](https://github.com/dotnet/diagnostics#net-core-diagnostics-repo), and makes it available as an image for you to consume in an ACR (Azure Container Registry). Note that there are many other ways to do this - this is meant to serve as a basic template that can be adapted to match your needs.

1. Open `pwsh` and run the [generate-dev-sln script](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/generate-dev-sln.ps1), providing a path to your local copy of the diagnostics repo.
1. Open `pwsh` and run the [generate-dev-sln script](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/generate-dev-sln.ps1), providing a path to your local copy of the diagnostics repo.

> [!NOTE]
> If your changes do not involve the [.NET Core Diagnostics Repo](https://github.com/dotnet/diagnostics#net-core-diagnostics-repo), you don't need to complete this step.
Expand Down
10 changes: 5 additions & 5 deletions documentation/learningPath/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ dotnet-monitor exposes functionality through both [collection rules](./collectio

## Adding New APIs

The web API surface is defined by a series of controllers [here](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Microsoft.Diagnostics.Monitoring.WebApi/Controllers/). It's common for an API to expose functionality also available via [Actions](./collectionrules.md#actions) and so methods in these controllers are often wrappers around a shared implementation. Each controller may have one or more attributes that configure how and where it is exposed, you can learn more about the notable controller attributes [here](#notable-controller-attributes).
The web API surface is defined by a series of controllers [here](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Microsoft.Diagnostics.Monitoring.WebApi/Controllers/). It's common for an API to expose functionality also available via [Actions](./collectionrules.md#actions) and so methods in these controllers are often wrappers around a shared implementation. Each controller may have one or more attributes that configure how and where it is exposed, you can learn more about the notable controller attributes [here](#notable-controller-attributes).

If the new API needs to either accept or return structured data, a dedicated model should be used. Models are defined [here](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Microsoft.Diagnostics.Monitoring.WebApi/Models/).
If the new API needs to either accept or return structured data, a dedicated model should be used. Models are defined [here](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Microsoft.Diagnostics.Monitoring.WebApi/Models/).

When adding a new API, it's important to also update the [`openapi.json`](../openapi.json) spec which describes the API surface. There are CI tests that will ensure this file has been updated to reflect any API changes. Learn more about updating `openapi.json` [here](./testing.md#openapi-generation).

### Adding Tests

Web APIs in dotnet-monitor are typically tested using functional tests that leverage the [ApiClient](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.FunctionalTests/HttpApi/ApiClient.cs) to call a specific API. Learn more about how the functional tests are defined and operate [here](./testing.md#functional-tests).
Web APIs in dotnet-monitor are typically tested using functional tests that leverage the [ApiClient](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Tests/Microsoft.Diagnostics.Monitoring.Tool.FunctionalTests/HttpApi/ApiClient.cs) to call a specific API. Learn more about how the functional tests are defined and operate [here](./testing.md#functional-tests).

## Notable Controller Attributes

Expand All @@ -32,6 +32,6 @@ dotnet-monitor supports multiple different [authentication modes](../authenticat

### Determining Authentication Mode

When dotnet-monitor starts, the command line arguments are first inspected to see if a specific authentication mode was set (such as `--no-auth`), referred to as the `StartupAuthenticationMode`, this is calculated [here](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Tools/dotnet-monitor/Commands/CollectCommandHandler.cs#L28). If no modes were explicitly set via a command line argument, dotnet-monitor will select `Deferred` as the `StartupAuthenticationMode`. This indicates that the user configuration should be looked at to determine the authentication mode later on in the startup process.
When dotnet-monitor starts, the command line arguments are first inspected to see if a specific authentication mode was set (such as `--no-auth`), referred to as the `StartupAuthenticationMode`, this is calculated [here](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Tools/dotnet-monitor/Commands/CollectCommandHandler.cs#L28). If no modes were explicitly set via a command line argument, dotnet-monitor will select `Deferred` as the `StartupAuthenticationMode`. This indicates that the user configuration should be looked at to determine the authentication mode later on in the startup process.

After determining the `StartupAuthenticationMode` mode, the relevant [IAuthenticationConfigurator](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Tools/dotnet-monitor/Auth/IAuthenticationConfigurator.cs) is created by the [AuthConfiguratorFactory](https://github.com/dotnet/dotnet-monitor/blob/7ae75a4e0cb5423757a699d6fc9d3e725b3dfd7c/src/Tools/dotnet-monitor/Auth/AuthConfiguratorFactory.cs). This factory also handles deciding what authentication mode to use when `StartupAuthenticationMode` is `Deferred`. The selected configurator is used to configure various parts of dotnet-monitor that are specific to authentication, such as protecting the web APIs and adding authentication-mode specific logging.
After determining the `StartupAuthenticationMode` mode, the relevant [IAuthenticationConfigurator](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Tools/dotnet-monitor/Auth/IAuthenticationConfigurator.cs) is created by the [AuthConfiguratorFactory](https://github.com/dotnet/dotnet-monitor/blob/17b6501236d7069e11dec7cf27bdb33a776214c6/src/Tools/dotnet-monitor/Auth/AuthConfiguratorFactory.cs). This factory also handles deciding what authentication mode to use when `StartupAuthenticationMode` is `Deferred`. The selected configurator is used to configure various parts of dotnet-monitor that are specific to authentication, such as protecting the web APIs and adding authentication-mode specific logging.
Loading

0 comments on commit 22703be

Please sign in to comment.