[Monitor Ingestion] Api changes and abort test fixes (#24885)

Author: KarishmaGhiya

sdk/monitor/monitor-ingestion/CHANGELOG.md

@@ -4,16 +4,16 @@
 
 ### Features Added
 
-- Added an error callback functionality for inspecting individual log uploads via `UploadLogsOptions`.
+- Added an error callback functionality for inspecting individual log uploads via `LogsUploadOptions`.
 
 ### Breaking Changes
 
-- The `upload` API throws an `AggregateUploadLogsError` in case of an error and returns `void` when operation succeeds.
-- Renamed `UploadLogsError` to `UploadLogsFailure`.
+- The `upload` API throws an `AggregateLogsUploadError` in case of an error and returns `void` when operation succeeds.
+- Renamed `LogsUploadError` to `LogsUploadFailure`.
 
 ### Other Changes
 
-- `UploadLogsOptions` supports the `OperationOptions` from @azure/core-client, allowing users to abort operations when needed.
+- `LogsUploadOptions` supports the `OperationOptions` from @azure/core-client, allowing users to abort operations when needed.
 - Added samples for all error handling scenarios.
 ## 1.0.0-beta.3 (2022-10-13)
 

sdk/monitor/monitor-ingestion/README.md

@@ -89,7 +89,7 @@ You can familiarize yourself with different APIs using [Samples](https://github.
 You can create a client and call the client's `Upload` method. Take note of the data ingestion [limits](https://learn.microsoft.com/azure/azure-monitor/service-limits#custom-logs).
 
 ```js
-const { isAggregateUploadLogsError, DefaultAzureCredential } = require("@azure/identity");
+const { isAggregateLogsUploadError, DefaultAzureCredential } = require("@azure/identity");
 const { LogsIngestionClient } = require("@azure/monitor-ingestion");
 
 require("dotenv").config();
@@ -116,7 +116,7 @@ async function main() {
     await client.upload(ruleId, streamName, logs);
   }
   catch(e){
-    let aggregateErrors = isAggregateUploadLogsError(e) ? e.errors : [];
+    let aggregateErrors = isAggregateLogsUploadError(e) ? e.errors : [];
     if (aggregateErrors.length > 0) {
       console.log("Some logs have failed to complete ingestion");
       for (const error of aggregateErrors) {
@@ -192,7 +192,7 @@ When uploading more than 1MB of logs in a single call to the `upload` method on
 
 ```js
 const { DefaultAzureCredential } = require("@azure/identity");
-const { isAggregateUploadLogsError, LogsIngestionClient } = require("@azure/monitor-ingestion");
+const { isAggregateLogsUploadError, LogsIngestionClient } = require("@azure/monitor-ingestion");
 
 require("dotenv").config();
 
@@ -218,7 +218,7 @@ async function main() {
     await client.upload(ruleId, streamName, logs, { maxConcurrency: 1 });
   }
   catch(e){
-    let aggregateErrors = isAggregateUploadLogsError(e) ? e.errors : [];
+    let aggregateErrors = isAggregateLogsUploadError(e) ? e.errors : [];
     if (aggregateErrors.length > 0) {
       console.log("Some logs have failed to complete ingestion");
       for (const error of aggregateErrors) {

sdk/monitor/monitor-ingestion/recordings/browsers/logsingestionclient_live_tests/recording_user_abort_additional_processing_early_if_they_handle_the_error.json

@@ -9,21 +9,21 @@ import { OperationOptions } from '@azure/core-client';
 import { TokenCredential } from '@azure/core-auth';
 
 // @public
-export class AggregateUploadLogsError extends Error {
-    constructor(errors: UploadLogsFailure[], errorMessage?: string);
-    errors: UploadLogsFailure[];
+export class AggregateLogsUploadError extends Error {
+    constructor(errors: LogsUploadFailure[], errorMessage?: string);
+    errors: LogsUploadFailure[];
 }
 
 // @public
-export const AggregateUploadLogsErrorName = "AggregateUploadLogsError";
+export const AggregateLogsUploadErrorName = "AggregateLogsUploadError";
 
 // @public
-export function isAggregateUploadLogsError(e: unknown): e is AggregateUploadLogsError;
+export function isAggregateLogsUploadError(e: unknown): e is AggregateLogsUploadError;
 
 // @public
 export class LogsIngestionClient {
     constructor(endpoint: string, tokenCredential: TokenCredential, options?: LogsIngestionClientOptions);
-    upload(ruleId: string, streamName: string, logs: Record<string, unknown>[], options?: UploadLogsOptions): Promise<void>;
+    upload(ruleId: string, streamName: string, logs: Record<string, unknown>[], options?: LogsUploadOptions): Promise<void>;
 }
 
 // @public
@@ -32,15 +32,15 @@ export interface LogsIngestionClientOptions extends CommonClientOptions {
 }
 
 // @public
-export interface UploadLogsFailure {
+export interface LogsUploadFailure {
     cause: Error;
     failedLogs: Record<string, unknown>[];
 }
 
 // @public
-export interface UploadLogsOptions extends OperationOptions {
+export interface LogsUploadOptions extends OperationOptions {
     maxConcurrency?: number;
-    onError?: (uploadLogsError: UploadLogsFailure) => void;
+    onError?: (uploadLogsError: LogsUploadFailure) => void;
 }
 
 ```

sdk/monitor/monitor-ingestion/recordings/node/logsingestionclient_live_tests/recording_user_abort_additional_processing_early_if_they_handle_the_error.json

@@ -7,7 +7,7 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { isAggregateUploadLogsError, LogsIngestionClient } from "@azure/monitor-ingestion";
+import { isAggregateLogsUploadError, LogsIngestionClient } from "@azure/monitor-ingestion";
 
 require("dotenv").config();
 
@@ -33,7 +33,7 @@ async function main() {
   try {
     await client.upload(ruleId, streamName, logs);
   } catch (e) {
-    if (isAggregateUploadLogsError(e)) {
+    if (isAggregateLogsUploadError(e)) {
       let aggregateErrors = e.errors;
       if (aggregateErrors.length > 0) {
         console.log(

sdk/monitor/monitor-ingestion/review/monitor-ingestion.api.md

@@ -8,9 +8,9 @@
 
 import { DefaultAzureCredential } from "@azure/identity";
 import {
-  isAggregateUploadLogsError,
+  isAggregateLogsUploadError,
   LogsIngestionClient,
-  UploadLogsFailure,
+  LogsUploadFailure,
 } from "@azure/monitor-ingestion";
 
 require("dotenv").config();
@@ -22,7 +22,7 @@ async function main() {
   const client = new LogsIngestionClient(logsIngestionEndpoint, credential);
   let abortController = new AbortController();
 
-  function errorCallback(uploadLogsError: UploadLogsFailure) {
+  function errorCallback(uploadLogsError: LogsUploadFailure) {
     if (
       (uploadLogsError.cause as Error).message ===
       "Data collection rule with immutable Id 'immutable-id-123' not found."
@@ -48,7 +48,7 @@ async function main() {
       abortSignal: abortController.signal,
     });
   } catch (e) {
-    if (isAggregateUploadLogsError(e)) {
+    if (isAggregateLogsUploadError(e)) {
       let aggregateErrors = e.errors;
       if (aggregateErrors.length > 0) {
         console.log(

sdk/monitor/monitor-ingestion/samples-dev/defaultConcurrency.ts

@@ -6,7 +6,7 @@
  * The user can track failed log entries and the associated error message via the AggregateUploadLogsError Object
  */
 
-import { isAggregateUploadLogsError, LogsIngestionClient } from "@azure/monitor-ingestion";
+import { isAggregateLogsUploadError, LogsIngestionClient } from "@azure/monitor-ingestion";
 import { DefaultAzureCredential } from "@azure/identity";
 
 import * as dotenv from "dotenv";
@@ -24,7 +24,7 @@ export async function main() {
     });
     console.log("All the logs provided are successfully ingested");
   } catch (e) {
-    let aggregateErrors = isAggregateUploadLogsError(e) ? e.errors : [];
+    let aggregateErrors = isAggregateLogsUploadError(e) ? e.errors : [];
     if (aggregateErrors.length > 0) {
       console.log("Some logs have failed to complete ingestion");
       for (const error of aggregateErrors) {

sdk/monitor/monitor-ingestion/samples-dev/earlyAborting.ts

@@ -6,7 +6,7 @@
  * The user can track failed log entries and the associated error message via the AggregateUploadLogsError Object.
  */
 import { DefaultAzureCredential } from "@azure/identity";
-import { isAggregateUploadLogsError, LogsIngestionClient } from "@azure/monitor-ingestion";
+import { isAggregateLogsUploadError, LogsIngestionClient } from "@azure/monitor-ingestion";
 
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -32,7 +32,7 @@ export async function main() {
   try {
     await client.upload(ruleId, streamName, logs);
   } catch (e) {
-    let aggregateErrors = isAggregateUploadLogsError(e) ? e.errors : [];
+    let aggregateErrors = isAggregateLogsUploadError(e) ? e.errors : [];
     console.log(
       "Some logs have failed to complete ingestion. Length of errors =",
       aggregateErrors.length

sdk/monitor/monitor-ingestion/samples-dev/logsIngestionClient.ts

@@ -6,7 +6,7 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { isAggregateUploadLogsError, LogsIngestionClient } from "@azure/monitor-ingestion";
+import { isAggregateLogsUploadError, LogsIngestionClient } from "@azure/monitor-ingestion";
 
 require("dotenv").config();
 
@@ -31,7 +31,7 @@ async function main() {
   try {
     await client.upload(ruleId, streamName, logs, { maxConcurrency: 1 });
   } catch (e) {
-    if (isAggregateUploadLogsError(e)) {
+    if (isAggregateLogsUploadError(e)) {
       let aggregateErrors = e.errors;
       console.log(
         "Some logs have failed to complete ingestion. Length of errors =",