Skip to content

Develop Logs List UI

Daniele Rossetti requested to merge drosse/logs-list-ui into master

What does this MR do and why?

First iteration of the new Logs UI.

  • Add LogsList component: fetches logs and renders the LogsTable component
  • Add LogsTable component: renders the given table as a table. Log severity is rendered as a Label.
  • Add fetchLogs API to client

Everything is behind :observability_logs feature flag

Mock up: gitlab-org/opstrace/opstrace#2611

Closes gitlab-org/opstrace/opstrace#2645 (closed)

Depends on Scaffold Logs UI feature (frontend) (!142990 - merged) and Scaffold Observability Logs feature (backend) (!142989 - merged)

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

image

How to set up and validate locally

  1. Pull in changes from !142990 (merged) and !142989 (merged)

Apply patch to load mocks ( copy the patch content below and run in your terminal: pbpaste | git apply --allow-empty )

diff --git a/app/assets/javascripts/observability/client.js b/app/assets/javascripts/observability/client.js
index 01919e5ccb2d..69ca8c570304 100644
--- a/app/assets/javascripts/observability/client.js
+++ b/app/assets/javascripts/observability/client.js
@@ -1,3 +1,4 @@
+/* eslint-disable @gitlab/require-i18n-strings */
 import { isValidDate } from '~/lib/utils/datetime_utility';
 import * as Sentry from '~/sentry/sentry_browser_wrapper';
 import axios from '~/lib/utils/axios_utils';
@@ -9,14 +10,18 @@ function reportErrorAndThrow(e) {
   Sentry.captureException(e);
   throw e;
 }
