Merge pull request #4 from sxwei123/develop

Change response to proper object that contain error code and error message

README.md

@@ -29,3 +29,12 @@ client
 ```
 
 To get your `WORKSPACE_ID` and `PRIMARY_KEY_OR_SECONDARY_KEY`, in your workspace go to `advanced settings` -> `connected resources` -> `Agents management`.
+
+## Response Object
+
+| Property  | Optional |                                                                                                             Description |
+| --------- | :------: | ----------------------------------------------------------------------------------------------------------------------: |
+| code      |    no    |                                                                                                      HTTP response code |
+| status    |    no    |                                                                                                    HTTP response status |
+| errorCode |   yes    | [Error code](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collector-api#return-codes) from server |
+| errorMsg  |   yes    |                                                                                               Error message from server |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "azure-log-analytics-data-collector-client",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "Node.js wrapper for Azure Log Analytics data collector API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/Response.ts

@@ -0,0 +1,10 @@
+export interface APIResponse {
+  // HTTP response code
+  code: number;
+  // HTTP response status
+  status: string;
+  // error code as documented in https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collector-api#return-codes
+  errorCode?: string;
+  // error message from server
+  errorMsg?: string;
+}

src/__tests__/index.test.ts

@@ -9,13 +9,54 @@ describe("The data collector client", () => {
   );
 
   it("is able to send logs to Azure", async () => {
-    const statusCode = await client.send("MyLogs", [
+    const res = await client.send("MyLogs", [
       {
         level: "info",
         message: "server starts",
       },
     ]);
 
-    expect(statusCode).toEqual(200);
+    expect(res.code).toEqual(200);
+    expect(res.status).toEqual("OK");
+  });
+
+  it("will return MissingLogType error when log type is not provided", async () => {
+    const res = await client.send("", [
+      {
+        level: "info",
+        message: "server starts",
+      },
+    ]);
+
+    expect(res.code).toEqual(400);
+    expect(res.errorCode).toEqual("MissingLogType");
+  });
+
+  it("will return InvalidLogType error when log type contains invalid character", async () => {
+    const res = await client.send("My-Logs", [
+      {
+        level: "info",
+        message: "server starts",
+      },
+    ]);
+
+    expect(res.code).toEqual(400);
+    expect(res.errorCode).toEqual("InvalidLogType");
+  });
+
+  it("will return InvalidAuthorization error when authorization code is invalid", async () => {
+    const client = new DataCollectorClient(
+      LOG_ANALYTICS_WORKSPACE_ID!,
+      "X" + LOG_ANALYTICS_AGENT_KEY
+    );
+    const res = await client.send("MyLogs", [
+      {
+        level: "info",
+        message: "server starts",
+      },
+    ]);
+
+    expect(res.code).toEqual(403);
+    expect(res.errorCode).toEqual("InvalidAuthorization");
   });
 });

src/index.ts

@@ -1,6 +1,8 @@
 import { createHmac } from "crypto";
 import fetch from "node-fetch";
 
+import { APIResponse } from "./Response";
+
 // Refer to https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collector-api
 
 const API_VERSION = "2016-04-01";
@@ -23,7 +25,7 @@ export class DataCollectorClient {
     logType: string,
     logs: any[],
     timeGenerated?: string
-  ): Promise<number> {
+  ): Promise<APIResponse> {
     const postPayload = JSON.stringify(logs);
     const contentLength = Buffer.byteLength(postPayload, "utf8");
     const gmtTime = new Date().toUTCString();
@@ -56,12 +58,26 @@ export class DataCollectorClient {
 
     const url = `https://${this.workspaceId}.ods.opinsights.azure.com/api/logs?api-version=${API_VERSION}`;
 
-    const result = await fetch(url, {
+    const res = await fetch(url, {
       method: "post",
       body: postPayload,
       headers,
     });
 
-    return result.status;
+    if (res.status === 200) {
+      return {
+        code: 200,
+        status: "OK",
+      };
+    }
+
+    const errorDetail = await res.json();
+
+    return {
+      code: res.status,
+      status: res.statusText,
+      errorCode: errorDetail.Error,
+      errorMsg: errorDetail.Message,
+    };
   }
 }