Microsoft.Extensions.AmbientMetadata.Application 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.
Showing the top 20 packages that depend on Microsoft.Extensions.AmbientMetadata.Application.
| Packages | Downloads |
|---|---|
|
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions.
|
1 |
.NET Framework 4.6.2
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
.NET 8.0
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
.NET 9.0
- Microsoft.Extensions.Configuration (>= 9.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.0)
| Version | Downloads | Last updated |
|---|---|---|
| 9.0.0 | 1 | 11/29/2024 |
| 9.0.0-preview.9.24507.7 | 0 | 10/08/2024 |
| 9.0.0-preview.8.24460.1 | 1 | 11/29/2024 |
| 9.0.0-preview.7.24412.10 | 0 | 08/14/2024 |
| 9.0.0-preview.6.24353.1 | 1 | 11/29/2024 |
| 9.0.0-preview.5.24311.7 | 1 | 11/29/2024 |
| 9.0.0-preview.4.24271.2 | 1 | 11/29/2024 |
| 9.0.0-preview.3.24209.3 | 1 | 11/29/2024 |
| 9.0.0-preview.2.24157.4 | 0 | 03/12/2024 |
| 9.0.0-preview.1.24108.1 | 1 | 11/29/2024 |
| 8.10.0 | 1 | 11/29/2024 |
| 8.9.1 | 1 | 11/29/2024 |
| 8.9.0 | 1 | 11/29/2024 |
| 8.8.0 | 1 | 11/29/2024 |
| 8.7.0 | 1 | 11/29/2024 |
| 8.6.0 | 1 | 11/29/2024 |
| 8.5.0 | 1 | 11/29/2024 |
| 8.4.0 | 1 | 11/29/2024 |
| 8.3.0 | 0 | 03/12/2024 |
| 8.2.0 | 0 | 02/13/2024 |
| 8.1.0 | 1 | 11/29/2024 |
| 8.0.0 | 0 | 11/14/2023 |
| 8.0.0-rc.2.23510.2 | 0 | 10/10/2023 |
| 8.0.0-rc.1.23453.1 | 1 | 11/29/2024 |
| 8.0.0-preview.7.23407.5 | 0 | 08/08/2023 |
| 8.0.0-preview.6.23360.2 | 1 | 11/29/2024 |
| 8.0.0-preview.5.23308.3 | 2 | 11/29/2024 |
| 8.0.0-preview.4.23273.7 | 1 | 11/29/2024 |