Microsoft.Extensions.AmbientMetadata.Application 8.5.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.
48
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions.
5
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions.
4
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions
3
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions.
3
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions
2
Microsoft.Extensions.Telemetry
Provides canonical implementations of telemetry abstractions.
2

Version Downloads Last updated
9.0.0 6 11/19/2024
9.0.0-preview.9.24507.7 5 10/16/2024
9.0.0-preview.8.24460.1 0 09/10/2024
9.0.0-preview.7.24412.10 2 09/04/2024
9.0.0-preview.6.24353.1 3 10/30/2024
9.0.0-preview.5.24311.7 2 06/28/2024
9.0.0-preview.4.24271.2 3 06/01/2024
9.0.0-preview.3.24209.3 2 06/01/2024
9.0.0-preview.2.24157.4 5 06/01/2024
9.0.0-preview.1.24108.1 1 03/07/2024
8.10.0 3 10/12/2024
8.9.1 4 09/07/2024
8.9.0 3 09/07/2024
8.8.0 2 08/15/2024
8.7.0 4 07/29/2024
8.6.0 2 06/28/2024
8.5.0 2 06/02/2024
8.4.0 2 06/06/2024
8.3.0 2 06/01/2024
8.2.0 47 03/12/2024
8.1.0 3 03/07/2024
8.0.0 3 03/07/2024
8.0.0-rc.2.23510.2 5 03/12/2024
8.0.0-rc.1.23453.1 3 03/07/2024
8.0.0-preview.7.23407.5 3 03/07/2024
8.0.0-preview.6.23360.2 3 03/07/2024
8.0.0-preview.5.23308.3 4 03/07/2024
8.0.0-preview.4.23273.7 2 03/08/2024