Microsoft.Extensions.AmbientMetadata.Application 9.0.0

Prefix Reserved
dotnet add package Microsoft.Extensions.AmbientMetadata.Application --version 9.0.0                
NuGet\Install-Package Microsoft.Extensions.AmbientMetadata.Application -Version 9.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.AmbientMetadata.Application" Version="9.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.AmbientMetadata.Application --version 9.0.0                
#r "nuget: Microsoft.Extensions.AmbientMetadata.Application, 9.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Extensions.AmbientMetadata.Application as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.AmbientMetadata.Application&version=9.0.0

// Install Microsoft.Extensions.AmbientMetadata.Application as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.AmbientMetadata.Application&version=9.0.0                

Microsoft.Extensions.AmbientMetadata.Application

This flows runtime information for application-level ambient metadata such as the version, deployment ring, environment, and name. This information can be useful to enrich telemetry.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.AmbientMetadata.Application

Or directly in the C# project file:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.AmbientMetadata.Application" Version="[CURRENTVERSION]" />
</ItemGroup>

Usage Example

Registering Services

The services can be registered using any of the following methods:

public static IHostBuilder UseApplicationMetadata(this IHostBuilder builder, string sectionName = DefaultSectionName)
public static IServiceCollection AddApplicationMetadata(this IServiceCollection services, Action<ApplicationMetadata> configure)

Configuration

When loading from configuration, the version and deployment ring metadata are read from the ambientmetadata:application section. The environment and application names are read from the IHostEnvironment.

{
  "AmbientMetadata" {
    "Application" {
      "BuildVersion": "1.0-alpha1.2346",
      "DeploymentRing": "InnerRing"
    }
  }
}

Consuming Services

The ApplicationMetadata can be injected wherever needed. For example:

public class MyClass
{
  public MyClass(IOptions<ApplicationMetadata> options) { Application = options.Value; }

  private ApplicationMetadata Application { get; }

  public void DoWork()
  {
    Log.LogEnvironment(Application.Version, Application.DeploymentRing, Application.Environment, Application.Name);
  }
}

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.Extensions.AmbientMetadata.Application:

Package Downloads
Microsoft.Extensions.Telemetry

Provides canonical implementations of telemetry abstractions.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Extensions.AmbientMetadata.Application:

Repository Stars
bradygaster/dotnet-cloud-native-build-2023
Version Downloads Last updated
9.0.0 470,550 11/12/2024
9.0.0-preview.9.24507.7 38,242 10/8/2024
9.0.0-preview.8.24460.1 19,902 9/10/2024
9.0.0-preview.7.24412.10 5,969 8/14/2024
9.0.0-preview.6.24353.1 4,955 7/10/2024
9.0.0-preview.5.24311.7 5,771 6/11/2024
9.0.0-preview.4.24271.2 7,418 5/21/2024
9.0.0-preview.3.24209.3 8,501 4/11/2024
9.0.0-preview.2.24157.4 3,540 3/12/2024
9.0.0-preview.1.24108.1 2,073 2/13/2024
8.10.0 1,205,807 10/8/2024
8.9.1 866,996 9/6/2024
8.9.0 47,730 9/5/2024
8.8.0 654,086 8/13/2024
8.7.0 1,028,925 7/10/2024
8.6.0 726,164 6/11/2024
8.5.0 880,198 5/14/2024
8.4.0 1,411,549 4/9/2024
8.3.0 559,397 3/12/2024
8.2.0 929,290 2/13/2024
8.1.0 421,486 1/9/2024
8.0.0 997,153 11/14/2023
8.0.0-rc.2.23510.2 5,211 10/10/2023
8.0.0-rc.1.23453.1 1,788 9/12/2023
8.0.0-preview.7.23407.5 1,434 8/8/2023
8.0.0-preview.6.23360.2 751 7/12/2023
8.0.0-preview.5.23308.3 2,897 6/14/2023
8.0.0-preview.4.23273.7 2,732 5/23/2023