Fix OTEL Services integration (#1770)

* Improve error message for invalid integration in unit tests Signed-off-by: Simeon Widdis <[email protected]> * Fix otel integration to pass validation tests Signed-off-by: Simeon Widdis <[email protected]> --------- Signed-off-by: Simeon Widdis <[email protected]>
opensearch-project · Apr 30, 2024 · dda72c0 · dda72c0
1 parent 9aee128
commit dda72c0
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 96 deletions.
diff --git a/...mp-network-metrics-dashboard-1.0.0.ndjson → ...mp_network_metrics_dashboard-1.0.0.ndjson b/...mp-network-metrics-dashboard-1.0.0.ndjson → ...mp_network_metrics_dashboard-1.0.0.ndjson
diff --git a/...ts/otel-apm-network-services-1.0.0.ndjson → ...ts/otel_apm_network_services-1.0.0.ndjson b/...ts/otel-apm-network-services-1.0.0.ndjson → ...ts/otel_apm_network_services-1.0.0.ndjson
diff --git a/...tel-ingestion-rate-dashboard-1.0.0.ndjson → ...tel_ingestion_rate_dashboard-1.0.0.ndjson b/...tel-ingestion-rate-dashboard-1.0.0.ndjson → ...tel_ingestion_rate_dashboard-1.0.0.ndjson
diff --git a/...sets/otel-services-dashboard-1.0.0.ndjson → ...sets/otel_services_dashboard-1.0.0.ndjson b/...sets/otel-services-dashboard-1.0.0.ndjson → ...sets/otel_services_dashboard-1.0.0.ndjson
diff --git a/...tel-single-service-dashboard-1.0.0.ndjson → ...tel_single_service_dashboard-1.0.0.ndjson b/...tel-single-service-dashboard-1.0.0.ndjson → ...tel_single_service_dashboard-1.0.0.ndjson
diff --git a/server/adaptors/integrations/__data__/repository/otel-services/data/traces-samples.json b/server/adaptors/integrations/__data__/repository/otel-services/data/traces-samples.json
@@ -66,23 +66,7 @@
       },
       "db.instance": "ffs",
       "db.name": "ffs",
-      "db.statement": ""
-      "SELECT f0."
-      id
-      ", f0."
-      description
-      ", f0."
-      enabled
-      ", f0."
-      name
-      ", f0."
-      inserted_at
-      ", f0."
-      updated_at
-      " FROM "
-      featureflags
-      " AS f0"
-      "",
+      "db.statement": "SELECT f0.\"id\", f0.\"description\", f0.\"enabled\", f0.\"name\", f0.\"inserted_at\", f0.\"updated_at\" FROM \"featureflags\" AS f0",
       "db.type": "sql",
       "db.url": "ecto://ffs_postgres",
       "decode_time_microseconds": 216,
@@ -193,23 +177,7 @@
       },
       "db.instance": "ffs",
       "db.name": "ffs",
-      "db.statement": ""
-      "SELECT f0."
-      id
-      ", f0."
-      description
-      ", f0."
-      enabled
-      ", f0."
-      name
-      ", f0."
-      inserted_at
-      ", f0."
-      updated_at
-      " FROM "
-      featureflags
-      " AS f0"
-      "",
+      "db.statement": "SELECT f0.\"id\", f0.\"description\", f0.\"enabled\", f0.\"name\", f0.\"inserted_at\", f0.\"updated_at\" FROM \"featureflags\" AS f0",
       "db.type": "sql",
       "db.url": "ecto://ffs_postgres",
       "decode_time_microseconds": 24,
@@ -252,7 +220,7 @@
     "@timestamp": "0001-01-01T00:00:00Z",
     "traceId": "e3335d43c7790064a14318ef59602e56",
     "traceState": ""
-  }
+  },
   {
     "attributes": {
       "data_stream": {
@@ -320,23 +288,7 @@
       },
       "db.instance": "ffs",
       "db.name": "ffs",
-      "db.statement": ""
-      "SELECT f0."
-      id
-      ", f0."
-      description
-      ", f0."
-      enabled
-      ", f0."
-      name
-      ", f0."
-      inserted_at
-      ", f0."
-      updated_at
-      " FROM "
-      featureflags
-      " AS f0"
-      "",
+      "db.statement": "SELECT f0.\"id\", f0.\"description\", f0.\"enabled\", f0.\"name\", f0.\"inserted_at\", f0.\"updated_at\" FROM \"featureflags\" AS f0",
       "db.type": "sql",
       "db.url": "ecto://ffs_postgres",
       "decode_time_microseconds": 11,
@@ -447,23 +399,7 @@
       },
       "db.instance": "ffs",
       "db.name": "ffs",
-      "db.statement": ""
-      "SELECT f0."
-      id
-      ", f0."
-      description
-      ", f0."
-      enabled
-      ", f0."
-      name
-      ", f0."
-      inserted_at
-      ", f0."
-      updated_at
-      " FROM "
-      featureflags
-      " AS f0"
-      "",
+      "db.statement": "SELECT f0.\"id\", f0.\"description\", f0.\"enabled\", f0.\"name\", f0.\"inserted_at\", f0.\"updated_at\" FROM \"featureflags\" AS f0",
       "db.type": "sql",
       "db.url": "ecto://ffs_postgres",
       "decode_time_microseconds": 104,
@@ -574,23 +510,7 @@
       },
       "db.instance": "ffs",
       "db.name": "ffs",
