feat(orchestrator): Logging for Workflows

.sonarcloud.properties

@@ -1 +1,3 @@
 sonar.cpd.exclusions=workspaces/*/packages/app/**, workspaces/*/packages/backend/**, workspaces/*/plugins/*test*/**, **/*.test.*, **/translations/*.ts, **/__fixtures__/*, **/playwright.config.ts
+sonar.exclusions=workspaces/*/plugins/orchestrator-common/src/generated/**
+

workspaces/orchestrator/.changeset/green-readers-visit.md

@@ -0,0 +1,9 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki': major
+'@red-hat-developer-hub/backstage-plugin-orchestrator-backend': minor
+'@red-hat-developer-hub/backstage-plugin-orchestrator-common': minor
+'@red-hat-developer-hub/backstage-plugin-orchestrator-node': major
+'@red-hat-developer-hub/backstage-plugin-orchestrator': minor
+---
+
+Adding Workflow Logs endpoint. Loki provider added

workspaces/orchestrator/app-config.yaml

@@ -147,6 +147,14 @@ catalog:
 dynamicPlugins:
   frontend: {}
 orchestrator:
+  # Uncomment and configure to use the log viewer
+  # workflowLogProvider:
+  #   loki:
+  #     baseUrl: http://localhost:3100
+  # Uncomment if using a custom log stream selector
+  # logStreamSelectors:
+  #   - label: 'selector'
+  #     value: 'value'
   sonataFlowService:
     # uncomment the next line to use podman instead of docker
     # runtime: podman

workspaces/orchestrator/package.json

@@ -55,7 +55,8 @@
     "react": "^18",
     "react-dom": "^18",
     "refractor@npm:3.6.0/prismjs": "^1.30.0",
-    "zod-to-json-schema": "3.24.6"
+    "zod-to-json-schema": "3.24.6",
+    "@backstage/backend-plugin-api": "1.5.0"
   },
   "prettier": "@backstage/cli/config/prettier",
   "lint-staged": {

workspaces/orchestrator/packages/backend/package.json

@@ -51,6 +51,7 @@
     "@backstage/plugin-signals-backend": "^0.3.10",
     "@backstage/plugin-techdocs-backend": "^2.1.2",
     "@red-hat-developer-hub/backstage-plugin-orchestrator-backend": "workspace:^",
+    "@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-scaffolder-backend-module-orchestrator": "workspace:^",
     "app": "link:../app",
     "better-sqlite3": "^12.0.0",

workspaces/orchestrator/packages/backend/src/index.ts

@@ -75,4 +75,9 @@ backend.add(import('@backstage/plugin-scaffolder-backend-module-gitlab'));
 // custom authentication provider module
 backend.add(import('custom-authentication-provider-module-backend'));
 
+backend.add(
+  import(
+    '@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki'
+  ),
+);
 backend.start();

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/.eslintrc.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/README.md

@@ -0,0 +1,60 @@
+# Orchestrator Backend Module for Loki
+
+This is an extension module to the `backstage-plugin-orchestrator-backend` plugin. It provides access to the Loki log provider
+
+## Prerequisites
+
+Before installing this module, ensure that the Orchestrator backend plugin is integrated into your Backstage instance. Follow the [Orchestrator README](https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator) for setup instructions.
+
+This module also requires a Loki `workflowLogProvider` integration to be configured in your `app-config.yaml`. This will be added to the `orchestrator` section and might look something like this:
+
+```
+orchestrator:
+  workflowLogProvider:
+    loki:
+      baseUrl: http://localhost:3100
+      # logStreamSelectors:
+      #   - label: 'app'
+      #     value: '=~".+"'
+```
+
+The `baseUrl` is required.
+
+Multiple Log Stream Selectors can be specified in the `logStreamSelectors` section. See the loki docs to learn more about log stream selectors and their values: https://grafana.com/docs/loki/latest/query/log_queries/#log-stream-selector
+
+## Installation
+
+To install this backend module:
+
+```bash
+# From your root directory
+yarn workspace backend add @red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki
+```
+
+```ts
+// packages/backend/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+
+const backend = createBackend();
+
+// orchestrator
+backend.add(
+  import('@red-hat-developer-hub/backstage-plugin-orchestrator-backend'),
+);
+// orchestrator Log Provider
+backend.add(
+  import(
+    '@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki'
+  ),
+);
+
+backend.start();
+```
+
+## Usage
+
+Once the module is successfully setup, a user can view an orchestrator workflows log. This can be accessed by the new backend endpoint here: RHDH_BACK_END_URL/api/orchestrator/v2/workflows/instances/WORKFLOW_INSTANCE_ID/logs
+
+Or by clicking the "view log" link on the orchestrator front-end:![alt text](img/view-logs-button.png)
+
+![alt text](img/viewing-log.png)

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/__fixtures__/mockWorkflowLogs.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const mockWorkflowLog = {
+  status: 'success',
+  data: {
+    resultType: 'streams',
+    result: [
+      {
+        stream: {
+          detected_level: 'error',
+          service_name: 'unknown_service',
+        },
+        values: [
+          [
+            '1764952546330041000',
+            '2025-12-05 16:35:14,644 9eb78e04f727 ERROR [org.jbpm.workflow.instance.impl.WorkflowProcessInstanceImpl:1316] (executor-thread-14) Unexpected error while executing node createNotification in process instance 7a6d2622-a315-4737-9278-36311ba4583a: org.jbpm.workflow.instance.WorkflowRuntimeException: [sendnotification:7a6d2622-a315-4737-9278-36311ba4583a - createNotification:[uuid=7]] -- RESTEASY004655: Unable to invoke request: org.apache.http.client.ClientProtocolException',
+          ],
+        ],
+      },
+      {
+        stream: {
+          detected_level: 'info',
+          service_name: 'unknown_service',
+        },
+        values: [
+          [
+            '1764952546332968000',
+            "2025-12-05 16:35:14,668 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:50] (executor-thread-14) Workflow 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a) was started, now 'Error'",
+          ],
+          [
+            '1764952546327277000',
+            '2025-12-05 16:35:14,626 9eb78e04f727 INFO  [org.kie.kogito.process.workitems.impl.DefaultKogitoWorkItemHandler:105] (executor-thread-14) error workItem WorkItem 7ee1509a-03b4-47e2-891f-31f6d225e520 [name=notifications_createNotification, state=1, processInstanceId=7a6d2622-a315-4737-9278-36311ba4583a, parameters{Parameter={"recipients":["user:development/guest"],"title":"This is a notification","topic":"Manually sent"}, payload={severity=normal, link=https://www.redhat.com, description=Description of the notification, topic=Manually sent, title=This is a notification}, recipients={entityRef=[user:development/guest], type=entity}}] handled by notifications_createNotification transition DefaultWorkItemTransitionImpl [id=activate, data={}, policies=[], termination=null] : jakarta.ws.rs.ProcessingException: RESTEASY004655: Unable to invoke request: org.apache.http.client.ClientProtocolException',
+          ],
+          [
+            '1764952546327248000',
+            "2025-12-05 16:35:13,632 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:64] (executor-thread-14) Triggered node 'createNotification' for process 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a)",
+          ],
+          [
+            '1764952546327240000',
+            "2025-12-05 16:35:13,628 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:64] (executor-thread-14) Triggered node 'SendNotification' for process 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a)",
+          ],
+          [
+            '1764952546327187000',
+            "2025-12-05 16:35:13,623 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:64] (executor-thread-14) Triggered node 'Prepare' for process 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a)",
+          ],
+          [
+            '1764952546327177000',
+            "2025-12-05 16:35:13,622 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:64] (executor-thread-14) Triggered node 'Start' for process 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a)",
+          ],
+          [
+            '1764952546327102000',
+            "2025-12-05 16:35:13,618 9eb78e04f727 INFO  [org.kie.kogito.serverless.workflow.devservices.DevModeServerlessWorkflowLogger:40] (executor-thread-14) Starting workflow 'sendnotification' (7a6d2622-a315-4737-9278-36311ba4583a)",
+          ],
+        ],
+      },
+    ],
+  },
+};
+
+export default mockWorkflowLog;

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/config.d.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export interface Config {
+  /**
+   * Configuration for the Orchestrator plugin.
+   */
+  orchestrator?: {
+    workflowLogProvider?: {
+      loki?: {
+        /**
+         * Base URL of the Loki service.
+         */
+        baseUrl: string;
+        logStreamSelectors?: Array<{
+          // label is the selector, something like 'app' or 'service_name', etc...
+          label: string;
+          // value is the label matching operator, so something like: '=~".+"'
+          value: string;
+        }>;
+      };
+    };
+  };
+}

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "description": "The loki backend module for the orchestrator plugin.",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "orchestrator",
+    "pluginPackage": "@red-hat-developer-hub/backstage-plugin-orchestrator-backend"
+  },
+  "exports": {
+    ".": "./src/index.ts",
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "tsc": "tsc",
+    "prettier:check": "prettier --ignore-unknown --check .",
+    "prettier:fix": "prettier --ignore-unknown --write ."
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^1.5.0",
+    "@red-hat-developer-hub/backstage-plugin-orchestrator-common": "workspace:^",
+    "@red-hat-developer-hub/backstage-plugin-orchestrator-node": "workspace:^",
+    "luxon": "^3.7.2"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.10.0",
+    "@backstage/cli": "^0.34.5",
+    "@backstage/config": "^1.3.6"
+  },
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/redhat-developer/rhdh-plugins",
+    "directory": "workspaces/orchestrator/plugins/orchestrator-backend-module-loki"
+  },
+  "keywords": [
+    "backstage",
+    "plugin"
+  ],
+  "homepage": "https://red.ht/rhdh",
+  "bugs": "https://github.com/redhat-developer/rhdh-plugins/issues",
+  "author": "Red Hat"
+}

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/report.api.md

