Skip to content

Commit

Permalink
Rename TelemetryResilienceStrategyOptions to TelemetryOptions
Browse files Browse the repository at this point in the history
  • Loading branch information
martintmk committed Jun 16, 2023
1 parent 488bc10 commit 637bd21
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion bench/Polly.Core.Benchmarks/TelemetryBenchmark.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ private ResilienceStrategy Build(ResilienceStrategyBuilder builder)

if (Telemetry)
{
TelemetryResilienceStrategyOptions options = new() { LoggerFactory = NullLoggerFactory.Instance };
TelemetryOptions options = new() { LoggerFactory = NullLoggerFactory.Instance };

if (Enrichment)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ private static IServiceCollection AddResilienceStrategyRegistry<TKey>(this IServ
private static void AddResilienceStrategyBuilder(this IServiceCollection services)
{
services
.AddOptions<TelemetryResilienceStrategyOptions>()
.AddOptions<TelemetryOptions>()
.Configure<IServiceProvider>((options, serviceProvider) =>
{
options.LoggerFactory = serviceProvider.GetService<ILoggerFactory>() ?? NullLoggerFactory.Instance;
Expand All @@ -219,7 +219,7 @@ private static void AddResilienceStrategyBuilder(this IServiceCollection service
{
var builder = new ResilienceStrategyBuilder();
builder.Properties.Set(PollyDependencyInjectionKeys.ServiceProvider, serviceProvider);
builder.EnableTelemetry(serviceProvider.GetRequiredService<IOptions<TelemetryResilienceStrategyOptions>>().Value);
builder.EnableTelemetry(serviceProvider.GetRequiredService<IOptions<TelemetryOptions>>().Value);
return builder;
});
}
Expand Down
2 changes: 1 addition & 1 deletion src/Polly.Extensions/Telemetry/EnrichmentContext.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Polly.Extensions.Telemetry;

/// <summary>
/// Enrichment context used when reporting resilience telemetry. This context is passed to the registered enrichers in <see cref="TelemetryResilienceStrategyOptions.Enrichers"/>.
/// Enrichment context used when reporting resilience telemetry. This context is passed to the registered enrichers in <see cref="TelemetryOptions.Enrichers"/>.
/// </summary>
public sealed partial class EnrichmentContext
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class ResilienceTelemetryDiagnosticSource : DiagnosticSource
private readonly ILogger _logger;
private readonly List<Action<EnrichmentContext>> _enrichers;

public ResilienceTelemetryDiagnosticSource(TelemetryResilienceStrategyOptions options)
public ResilienceTelemetryDiagnosticSource(TelemetryOptions options)
{
_enrichers = options.Enrichers.ToList();
_logger = options.LoggerFactory.CreateLogger(TelemetryUtil.PollyDiagnosticSource);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Polly.Extensions.Telemetry;
/// <summary>
/// The options that are used to configure the telemetry that is produced by the resilience strategies.
/// </summary>
public class TelemetryResilienceStrategyOptions
public class TelemetryOptions
{
/// <summary>
/// Gets or sets the logger factory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public static TBuilder EnableTelemetry<TBuilder>(this TBuilder builder, ILoggerF
Guard.NotNull(builder);
Guard.NotNull(loggerFactory);

return builder.EnableTelemetry(new TelemetryResilienceStrategyOptions { LoggerFactory = loggerFactory });
return builder.EnableTelemetry(new TelemetryOptions { LoggerFactory = loggerFactory });
}

/// <summary>
Expand All @@ -43,7 +43,7 @@ public static TBuilder EnableTelemetry<TBuilder>(this TBuilder builder, ILoggerF
/// Additionally, the telemetry strategy that logs and meters the executions is added to the beginning of the strategy pipeline.
/// </remarks>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="builder"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
public static TBuilder EnableTelemetry<TBuilder>(this TBuilder builder, TelemetryResilienceStrategyOptions options)
public static TBuilder EnableTelemetry<TBuilder>(this TBuilder builder, TelemetryOptions options)
where TBuilder : ResilienceStrategyBuilderBase
{
Guard.NotNull(builder);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public void AddResilienceStrategy_EnsureTelemetryEnabled(bool hasLogging)
var diagSource = telemetry!.GetType().GetProperty("DiagnosticSource", BindingFlags.Instance | BindingFlags.NonPublic)!.GetValue(telemetry);
diagSource.Should().BeOfType<ResilienceTelemetryDiagnosticSource>();

var factory = _services.BuildServiceProvider().GetRequiredService<IOptions<TelemetryResilienceStrategyOptions>>().Value.LoggerFactory;
var factory = _services.BuildServiceProvider().GetRequiredService<IOptions<TelemetryOptions>>().Value.LoggerFactory;

if (hasLogging)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public void Meter_Ok()
{
ResilienceTelemetryDiagnosticSource.Meter.Name.Should().Be("Polly");
ResilienceTelemetryDiagnosticSource.Meter.Version.Should().Be("1.0");
new ResilienceTelemetryDiagnosticSource(new TelemetryResilienceStrategyOptions())
new ResilienceTelemetryDiagnosticSource(new TelemetryOptions())
.Counter.Description.Should().Be("Tracks the number of resilience events that occurred in resilience strategies.");
}

Expand Down Expand Up @@ -207,7 +207,7 @@ public void WriteEvent_MeteringWithoutStrategyKey_Ok()

private ResilienceTelemetryDiagnosticSource Create(Action<ICollection<Action<EnrichmentContext>>>? configureEnrichers = null)
{
var options = new TelemetryResilienceStrategyOptions
var options = new TelemetryOptions
{
LoggerFactory = _loggerFactory
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

namespace Polly.Extensions.Tests.Telemetry;

public class TelemetryResilienceStrategyOptionsTests
public class TelemetryOptionsTests
{
[Fact]
public void Ctor_EnsureDefaults()
{
var options = new TelemetryResilienceStrategyOptions();
var options = new TelemetryOptions();

options.Enrichers.Should().BeEmpty();
options.LoggerFactory.Should().Be(NullLoggerFactory.Instance);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public void EnableTelemetry_EnsureLogging(bool generic)
public void EnableTelemetry_InvalidOptions_Throws()
{
_builder
.Invoking(b => b.EnableTelemetry(new TelemetryResilienceStrategyOptions
.Invoking(b => b.EnableTelemetry(new TelemetryOptions
{
LoggerFactory = null!,
})).Should()
Expand All @@ -66,7 +66,7 @@ The LoggerFactory field is required.
""");

_genericBuilder
.Invoking(b => b.EnableTelemetry(new TelemetryResilienceStrategyOptions
.Invoking(b => b.EnableTelemetry(new TelemetryOptions
{
LoggerFactory = null!,
})).Should()
Expand Down

0 comments on commit 637bd21

Please sign in to comment.