Skip to content

Commit f29b99b

Browse files
[AzureMonitorDistro] Rename public API to AddAzureMonitor (#34672)
* Rename public API to AddAzureMonitor * change comment
1 parent 58a969f commit f29b99b

File tree

8 files changed

+80
-80
lines changed

8 files changed

+80
-80
lines changed

sdk/monitor/Azure.Monitor.OpenTelemetry/api/Azure.Monitor.OpenTelemetry.netstandard2.0.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
namespace Azure.Monitor.OpenTelemetry
22
{
3-
public static partial class AzureMonitorOpenTelemetryExtensions
3+
public static partial class AzureMonitorExtensions
44
{
5-
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services) { throw null; }
6-
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Azure.Monitor.OpenTelemetry.AzureMonitorOpenTelemetryOptions options) { throw null; }
7-
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitorOpenTelemetry(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Azure.Monitor.OpenTelemetry.AzureMonitorOpenTelemetryOptions> configureAzureMonitorOpenTelemetry) { throw null; }
5+
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitor(this Microsoft.Extensions.DependencyInjection.IServiceCollection services) { throw null; }
6+
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitor(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, Azure.Monitor.OpenTelemetry.AzureMonitorOptions options) { throw null; }
7+
public static Microsoft.Extensions.DependencyInjection.IServiceCollection AddAzureMonitor(this Microsoft.Extensions.DependencyInjection.IServiceCollection services, System.Action<Azure.Monitor.OpenTelemetry.AzureMonitorOptions> configureAzureMonitor) { throw null; }
88
}
9-
public partial class AzureMonitorOpenTelemetryOptions
9+
public partial class AzureMonitorOptions
1010
{
11-
public AzureMonitorOpenTelemetryOptions() { }
11+
public AzureMonitorOptions() { }
1212
public string ConnectionString { get { throw null; } set { } }
1313
public Azure.Core.TokenCredential Credential { get { throw null; } set { } }
1414
public bool DisableOfflineStorage { get { throw null; } set { } }
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using System;
5+
using Microsoft.Extensions.DependencyInjection;
6+
using Microsoft.Extensions.DependencyInjection.Extensions;
7+
using Microsoft.Extensions.Options;
8+
9+
namespace Azure.Monitor.OpenTelemetry
10+
{
11+
/// <summary>
12+
/// Extension methods for setting up Azure Monitor in an <see cref="IServiceCollection" />.
13+
/// </summary>
14+
public static class AzureMonitorExtensions
15+
{
16+
/// <summary>
17+
/// Adds Azure Monitor into service collection.
18+
/// </summary>
19+
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
20+
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
21+
public static IServiceCollection AddAzureMonitor(this IServiceCollection services)
22+
{
23+
services.TryAddSingleton<IConfigureOptions<AzureMonitorOptions>,
24+
DefaultAzureMonitorOptions>();
25+
return services.AddAzureMonitor(o => o = new AzureMonitorOptions());
26+
}
27+
28+
/// <summary>
29+
/// Adds Azure Monitor into service collection.
30+
/// </summary>
31+
/// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
32+
/// <param name="options">The <see cref="AzureMonitorOptions" /> instance for configuration.</param>
33+
/// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
34+
public static IServiceCollection AddAzureMonitor(this IServiceCollection services, AzureMonitorOptions options)
35+
{
36+
options ??= new AzureMonitorOptions();
37+
return services.AddAzureMonitor(o => o.Clone(options));
38+
}
39+
40+
/// <summary>
41+
/// Adds Azure Monitor into service collection.
42+
/// </summary>
43+
/// <param name="services"><see cref="IServiceCollection"/>.</param>
44+
/// <param name="configureAzureMonitor">Callback action for configuring <see cref="AzureMonitorOptions"/>.</param>
45+
/// <returns><see cref="IServiceCollection"/>.</returns>
46+
public static IServiceCollection AddAzureMonitor(this IServiceCollection services, Action<AzureMonitorOptions> configureAzureMonitor)
47+
{
48+
return AzureMonitorImplementations.AddAzureMonitorWithAction(services, configureAzureMonitor);
49+
}
50+
}
51+
}
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@
1212

1313
namespace Azure.Monitor.OpenTelemetry
1414
{
15-
internal class AzureMonitorOpenTelemetryImplementations
15+
internal class AzureMonitorImplementations
1616
{
17-
internal static IServiceCollection AddAzureMonitorOpenTelemetryWithAction(IServiceCollection services, Action<AzureMonitorOpenTelemetryOptions> configureAzureMonitorOpenTelemetry)
17+
internal static IServiceCollection AddAzureMonitorWithAction(IServiceCollection services, Action<AzureMonitorOptions> configureAzureMonitor)
1818
{
1919
if (services == null)
2020
{
2121
throw new ArgumentNullException(nameof(services));
2222
}
2323

24-
if (configureAzureMonitorOpenTelemetry != null)
24+
if (configureAzureMonitor != null)
2525
{
26-
services.Configure(configureAzureMonitorOpenTelemetry);
26+
services.Configure(configureAzureMonitor);
2727
}
2828

2929
var builder = services.AddOpenTelemetry();
@@ -42,10 +42,10 @@ internal static IServiceCollection AddAzureMonitorOpenTelemetryWithAction(IServi
4242

4343
services.AddLogging(logging =>
4444
{
45-
AzureMonitorOpenTelemetryOptions logExporterOptions = new();
46-
if (configureAzureMonitorOpenTelemetry != null)
45+
AzureMonitorOptions logExporterOptions = new();
46+
if (configureAzureMonitor != null)
4747
{
48-
configureAzureMonitorOpenTelemetry(logExporterOptions);
48+
configureAzureMonitor(logExporterOptions);
4949
}
5050

5151
if (logExporterOptions.EnableLogs)
@@ -95,7 +95,7 @@ internal static IServiceCollection AddAzureMonitorOpenTelemetryWithAction(IServi
9595

9696
services.AddSingleton(sp =>
9797
{
98-
var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOpenTelemetryOptions>>().Get("");
98+
var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOptions>>().Get("");
9999
if (!options.EnableTraces)
100100
{
101101
return new NoopTracerProvider();
@@ -111,7 +111,7 @@ internal static IServiceCollection AddAzureMonitorOpenTelemetryWithAction(IServi
111111

112112
services.AddSingleton(sp =>
113113
{
114-
var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOpenTelemetryOptions>>().Get("");
114+
var options = sp.GetRequiredService<IOptionsMonitor<AzureMonitorOptions>>().Get("");
115115
if (!options.EnableMetrics)
116116
{
117117
return new NoopMeterProvider();

sdk/monitor/Azure.Monitor.OpenTelemetry/src/AzureMonitorOpenTelemetryExtensions.cs

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
namespace Azure.Monitor.OpenTelemetry
1313
{
1414
/// <summary>
15-
/// Options that allow users to configure the Azure Monitor OpenTelemetry.
15+
/// Options that allow users to configure the Azure Monitor.
1616
/// </summary>
17-
public class AzureMonitorOpenTelemetryOptions
17+
public class AzureMonitorOptions
1818
{
1919
/// <summary>
2020
/// The Connection String provides users with a single configuration setting to identify the Azure Monitor resource and endpoint.
@@ -59,7 +59,7 @@ public class AzureMonitorOpenTelemetryOptions
5959
/// </summary>
6060
public string StorageDirectory { get; set; }
6161

62-
internal AzureMonitorOpenTelemetryOptions Clone(AzureMonitorOpenTelemetryOptions options)
62+
internal AzureMonitorOptions Clone(AzureMonitorOptions options)
6363
{
6464
if (options != null)
6565
{
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@
77

88
namespace Azure.Monitor.OpenTelemetry
99
{
10-
internal class DefaultAzureMonitorOpenTelemetryOptions : IConfigureOptions<AzureMonitorOpenTelemetryOptions>
10+
internal class DefaultAzureMonitorOptions : IConfigureOptions<AzureMonitorOptions>
1111
{
12-
private const string AzureMonitorOpenTelemetrySectionFromConfig = "AzureMonitorOpenTelemetry";
12+
private const string AzureMonitorSectionFromConfig = "AzureMonitor";
1313
private const string ConnectionStringEnvironmentVariable = "APPLICATIONINSIGHTS_CONNECTION_STRING";
1414
private readonly IConfiguration? _configuration;
1515

1616
/// <summary>
17-
/// Initializes a new instance of the <see cref="DefaultAzureMonitorOpenTelemetryOptions"/> class.
17+
/// Initializes a new instance of the <see cref="DefaultAzureMonitorOptions"/> class.
1818
/// </summary>
19-
/// <param name="configuration"><see cref="IConfiguration"/> from which configuration for ApplicationInsights can be retrieved.</param>
20-
public DefaultAzureMonitorOpenTelemetryOptions(IConfiguration? configuration = null)
19+
/// <param name="configuration"><see cref="IConfiguration"/> from which configuration for Azure Monitor can be retrieved.</param>
20+
public DefaultAzureMonitorOptions(IConfiguration? configuration = null)
2121
{
2222
_configuration = configuration;
2323
}
2424

25-
public void Configure(AzureMonitorOpenTelemetryOptions options)
25+
public void Configure(AzureMonitorOptions options)
2626
{
2727
if (_configuration != null)
2828
{
29-
_configuration.GetSection(AzureMonitorOpenTelemetrySectionFromConfig).Bind(options);
29+
_configuration.GetSection(AzureMonitorSectionFromConfig).Bind(options);
3030
}
3131

3232
string connectionString = Environment.GetEnvironmentVariable(ConnectionStringEnvironmentVariable);

sdk/monitor/Azure.Monitor.OpenTelemetry/tests/Azure.Monitor.OpenTelemetry.Demo/Program.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111

1212
var builder = WebApplication.CreateBuilder(args);
1313

14-
builder.Services.AddAzureMonitorOpenTelemetry();
14+
builder.Services.AddAzureMonitor();
1515
/*
16-
builder.Services.AddAzureMonitorOpenTelemetry(o =>
16+
builder.Services.AddAzureMonitor(o =>
1717
{
1818
o.ConnectionString = "InstrumentationKey=00000000-0000-0000-0000-000000000000";
1919
// Set the Credential property to enable AAD based authentication:
@@ -24,7 +24,7 @@
2424
// To customize sampling, Set ApplicationInsightsSampler to desired sampling ratio and
2525
// configure with OpenTelemetryTracerProvider.
2626
// Please note that ConfigureOpenTelemetryTracerProvider should be called after
27-
// builder.Services.AddAzureMonitorOpenTelemetry().
27+
// builder.Services.AddAzureMonitor().
2828
builder.Services.ConfigureOpenTelemetryTracerProvider((sp, builder) => builder.SetSampler(new ApplicationInsightsSampler(0.9F)));
2929

3030
var app = builder.Build();
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"AzureMonitorOpenTelemetry": {
2+
"AzureMonitor": {
33
"ConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000123"
44
}
55
}

0 commit comments

Comments
 (0)