Skip to content

Commit eb1d02c

Browse files
nisha-bhatianisha-bhatia
authored
[Azure.Monitor.Ingestion] Rename Options for GA (Azure#34090)
1 parent 3b9f967 commit eb1d02c

File tree

8 files changed

+41
-76
lines changed

8 files changed

+41
-76
lines changed

‎sdk/monitor/Azure.Monitor.Ingestion/api/Azure.Monitor.Ingestion.net461.cs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ public LogsIngestionClient(System.Uri endpoint, Azure.Core.TokenCredential crede
88
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } }
99
public virtual Azure.Response Upload(string ruleId, string streamName, Azure.Core.RequestContent content, string contentEncoding = null, Azure.RequestContext context = null) { throw null; }
1010
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync(string ruleId, string streamName, Azure.Core.RequestContent content, string contentEncoding = null, Azure.RequestContext context = null) { throw null; }
11-
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.UploadLogsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
12-
public virtual Azure.Response Upload<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.UploadLogsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
11+
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.LogsUploadOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
12+
public virtual Azure.Response Upload<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.LogsUploadOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
1313
}
1414
public partial class LogsIngestionClientOptions : Azure.Core.ClientOptions
1515
{
@@ -19,19 +19,19 @@ public enum ServiceVersion
1919
V2023_01_01 = 1,
2020
}
2121
}
22+
public partial class LogsUploadOptions
23+
{
24+
public LogsUploadOptions() { }
25+
public int MaxConcurrency { get { throw null; } set { } }
26+
public Azure.Core.Serialization.ObjectSerializer Serializer { get { throw null; } set { } }
27+
public event Azure.Core.SyncAsyncEventHandler<Azure.Monitor.Ingestion.UploadFailedEventArgs> UploadFailed { add { } remove { } }
28+
}
2229
public partial class UploadFailedEventArgs : Azure.SyncAsyncEventArgs
2330
{
24-
public UploadFailedEventArgs(System.Collections.Generic.List<object> failedLogs, System.Exception exception, bool isRunningSynchronously, System.Threading.CancellationToken cancellationToken) : base (default(bool), default(System.Threading.CancellationToken)) { }
31+
public UploadFailedEventArgs(System.Collections.Generic.IEnumerable<object> failedLogs, System.Exception exception, bool isRunningSynchronously, System.Threading.CancellationToken cancellationToken) : base (default(bool), default(System.Threading.CancellationToken)) { }
2532
public System.Exception Exception { get { throw null; } }
2633
public System.Collections.Generic.IReadOnlyList<object> FailedLogs { get { throw null; } }
2734
}
28-
public partial class UploadLogsOptions
29-
{
30-
public UploadLogsOptions() { }
31-
public int MaxConcurrency { get { throw null; } set { } }
32-
public Azure.Core.Serialization.ObjectSerializer Serializer { get { throw null; } set { } }
33-
public event Azure.Core.SyncAsyncEventHandler<Azure.Monitor.Ingestion.UploadFailedEventArgs> UploadFailedEventHandler { add { } remove { } }
34-
}
3535
}
3636
namespace Microsoft.Extensions.Azure
3737
{

‎sdk/monitor/Azure.Monitor.Ingestion/api/Azure.Monitor.Ingestion.net5.0.cs‎

Lines changed: 0 additions & 36 deletions
This file was deleted.

‎sdk/monitor/Azure.Monitor.Ingestion/api/Azure.Monitor.Ingestion.netstandard2.0.cs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ public LogsIngestionClient(System.Uri endpoint, Azure.Core.TokenCredential crede
88
public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } }
99
public virtual Azure.Response Upload(string ruleId, string streamName, Azure.Core.RequestContent content, string contentEncoding = null, Azure.RequestContext context = null) { throw null; }
1010
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync(string ruleId, string streamName, Azure.Core.RequestContent content, string contentEncoding = null, Azure.RequestContext context = null) { throw null; }
11-
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.UploadLogsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
12-
public virtual Azure.Response Upload<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.UploadLogsOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
11+
public virtual System.Threading.Tasks.Task<Azure.Response> UploadAsync<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.LogsUploadOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
12+
public virtual Azure.Response Upload<T>(string ruleId, string streamName, System.Collections.Generic.IEnumerable<T> logs, Azure.Monitor.Ingestion.LogsUploadOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
1313
}
1414
public partial class LogsIngestionClientOptions : Azure.Core.ClientOptions
1515
{
@@ -19,19 +19,19 @@ public enum ServiceVersion
1919
V2023_01_01 = 1,
2020
}
2121
}
22+
public partial class LogsUploadOptions
23+
{
24+
public LogsUploadOptions() { }
25+
public int MaxConcurrency { get { throw null; } set { } }
26+
public Azure.Core.Serialization.ObjectSerializer Serializer { get { throw null; } set { } }
27+
public event Azure.Core.SyncAsyncEventHandler<Azure.Monitor.Ingestion.UploadFailedEventArgs> UploadFailed { add { } remove { } }
28+
}
2229
public partial class UploadFailedEventArgs : Azure.SyncAsyncEventArgs
2330
{
24-
public UploadFailedEventArgs(System.Collections.Generic.List<object> failedLogs, System.Exception exception, bool isRunningSynchronously, System.Threading.CancellationToken cancellationToken) : base (default(bool), default(System.Threading.CancellationToken)) { }
31+
public UploadFailedEventArgs(System.Collections.Generic.IEnumerable<object> failedLogs, System.Exception exception, bool isRunningSynchronously, System.Threading.CancellationToken cancellationToken) : base (default(bool), default(System.Threading.CancellationToken)) { }
2532
public System.Exception Exception { get { throw null; } }
2633
public System.Collections.Generic.IReadOnlyList<object> FailedLogs { get { throw null; } }
2734
}
28-
public partial class UploadLogsOptions
29-
{
30-
public UploadLogsOptions() { }
31-
public int MaxConcurrency { get { throw null; } set { } }
32-
public Azure.Core.Serialization.ObjectSerializer Serializer { get { throw null; } set { } }
33-
public event Azure.Core.SyncAsyncEventHandler<Azure.Monitor.Ingestion.UploadFailedEventArgs> UploadFailedEventHandler { add { } remove { } }
34-
}
3535
}
3636
namespace Microsoft.Extensions.Azure
3737
{

‎sdk/monitor/Azure.Monitor.Ingestion/src/LogsIngestionClient.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ internal HttpMessage CreateUploadRequest(string ruleId, string streamName, Reque
8080
/// <param name="logEntries"></param>
8181
/// <param name="options"></param>
8282
/// <returns></returns>
83-
internal static IEnumerable<BatchedLogs> Batch<T>(IEnumerable<T> logEntries, UploadLogsOptions options = null)
83+
internal static IEnumerable<BatchedLogs> Batch<T>(IEnumerable<T> logEntries, LogsUploadOptions options = null)
8484
{
8585
// Create an ArrayBufferWriter as backing store for Utf8JsonWriter
8686
ArrayBufferWriter<byte> arrayBuffer = new ArrayBufferWriter<byte>(SingleUploadThreshold);
@@ -196,7 +196,7 @@ private static void WriteMemory(Utf8JsonWriter writer, ReadOnlyMemory<byte> memo
196196
/// ]]></code>
197197
/// </example>
198198
/// <remarks> See error response code and error response message for more detail. </remarks>
199-
public virtual Response Upload<T>(string ruleId, string streamName, IEnumerable<T> logs, UploadLogsOptions options = null, CancellationToken cancellationToken = default)
199+
public virtual Response Upload<T>(string ruleId, string streamName, IEnumerable<T> logs, LogsUploadOptions options = null, CancellationToken cancellationToken = default)
200200
{
201201
Argument.AssertNotNullOrEmpty(ruleId, nameof(ruleId));
202202
Argument.AssertNotNullOrEmpty(streamName, nameof(streamName));
@@ -205,7 +205,7 @@ public virtual Response Upload<T>(string ruleId, string streamName, IEnumerable<
205205
using var scope = ClientDiagnostics.CreateScope("LogsIngestionClient.Upload");
206206
Response response = null;
207207
List<Exception> exceptions = null;
208-
options ??= new UploadLogsOptions();
208+
options ??= new LogsUploadOptions();
209209
scope.Start();
210210

211211
// Keep track of the number of failed logs across batches
@@ -306,12 +306,12 @@ public virtual Response Upload<T>(string ruleId, string streamName, IEnumerable<
306306
/// ]]></code>
307307
/// </example>
308308
/// <remarks> See error response code and error response message for more detail. </remarks>
309-
public virtual async Task<Response> UploadAsync<T>(string ruleId, string streamName, IEnumerable<T> logs, UploadLogsOptions options = null, CancellationToken cancellationToken = default)
309+
public virtual async Task<Response> UploadAsync<T>(string ruleId, string streamName, IEnumerable<T> logs, LogsUploadOptions options = null, CancellationToken cancellationToken = default)
310310
{
311311
Argument.AssertNotNullOrEmpty(ruleId, nameof(ruleId));
312312
Argument.AssertNotNullOrEmpty(streamName, nameof(streamName));
313313
Argument.AssertNotNullOrEmpty(logs, nameof(logs));
314-
options ??= new UploadLogsOptions();
314+
options ??= new LogsUploadOptions();
315315

316316
using var scope = ClientDiagnostics.CreateScope("LogsIngestionClient.Upload");
317317

@@ -431,7 +431,7 @@ private static void ProcessCompletedTask((Task<Response> CurrentTask, List<objec
431431
}
432432
}
433433

434-
internal async Task<Exception> ProcessCompletedTaskEventHandlerAsync(Task<Response> completedTask, List<object> logs, UploadLogsOptions options, CancellationToken cancellationToken)
434+
internal async Task<Exception> ProcessCompletedTaskEventHandlerAsync(Task<Response> completedTask, List<object> logs, LogsUploadOptions options, CancellationToken cancellationToken)
435435
{
436436
UploadFailedEventArgs eventArgs;
437437
if (completedTask.Exception != null)

sdk/monitor/Azure.Monitor.Ingestion/src/Models/UploadLogsOptions.cs renamed to sdk/monitor/Azure.Monitor.Ingestion/src/Models/LogsUploadOptions.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace Azure.Monitor.Ingestion
1515
/// <summary>
1616
/// The options model to configure the request to upload logs to Azure Monitor.
1717
/// </summary>
18-
public class UploadLogsOptions
18+
public class LogsUploadOptions
1919
{
2020
/// <summary>
2121
/// The serializer to use to convert the log objects to JSON.
@@ -38,11 +38,11 @@ public int MaxConcurrency
3838
/// <summary>
3939
/// An optional EventHandler that provides the list of failed logs and the corresponding exception.
4040
/// </summary>
41-
public event SyncAsyncEventHandler<UploadFailedEventArgs> UploadFailedEventHandler;
41+
public event SyncAsyncEventHandler<UploadFailedEventArgs> UploadFailed;
4242

4343
internal virtual async Task InvokeEvent(UploadFailedEventArgs uploadFailedArgs)
4444
{
45-
await UploadFailedEventHandler.RaiseAsync(uploadFailedArgs, nameof(LogsIngestionClient), "Upload", uploadFailedArgs.ClientDiagnostics).ConfigureAwait(false);
45+
await UploadFailed.RaiseAsync(uploadFailedArgs, nameof(LogsIngestionClient), "Upload", uploadFailedArgs.ClientDiagnostics).ConfigureAwait(false);
4646
}
4747

4848
internal virtual async Task<Exception> OnUploadFailedAsync(UploadFailedEventArgs eventArgs)
@@ -79,6 +79,6 @@ internal static int AssertNotNegative(int argumentValue, string argumentName)
7979
return argumentValue;
8080
}
8181

82-
internal bool HasHandler => UploadFailedEventHandler != null;
82+
internal bool HasHandler => UploadFailed != null;
8383
}
8484
}

‎sdk/monitor/Azure.Monitor.Ingestion/src/Models/UploadFailedEventArgs.cs‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
using System;
55
using System.Collections.Generic;
6+
using System.Linq;
67
using System.Threading;
78
using Azure.Core.Pipeline;
89
using Azure.Core.Serialization;
@@ -22,7 +23,7 @@ public class UploadFailedEventArgs : SyncAsyncEventArgs
2223
/// <param name="isRunningSynchronously"></param>
2324
/// <param name="clientDiagnostics"></param>
2425
/// <param name="cancellationToken"></param>
25-
internal UploadFailedEventArgs(List<object> failedLogs, Exception exception, bool isRunningSynchronously, ClientDiagnostics clientDiagnostics, CancellationToken cancellationToken) : this (failedLogs, exception, isRunningSynchronously, cancellationToken)
26+
internal UploadFailedEventArgs(IEnumerable<object> failedLogs, Exception exception, bool isRunningSynchronously, ClientDiagnostics clientDiagnostics, CancellationToken cancellationToken) : this (failedLogs, exception, isRunningSynchronously, cancellationToken)
2627
{
2728
ClientDiagnostics = clientDiagnostics;
2829
}
@@ -34,9 +35,9 @@ internal UploadFailedEventArgs(List<object> failedLogs, Exception exception, boo
3435
/// <param name="exception"></param>
3536
/// <param name="isRunningSynchronously"></param>
3637
/// <param name="cancellationToken"></param>
37-
public UploadFailedEventArgs(List<object> failedLogs, Exception exception, bool isRunningSynchronously, CancellationToken cancellationToken) : base(isRunningSynchronously, cancellationToken)
38+
public UploadFailedEventArgs(IEnumerable<object> failedLogs, Exception exception, bool isRunningSynchronously, CancellationToken cancellationToken) : base(isRunningSynchronously, cancellationToken)
3839
{
39-
FailedLogs = failedLogs;
40+
FailedLogs = failedLogs.ToList();
4041
Exception = exception;
4142
}
4243

‎sdk/monitor/Azure.Monitor.Ingestion/tests/ErrorTest.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@ public async Task OneFailureWithEventHandler()
127127
});
128128

129129
// Make the request
130-
UploadLogsOptions options = new UploadLogsOptions();
130+
LogsUploadOptions options = new LogsUploadOptions();
131131
var cts = new CancellationTokenSource();
132132
bool isTriggered = false;
133-
options.UploadFailedEventHandler += Options_UploadFailed;
133+
options.UploadFailed += Options_UploadFailed;
134134
//await client.UploadAsync(TestEnvironment.DCRImmutableId, TestEnvironment.StreamName, entries, options, cts.Token).ConfigureAwait(false);
135135
await client.UploadAsync(TestEnvironment.DCRImmutableId, TestEnvironment.StreamName, entries, options).ConfigureAwait(false);
136136
Assert.IsTrue(isTriggered);
@@ -168,9 +168,9 @@ public async Task TwoFailuresWithEventHandler()
168168
});
169169

170170
// Make the request
171-
UploadLogsOptions options = new UploadLogsOptions();
171+
LogsUploadOptions options = new LogsUploadOptions();
172172
bool isTriggered = false;
173-
options.UploadFailedEventHandler += Options_UploadFailed;
173+
options.UploadFailed += Options_UploadFailed;
174174
await client.UploadAsync(TestEnvironment.DCRImmutableId, TestEnvironment.StreamName, entries, options).ConfigureAwait(false);
175175
Assert.IsTrue(isTriggered);
176176
Task Options_UploadFailed(UploadFailedEventArgs e)

‎sdk/monitor/Azure.Monitor.Ingestion/tests/MonitorIngestionLiveTest.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public async Task ConcurrencyMultiThread()
155155
LogsIngestionClient client = CreateClient(policy);
156156

157157
// Make the request
158-
UploadLogsOptions options = new UploadLogsOptions();
158+
LogsUploadOptions options = new LogsUploadOptions();
159159
options.MaxConcurrency = 10;
160160
Response response = await client.UploadAsync(TestEnvironment.DCRImmutableId, TestEnvironment.StreamName, GenerateEntries(8, Recording.Now.DateTime), options).ConfigureAwait(false);
161161
//Check the response
@@ -242,9 +242,9 @@ public async Task ValidInputWithEventHandler()
242242
var entries = GenerateEntries(200, Recording.Now.DateTime);
243243

244244
// Make the request
245-
UploadLogsOptions options = new UploadLogsOptions();
245+
LogsUploadOptions options = new LogsUploadOptions();
246246
bool isTriggered = false;
247-
options.UploadFailedEventHandler += Options_UploadFailed;
247+
options.UploadFailed += Options_UploadFailed;
248248
await client.UploadAsync(TestEnvironment.DCRImmutableId, TestEnvironment.StreamName, entries, options).ConfigureAwait(false);
249249
Assert.IsFalse(isTriggered);
250250
Task Options_UploadFailed(UploadFailedEventArgs e)

0 commit comments

Comments
 (0)