Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

publish to live #38530

Merged
merged 6 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .openpublishing.redirection.fundamentals.json
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@
"redirect_url": "/dotnet/fundamentals/apicompat/package-validation/overview",
"redirect_document_id": true
},
{
"source_path_from_root": "/docs/fundamentals/networking/networking-telemetry.md",
"redirect_url": "/dotnet/fundamentals/networking/telemetry/overview"
},
{
"source_path_from_root": "/docs/fundamentals/productivity/code-analysis.md",
"redirect_url": "/dotnet/fundamentals/code-analysis/overview"
Expand Down
11 changes: 6 additions & 5 deletions docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,11 @@
"_roslyn/**.*": "https://github.com/dotnet/docs/issues/new?template=customer-feedback.yml"
},
"open_source_feedback_productName": {
"docs/**.*": ".NET feedback",
"_csharplang/**.*": "C# feature specification feedback",
"_csharpstandard/standard/*.md": "C# Standard documentation feedback",
"_vblang/**.*": "Visual Basic language spec feedback",
"_roslyn/**.*": "Roslyn breaking feedback"
"docs/**.*": ".NET",
"_csharplang/**.*": "C# feature specification",
"_csharpstandard/standard/*.md": "C# Standard documentation",
"_vblang/**.*": "Visual Basic language spec",
"_roslyn/**.*": "Roslyn breaking changes"
},
"open_source_feedback_productDescription": {
"docs/**.*": "The .NET documentation is open source. Provide feedback here.",
Expand Down Expand Up @@ -223,6 +223,7 @@
},
"social_image_url": {
"docs/**/*.*": "/dotnet/media/dotnet-logo.png",
"docs/aspire/**/*.*": "/dotnet/media/dotnet-aspire-logo.png",
"docs/azure/**/*.*": "/dotnet/media/dotnet-bot_cloud-apps.png",
"docs/orleans/**/*.*": "/dotnet/media/dotnet-orleans.png",
"docs/iot/**/*.*": "/dotnet/media/dotnet-bot_iot.png",
Expand Down
124 changes: 62 additions & 62 deletions docs/azure/includes/dotnet-all.md

Large diffs are not rendered by default.

124 changes: 62 additions & 62 deletions docs/azure/includes/dotnet-new.md

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/core/diagnostics/built-in-metrics-system-net.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ ms.date: 9/21/2023
This article describes the networking metrics built-in for <xref:System.Net> produced using the
<xref:System.Diagnostics.Metrics?displayProperty=nameWithType> API. For a listing of metrics based on the alternate [EventCounters](event-counters.md) API, see [Well-known EventCounters in .NET](available-counters.md).

> [!TIP]
> For more information about how to collect, report, enrich, and test System.Net metrics, see [Networking metrics in .NET](../../fundamentals/networking/telemetry/metrics.md).

- [Meter: `System.Net.NameResolution`](#meter-systemnetnameresolution) - Metrics for DNS lookups
* [Instrument: `dns.lookup.duration`](#instrument-dnslookupduration)
- [Meter: `System.Net.Http`](#meter-systemnethttp) - Metrics for outbound networking requests using HttpClient
Expand Down
37 changes: 23 additions & 14 deletions docs/core/whats-new/dotnet-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -674,35 +674,44 @@ Keyed dependency injection (DI) services provides a means for registering and re
- Various new extension methods for <xref:Microsoft.Extensions.DependencyInjection.IServiceCollection> to support keyed services, for example, <xref:Microsoft.Extensions.DependencyInjection.ServiceCollectionServiceExtensions.AddKeyedScoped%2A?displayProperty=nameWithType>.
- The <xref:Microsoft.Extensions.DependencyInjection.ServiceProvider> implementation of <xref:Microsoft.Extensions.DependencyInjection.IKeyedServiceProvider>.

The following example shows you to use keyed DI services.
The following example shows you how to use keyed DI services.

```csharp
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Options;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSingleton<BigCacheConsumer>();
builder.Services.AddSingleton<SmallCacheConsumer>();

builder.Services.AddKeyedSingleton<IMemoryCache, BigCache>("big");
builder.Services.AddKeyedSingleton<IMemoryCache, SmallCache>("small");

builder.Services.AddKeyedSingleton<ICache, BigCache>("big");
builder.Services.AddKeyedSingleton<ICache, SmallCache>("small");
var app = builder.Build();

app.MapGet("/big", (BigCacheConsumer data) => data.GetData());
app.MapGet("/small", (SmallCacheConsumer data) => data.GetData());

app.MapGet("/big-cache", ([FromKeyedServices("big")] ICache cache) => cache.Get("data"));
app.MapGet("/small-cache", (HttpContext httpContext) => httpContext.RequestServices.GetRequiredKeyedService<ICache>("small").Get("data"));
app.Run();

class BigCacheConsumer([FromKeyedServices("big")] IMemoryCache cache)
class BigCacheConsumer([FromKeyedServices("big")] ICache cache)
{
public object? GetData() => cache.Get("data");
}

class SmallCacheConsumer(IKeyedServiceProvider keyedServiceProvider)
class SmallCacheConsumer(IServiceProvider serviceProvider)
{
public object? GetData() => serviceProvider.GetRequiredKeyedService<ICache>("small").Get("data");
}

public interface ICache
{
object Get(string key);
}

public class BigCache : ICache
{
public object Get(string key) => $"Resolving {key} from big cache.";
}

public class SmallCache : ICache
{
public object? GetData() => keyedServiceProvider.GetRequiredKeyedService<IMemoryCache>("small");
public object Get(string key) => $"Resolving {key} from small cache.";
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/fundamentals/networking/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ The `Uri` class automatically performs validation and canonicalization per [RCF
- [Sockets in .NET](sockets/sockets-overview.md)
- [TCP in .NET](sockets/tcp-classes.md)
- [Tutorial: Make HTTP requests in a .NET console app using C#](../../csharp/tutorials/console-webapiclient.md)
- [Networking telemetry in .NET](networking-telemetry.md)
- [Networking telemetry in .NET](telemetry/overview.md)
- [.NET Networking improvements](https://devblogs.microsoft.com/dotnet/dotnet-6-networking-improvements)
155 changes: 155 additions & 0 deletions docs/fundamentals/networking/telemetry/event-counters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: Networking Event Counters
description: Learn how to consume .NET networking event counters.
author: MihaZupan
ms.author: mizupan
ms.date: 10/18/2022
---

# Networking event counters in .NET

[EventCounters] are .NET APIs used for lightweight, cross-platform, and near real-time performance metric collection.

Networking components are instrumented to publish basic diagnostic information using EventCounters.
They include information like the following:

- `System.Net.Http` > `requests-started`
- `System.Net.Http` > `requests-failed`
- `System.Net.Http` > `http11-connections-current-total`
- `System.Net.Security` > `all-tls-sessions-open`
- `System.Net.Sockets` > `outgoing-connections-established`
- `System.Net.NameResolution` > `dns-lookups-duration`

> [!TIP]
> For the full list, see [well-known counters].

> [!TIP]
> On projects targeting .NET 8+, consider using the newer and more feature-rich [networking metrics] instead of EventCounters.

## Providers

Networking information is split across the following providers:

- `System.Net.Http` (`HttpClient` and `SocketsHttpHandler`)
- `System.Net.NameResolution` (`Dns`)
- `System.Net.Security` (`SslStream`)
- `System.Net.Sockets`
- `Microsoft.AspNetCore.Hosting`
- `Microsoft-AspNetCore-Server-Kestrel`

The telemetry has some performance overhead when enabled, so make sure to subscribe only to providers you're actually interested in.

## Monitor event counters from outside the process

### dotnet-counters

[`dotnet-counters`][dotnet-counter docs] is a cross-platform performance monitoring tool for ad-hoc health monitoring and first-level performance investigation.

```dotnetcli
dotnet tool install --global dotnet-counters
```

```dotnetcli
dotnet-counters monitor --counters System.Net.Http,System.Net.Security --process-id 1234
```

The command continually refreshes the console with the latest numbers.

```txt
[System.Net.Http]
Current Http 1.1 Connections 3
Current Http 2.0 Connections 1
Current Http 3.0 Connections 0
Current Requests 4
HTTP 1.1 Requests Queue Duration (ms) 0
HTTP 2.0 Requests Queue Duration (ms) 0
HTTP 3.0 Requests Queue Duration (ms) 0
Requests Failed 0
Requests Failed Rate (Count / 1 sec) 0
Requests Started 470
Requests Started Rate (Count / 1 sec) 18
```

For all the available commands and parameters, see the [dotnet-counter docs].

### Application Insights

Application Insights does not collect event counters by default.
For information on customizing the set of counters you're interested in, see the [AppInsights EventCounters docs].

For example:

```C#
services.ConfigureTelemetryModule<EventCounterCollectionModule>((module, options) =>
{
module.Counters.Add(new EventCounterCollectionRequest("System.Net.Http", "current-requests"));
module.Counters.Add(new EventCounterCollectionRequest("System.Net.Http", "requests-failed"));
module.Counters.Add(new EventCounterCollectionRequest("System.Net.Http", "http11-connections-current-total"));
module.Counters.Add(new EventCounterCollectionRequest("System.Net.Security", "all-tls-sessions-open"));
});
```

For an example of how to subscribe to many runtime and ASP.NET event counters, see the [RuntimeEventCounters sample](https://github.com/dotnet/docs/tree/main/docs/fundamentals/networking/snippets/misc/RuntimeEventCounters.cs). Simply add an `EventCounterCollectionRequest` for every entry.

```C#
foreach (var (eventSource, counters) in RuntimeEventCounters.EventCounters)
{
foreach (string counter in counters)
{
module.Counters.Add(new EventCounterCollectionRequest(eventSource, counter));
}
}
```

## Consume event counters in-process

The [`Yarp.Telemetry.Consumption`] library makes it easy to consume event counters from within the process.
While the package is currently maintained as part of the [YARP] project, it can be used in any .NET application.

To use it, implement the `IMetricsConsumer<TMetrics>` interface:

```C#
public sealed class MyMetricsConsumer : IMetricsConsumer<SocketsMetrics>
{
public void OnMetrics(SocketsMetrics previous, SocketsMetrics current)
{
var elapsedTime = (current.Timestamp - previous.Timestamp).TotalMilliseconds;
Console.WriteLine($"Received {current.BytesReceived - previous.BytesReceived} bytes in the last {elapsedTime:N2} ms");
}
}
```

Then register the implementations with your DI container:

```C#
services.AddSingleton<IMetricsConsumer<SocketsMetrics>, MyMetricsConsumer>();
services.AddTelemetryListeners();
```

The library provides the following strongly typed metrics types:

- [`HttpMetrics`]
- [`NameResolutionMetrics`]
- [`NetSecurityMetrics`]
- [`SocketsMetrics`]
- [`KestrelMetrics`]

## Need more telemetry?

If you have suggestions for other useful information that could be exposed via events or metrics, create a [dotnet/runtime issue](https://github.com/dotnet/runtime/issues/new).

If you're using the [`Yarp.Telemetry.Consumption`] library and have any suggestions, create a [microsoft/reverse-proxy issue].

[networking metrics]: ./metrics.md
[EventCounters]: ../../../core/diagnostics/event-counters.md
[well-known counters]: ../../../core/diagnostics/available-counters.md
[dotnet-counter docs]: ../../../core/diagnostics/dotnet-counters.md
[AppInsights EventCounters docs]: /azure/azure-monitor/app/eventcounters
[YARP]: https://github.com/microsoft/reverse-proxy
[`Yarp.Telemetry.Consumption`]: https://www.nuget.org/packages/Yarp.Telemetry.Consumption
[`HttpMetrics`]: https://github.com/microsoft/reverse-proxy/blob/main/src/TelemetryConsumption/Http/HttpMetrics.cs
[`NameResolutionMetrics`]: https://github.com/microsoft/reverse-proxy/blob/main/src/TelemetryConsumption/NameResolution/NameResolutionMetrics.cs
[`NetSecurityMetrics`]: https://github.com/microsoft/reverse-proxy/blob/main/src/TelemetryConsumption/NetSecurity/NetSecurityMetrics.cs
[`SocketsMetrics`]: https://github.com/microsoft/reverse-proxy/blob/main/src/TelemetryConsumption/Sockets/SocketsMetrics.cs
[`KestrelMetrics`]: https://github.com/microsoft/reverse-proxy/blob/main/src/TelemetryConsumption/Kestrel/KestrelMetrics.cs
[microsoft/reverse-proxy issue]: https://github.com/microsoft/reverse-proxy/issues/new
Loading
Loading