-      "db.statement": ""
-      "SELECT f0."
-      id
-      ", f0."
-      description
-      ", f0."
-      enabled
-      ", f0."
-      name
-      ", f0."
-      inserted_at
-      ", f0."
-      updated_at
-      " FROM "
-      featureflags
-      " AS f0"
-      "",
+      "db.statement": "SELECT f0.\"id\", f0.\"description\", f0.\"enabled\", f0.\"name\", f0.\"inserted_at\", f0.\"updated_at\" FROM \"featureflags\" AS f0",
       "db.type": "sql",
       "db.url": "ecto://ffs_postgres",
       "decode_time_microseconds": 10,

diff --git a/server/adaptors/integrations/__data__/repository/otel-services/otel-services-1.0.0.json b/server/adaptors/integrations/__data__/repository/otel-services/otel-services-1.0.0.json
@@ -5,7 +5,7 @@
   "description": "Otel Services Demo App with OpenSearch Observability",
   "license": "Apache-2.0",
   "type": "traces",
-  "labels": ["log", "traces", "metrics", "Flint S3"],
+  "labels": ["log", "traces", "metrics"],
   "author": "OpenSearch",
   "sourceUrl": "https://github.com/opensearch-project/dashboards-observability/tree/main/server/adaptors/integrations/__data__/repository/otel-services/info",
   "workflows": [
@@ -70,35 +70,35 @@
   ],
   "assets": [
       {
-        "name": "otel-services-dashboard",
+        "name": "otel_services_dashboard",
         "version": "1.0.0",
         "extension": "ndjson",
         "type": "savedObjectBundle",
         "workflows": ["dashboards"]
       },
       {
-        "name": "otel-single-service-dashboard",
+        "name": "otel_single_service_dashboard",
         "version": "1.0.0",
         "extension": "ndjson",
         "type": "savedObjectBundle",
         "workflows": ["dashboards"]
       },
       {
-        "name": "otel-ingestion-rate-dashboard",
+        "name": "otel_ingestion_rate_dashboard",
         "version": "1.0.0",
         "extension": "ndjson",
         "type": "savedObjectBundle",
         "workflows": ["dashboards"]
       },
       {
-        "name": "otel-amp-network-metrics-dashboard",
+        "name": "otel_amp_network_metrics_dashboard",
         "version": "1.0.0",
         "extension": "ndjson",
         "type": "savedObjectBundle",
         "workflows": ["dashboards"]
       },
       {
-        "name": "otel-apm-network-services",
+        "name": "otel_apm_network_services",
         "version": "1.0.0",
         "extension": "ndjson",
         "type": "savedObjectBundle",

diff --git a/server/adaptors/integrations/__test__/json_repository.test.ts b/server/adaptors/integrations/__test__/json_repository.test.ts
@@ -37,6 +37,7 @@ const fetchSerializedIntegrations = async (): Promise<Result<SerializedIntegrati
 describe('The Local Serialized Catalog', () => {
   it('Should serialize without errors', async () => {
     const serialized = await fetchSerializedIntegrations();
+    expect(serialized.error).not.toBeDefined();
     expect(serialized.ok).toBe(true);
   });
 

diff --git a/server/adaptors/integrations/repository/__test__/integration_reader.test.ts b/server/adaptors/integrations/repository/__test__/integration_reader.test.ts
@@ -83,7 +83,9 @@ describe('Integration', () => {
 
       const result = await integration.getConfig(TEST_INTEGRATION_CONFIG.version);
 
-      expect(result.error?.message).toBe('Unable to parse file as JSON or NDJson');
+      expect(result.error?.message).toBe(
+        "Unable to parse file 'sample-2.0.0.json' as JSON or NDJson"
+      );
     });
 
     it('should return an error if the integration config does not exist', async () => {
@@ -134,7 +136,9 @@ describe('Integration', () => {
 
       const result = await integration.getAssets(TEST_INTEGRATION_CONFIG.version);
 
-      expect(result.error?.message).toBe('Unable to parse file as JSON or NDJson');
+      expect(result.error?.message).toBe(
+        "Unable to parse file 'sample-1.0.1.ndjson' as JSON or NDJson"
+      );
     });
   });
 
@@ -262,7 +266,7 @@ describe('Integration', () => {
 
       const result = await integration.getSampleData();
 
-      expect(result.error?.message).toBe('Unable to parse file as JSON or NDJson');
+      expect(result.error?.message).toBe("Unable to parse file 'sample.json' as JSON or NDJson");
     });
   });
 });
diff --git a/server/adaptors/integrations/repository/fs_data_adaptor.ts b/server/adaptors/integrations/repository/fs_data_adaptor.ts
@@ -54,7 +54,7 @@ export class FileSystemDataAdaptor implements CatalogDataAdaptor {
       }
       return {
         ok: false,
-        error: new Error('Unable to parse file as JSON or NDJson', { cause: err }),
+        error: new Error(`Unable to parse file '${filename}' as JSON or NDJson`, { cause: err }),
       };
     }
   }