@@ -0,0 +1,13 @@
+## API Report File for "@red-hat-developer-hub/backstage-plugin-orchestrator-backend-module-loki"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+
+// @public
+const orchestratorModuleLoki: BackendFeature;
+export default orchestratorModuleLoki;
+
+```

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/src/index.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * The loki backend module for the orchestrator plugin.
+ *
+ * @packageDocumentation
+ */
+
+export { orchestratorModuleLoki as default } from './module';

workspaces/orchestrator/plugins/orchestrator-backend-module-loki/src/module.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright Red Hat, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { workflowLogsExtensionEndpoint } from '@red-hat-developer-hub/backstage-plugin-orchestrator-node';
+import { LokiProvider } from './workflowLogsProviders/LokiProvider';
+/**
+
+ * Provides access to the Loki log provider for viewing Orchestrator workflow logs
+ *
+ * @public
+ */
+export const orchestratorModuleLoki = createBackendModule({
+  pluginId: 'orchestrator',
+  moduleId: 'loki',
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        config: coreServices.rootConfig,
+        logger: coreServices.logger,
+        workflowLogs: workflowLogsExtensionEndpoint,
+      },
+      async init({ config, logger, workflowLogs }) {
+        logger.info('Initialize the Loki orchestrator backend module');
+        workflowLogs.addWorkflowLogProvider(LokiProvider.fromConfig(config));
+      },
+    });
+  },
+});