+
+function mockReturnDataWithDelay(data) {
+  return new Promise((resolve) => {
+    setTimeout(() => resolve(data), 500);
+  });
+}
+
 // Provisioning API spec: https://gitlab.com/gitlab-org/opstrace/opstrace/-/blob/main/provisioning-api/pkg/provisioningapi/routes.go#L59
 async function enableObservability(provisioningUrl) {
   try {
-    // Note: axios.put(url, undefined, {withCredentials: true}) does not send cookies properly, so need to use the API below for the correct behaviour
-    return await axios(provisioningUrl, {
-      method: 'put',
-      withCredentials: true,
-    });
+    console.log('[DEBUG] Enabling Observability');
+    return mockReturnDataWithDelay();
   } catch (e) {
     return reportErrorAndThrow(e);
   }
@@ -25,11 +30,12 @@ async function enableObservability(provisioningUrl) {
 // Provisioning API spec: https://gitlab.com/gitlab-org/opstrace/opstrace/-/blob/main/provisioning-api/pkg/provisioningapi/routes.go#L37
 async function isObservabilityEnabled(provisioningUrl) {
   try {
-    const { data } = await axios.get(provisioningUrl, { withCredentials: true });
+    console.log('[DEBUG] Checking Observability Enabled');
+    const data = { status: 'ready' };
     if (data && data.status) {
       // we currently ignore the 'status' payload and just check if the request was successful
       // We might improve this as part of https://gitlab.com/gitlab-org/opstrace/opstrace/-/issues/2315
-      return true;
+      return mockReturnDataWithDelay(true);
     }
   } catch (e) {
     if (e.response.status === 404) {
@@ -383,13 +389,148 @@ async function fetchMetricSearchMetadata(searchMetadataUrl, name, type) {
 
 export async function fetchLogs(logsSearchUrl) {
   try {
-    const { data } = await axios.get(logsSearchUrl, {
-      withCredentials: true,
-    });
-    if (!Array.isArray(data.results)) {
-      throw new Error('logs are missing/invalid in the response'); // eslint-disable-line @gitlab/require-i18n-strings
-    }
-    return data;
+    return mockReturnDataWithDelay([
+      {
+        timestamp: '2024-01-28T10:36:08.2960655Z',
+        trace_id: 'trace-id',
+        span_id: 'span-id',
+        trace_flags: 1,
+        severity_text: 'Information',
+        severity_number: 1,
+        service_name: 'a/service/name',
+        body: 'GetCartAsync called with userId={userId}',
+        resource_attributes: {
+          'container.id': '8aae63236c224245383acd38611a4e32d09b7630573421fcc801918eda378bf5',
+          'k8s.deployment.name': 'otel-demo-cartservice',
+          'k8s.namespace.name': 'otel-demo-app',
+          'k8s.node.name': 'opstrace-worker',
+          'k8s.pod.ip': '192.168.95.20',
+          'k8s.pod.name': 'otel-demo-cartservice-6dcc867f5f-gfhcx',
+          'k8s.pod.start_time': '2024-01-26T09:36:26Z',
+          'k8s.pod.uid': 'b1f88956-bdbd-4dba-8067-ac9be923dc83',
+          'service.name': 'cartservice',
+          'service.namespace': 'opentelemetry-demo',
+          'telemetry.sdk.language': 'dotnet',
+          'telemetry.sdk.name': 'opentelemetry',
+          'telemetry.sdk.version': '1.6.0',
+        },
+        log_attributes: {
+          userId: '',
+        },
+      },
+      {
+        timestamp: '2024-01-28T10:36:08.2960655Z',
+        trace_id: 'trace-id',
+        span_id: 'span-id',
+        trace_flags: 1,
+        severity_text: 'Information',
+        severity_number: 9,
+        service_name: 'cartservice',
+        body: 'GetCartAsync called with userId={userId}',
+        resource_attributes: {
+          'container.id': '8aae63236c224245383acd38611a4e32d09b7630573421fcc801918eda378bf5',
+          'k8s.deployment.name': 'otel-demo-cartservice',
+          'k8s.namespace.name': 'otel-demo-app',
+          'k8s.node.name': 'opstrace-worker',
+          'k8s.pod.ip': '192.168.95.20',
+          'k8s.pod.name': 'otel-demo-cartservice-6dcc867f5f-gfhcx',
+          'k8s.pod.start_time': '2024-01-26T09:36:26Z',
+          'k8s.pod.uid': 'b1f88956-bdbd-4dba-8067-ac9be923dc83',
+          'service.name': 'cartservice',
+          'service.namespace': 'opentelemetry-demo',
+          'telemetry.sdk.language': 'dotnet',
+          'telemetry.sdk.name': 'opentelemetry',
+          'telemetry.sdk.version': '1.6.0',
+        },
+        log_attributes: {
+          userId: '',
+        },
+      },
+      {
+        timestamp: '2024-01-28T10:36:08.2960655Z',
+        trace_id: 'trace-id',
+        span_id: 'span-id',
+        trace_flags: 1,
+        severity_text: 'Information',
+        severity_number: 13,
+        service_name: 'cartservice',
+        body: 'GetCartAsync called with userId={userId}',
+        resource_attributes: {
+          'container.id': '8aae63236c224245383acd38611a4e32d09b7630573421fcc801918eda378bf5',
+          'k8s.deployment.name': 'otel-demo-cartservice',
+          'k8s.namespace.name': 'otel-demo-app',
+          'k8s.node.name': 'opstrace-worker',
+          'k8s.pod.ip': '192.168.95.20',
+          'k8s.pod.name': 'otel-demo-cartservice-6dcc867f5f-gfhcx',
+          'k8s.pod.start_time': '2024-01-26T09:36:26Z',
+          'k8s.pod.uid': 'b1f88956-bdbd-4dba-8067-ac9be923dc83',
+          'service.name': 'cartservice',
+          'service.namespace': 'opentelemetry-demo',
+          'telemetry.sdk.language': 'dotnet',
+          'telemetry.sdk.name': 'opentelemetry',
+          'telemetry.sdk.version': '1.6.0',
+        },
+        log_attributes: {
+          userId: '',
+        },
+      },
+      {
+        timestamp: '2024-01-28T10:36:08.2960655Z',
+        trace_id: 'trace-id',
+        span_id: 'span-id',
+        trace_flags: 1,
+        severity_text: 'Information',
+        severity_number: 17,
+        service_name: 'cartservice',
+        body: 'GetCartAsync called with userId={userId}',
+        resource_attributes: {
+          'container.id': '8aae63236c224245383acd38611a4e32d09b7630573421fcc801918eda378bf5',
+          'k8s.deployment.name': 'otel-demo-cartservice',
+          'k8s.namespace.name': 'otel-demo-app',
+          'k8s.node.name': 'opstrace-worker',
+          'k8s.pod.ip': '192.168.95.20',
+          'k8s.pod.name': 'otel-demo-cartservice-6dcc867f5f-gfhcx',
+          'k8s.pod.start_time': '2024-01-26T09:36:26Z',
+          'k8s.pod.uid': 'b1f88956-bdbd-4dba-8067-ac9be923dc83',
+          'service.name': 'cartservice',
+          'service.namespace': 'opentelemetry-demo',
+          'telemetry.sdk.language': 'dotnet',
+          'telemetry.sdk.name': 'opentelemetry',
+          'telemetry.sdk.version': '1.6.0',
+        },
+        log_attributes: {
+          userId: '',
+        },
+      },
+      {
+        timestamp: '2024-01-28T10:36:08.2960655Z',
+        trace_id: 'trace-id',
+        span_id: 'span-id',
+        trace_flags: 1,
+        severity_text: 'Information',
+        severity_number: 21,
+        service_name: 'cartservice',
+        body: 'GetCartAsync called with userId={userId}',
+        resource_attributes: {
+          'container.id': '8aae63236c224245383acd38611a4e32d09b7630573421fcc801918eda378bf5',
+          'k8s.deployment.name': 'otel-demo-cartservice',
+          'k8s.namespace.name': 'otel-demo-app',
+          'k8s.node.name': 'opstrace-worker',
+          'k8s.pod.ip': '192.168.95.20',
+          'k8s.pod.name': 'otel-demo-cartservice-6dcc867f5f-gfhcx',
+          'k8s.pod.start_time': '2024-01-26T09:36:26Z',
+          'k8s.pod.uid': 'b1f88956-bdbd-4dba-8067-ac9be923dc83',
+          'service.name': 'cartservice',
+          'service.namespace': 'opentelemetry-demo',
+          'telemetry.sdk.language': 'dotnet',
+          'telemetry.sdk.name': 'opentelemetry',
+          'telemetry.sdk.version': '1.6.0',
+        },
+        log_attributes: {
+          userId: '',
+        },
+      },
+    ]);
   } catch (e) {
     return reportErrorAndThrow(e);
   }
diff --git a/app/assets/javascripts/observability/components/observability_container.vue b/app/assets/javascripts/observability/components/observability_container.vue
index b89c2624f81c..f6cbf7ee771f 100644
--- a/app/assets/javascripts/observability/components/observability_container.vue
+++ b/app/assets/javascripts/observability/components/observability_container.vue
@@ -27,12 +27,12 @@ export default {
 
     // TODO: Improve local GDK dev experience with tracing https://gitlab.com/gitlab-org/opstrace/opstrace/-/issues/2308
     // Uncomment the lines below to to test this locally
-    // setTimeout(() => {
-    //   this.messageHandler({
-    //     data: { type: 'AUTH_COMPLETION', status: 'success' },
-    //     origin: new URL(this.oauthUrl).origin,
-    //   });
-    // }, 2000);
+    setTimeout(() => {
+      this.messageHandler({
+        data: { type: 'AUTH_COMPLETION', status: 'success' },
+        origin: new URL(this.apiConfig.oauthUrl).origin,
+      });
+    }, 2000);
   },
   destroyed() {
     window.removeEventListener('message', this.messageHandler);
  1. Make sure you are logged in and have a Ultimate license

  2. In rails console enable the experiment fully

    Feature.enable(:observability_logs)
  3. Visit the project page such as https://local.gitlab.com:3443/flightjs/Flight/

  4. Click on the Monitor > Logs button

Edited by Daniele Rossetti

Merge request reports