chore: move error parsing backend-side and return error path to front…

…end (#189) * chore: move error parsing backend-side and return error path to frontend * fix: do not include trailing ':' in error path, do not modify error message * chore: remove debug output * chore: minor refactoring for understandability * fix: error path as array, support named pipelines in error path extraction
dash0hq · Nov 9, 2023 · 1a13eba · 1a13eba
1 parent 30a048a
commit 1a13eba
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 0 deletions.
diff --git a/packages/otelbin-validation-image/src/index.ts b/packages/otelbin-validation-image/src/index.ts
@@ -105,6 +105,14 @@ export const validateOtelCol = async (otelcolRealPath: string, configPath: strin
   });
 };
 
+const extractErrorPath = (errorMessage: string) => {
+  const errorPathMatch = errorMessage.match(/^((?:(?:[\w\/]+)(?:\:\:)?)+):[^:]/);
+  if (errorPathMatch) {
+    // We have a prefix for the error that specified a path
+    return errorPathMatch[1]?.split('::');
+  }
+};
+
 export const handler = async (event: APIGatewayEvent): Promise<APIGatewayProxyResult> => {
   const config = event.body;
 
@@ -170,10 +178,13 @@ export const handler = async (event: APIGatewayEvent): Promise<APIGatewayProxyRe
         error = error.substring(defaultErrorPrefix.length);
       }
 
+      const path = extractErrorPath(error);
+
       return {
         statusCode: 200,
         // Unfortunately the collector returns one validation error at the time
         body: JSON.stringify({
+          path,
           message: 'The provided configuration is invalid',
           error,
         }),

diff --git a/packages/otelbin-validation/test/assets/config-undeclared-receiver-named-pipelines.yaml b/packages/otelbin-validation/test/assets/config-undeclared-receiver-named-pipelines.yaml
@@ -0,0 +1,36 @@
+# Learn more about the OpenTelemetry Collector via
+# https://opentelemetry.io/docs/collector/
+
+receivers:
+  otlp:
+    protocols:
+      grpc:
+      http:
+
+processors:
+  batch:
+
+exporters:
+  otlp:
+    endpoint: otelcol:4317
+
+extensions:
+  health_check:
+  pprof:
+  zpages:
+
+service:
+  extensions: [health_check, pprof, zpages]
+  pipelines:
+    traces/dash0:
+      receivers: [jaeger]
+      processors: [batch]
+      exporters: [otlp]
+    metrics/dash0:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp]
+    logs/dash0:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlp]
diff --git a/packages/otelbin-validation/test/main.test.ts b/packages/otelbin-validation/test/main.test.ts
@@ -53,6 +53,7 @@ const otelcolConfigValid = readConfig('config-default.yaml');
 const otelcolConfigInvalidNoReceivers = readConfig('config-no-receivers.yaml');
 const otelcolConfigInvalidUndeclaredExtension = readConfig('config-undeclared-extension.yaml');
 const otelcolConfigInvalidUndeclaredReceiver = readConfig('config-undeclared-receiver.yaml');
+const otelcolConfigInvalidUndeclaredReceiverNamedPipeline = readConfig('config-undeclared-receiver-named-pipelines.yaml');
 
 describe.each(enumerateTestCases())('Validation API', (distributionName, release) => {
 
@@ -153,12 +154,29 @@ describe.each(enumerateTestCases())('Validation API', (distributionName, release
         })).resolves.toMatchObject({
           status: 200,
           data: {
+            path: ['service', 'pipelines', 'traces'],
             message: 'The provided configuration is invalid',
             error: 'service::pipelines::traces: references receiver "jaeger" which is not configured',
           },
         });
       }, defaultTimeout);
 
+      test('rejects configuration with undeclared receiver in named pipeline', async () => {
+        await expect(axios.post(validationUrl, otelcolConfigInvalidUndeclaredReceiverNamedPipeline, {
+          headers: {
+            'Content-Type': 'application/yaml',
+            'X-Api-Key': apiKey,
+          },
+        })).resolves.toMatchObject({
+          status: 200,
+          data: {
+            path: ['service', 'pipelines', 'traces/dash0'],
+            message: 'The provided configuration is invalid',
+            error: 'service::pipelines::traces/dash0: references receiver "jaeger" which is not configured',
+          },
+        });
+      }, defaultTimeout);
+
       test('rejects configuration with undeclared extension', async () => {
         await expect(axios.post(validationUrl, otelcolConfigInvalidUndeclaredExtension, {
           headers: {
@@ -168,6 +186,7 @@ describe.each(enumerateTestCases())('Validation API', (distributionName, release
         })).resolves.toMatchObject({
           status: 200,
           data: {
+            path: ['service', 'extensions'],
             message: 'The provided configuration is invalid',
             error: 'service::extensions: references extension "health_check" which is not configured',
           },