Grafana Loki Local Setup | Fix Metrics Service Conflicts in api_dev and worker_dev services (#201)

* feat(entrypoint): loki log backend implemented along with console logger to stream logs to console

Everything tested. api_dev (development container service in docker-compose) works as expected.

NOTE: the workers service specified in docker-compose must use a different port or should not expose its metrics (or can use port forwarding), since they are all on the same network (host network)

* fix(configure): start prometheus service on a different port when running workers as processes

This is required to avoid starting metrics server on exact same port when running locally with docker-compose (api_dev and worker_dev are both on host network)

* fixup! fix(configure): start prometheus service on a different port when running workers as processes

* fix: fixed some linting errors, refactored shared method to handle vapor application for tests

Specifically the `withApp` method

* fix: fixed all linting errors, deleted CLI and cli testing gh workflow

Author: vimscientist69

.github/workflows/automa-cli-testing.yml

@@ -106,7 +106,7 @@ public struct DebugMenu: View {
                             config.text = "Set URL"
                         },
                         action: { _ in
-                            self.setBaseEnvUrl()
+                            setBaseEnvUrl()
                         }
                     )
                 }

App/AutomaAppShared/Sources/AutomaAppShared/Screens/Debug/DebugMenu.swift

@@ -33,6 +33,7 @@ public let package = Package(
         .package(url: "https://github.com/GetAutomaApp/Fakery", branch: "master"),
         .package(url: "https://github.com/GetAutomaApp/AutomaUtilities", branch: "main"),
         .package(url: "https://github.com/scinfu/SwiftSoup.git", from: "2.11.1"),
+        .package(url: "https://github.com/lovetodream/swift-log-loki.git", branch: "main"),
     ],
     targets: [
         .executableTarget(
@@ -56,7 +57,8 @@ public let package = Package(
                 .product(name: "FeedKit", package: "FeedKit"),
                 .product(name: "DMRetry", package: "swift-retry"),
                 .product(name: "AutomaUtilities", package: "AutomaUtilities"),
-                "SwiftSoup"
+                "SwiftSoup",
+                .product(name: "LoggingLoki", package: "swift-log-loki"),
             ],
             exclude: [
                 "Documentation.md",

Backend/Package.resolved

@@ -10,12 +10,21 @@ internal struct AutomaWebCoreClient {
     private let client: any Client
     private let baseURL: URL
 
+    /// Initialize a new client for using AutomaWebCore API
+    /// - Parameter client: HTTP client from a request of application
+    /// - Throws: an error if environment variable `AUTOMA_WEB_CORE_API_BASE_URL` isn't found
     public init(client: any Client) throws {
         self.client = client
         let urlString = try Environment.getOrThrow("AUTOMA_WEB_CORE_API_BASE_URL")
         baseURL = try URL.fromString(payload: .init(string: urlString))
     }
 
+    /// Get the HTML of a specific website
+    /// - Parameter payload: AutomaWebCoreAPI endpoint payload for configuring what website & how to get
+    /// the HTML
+    /// - Throws: An error when there was a problem making a request to AutomaWebCore API or
+    /// when encoding the payload into request body
+    /// - Returns: The website HTML as a string
     public func getWebsiteHTML(payload: AutomaWebCoreAPIEndpointPayload) async throws -> String {
         let res = try await client.get("\(baseURL.absoluteString)/api") { req in
             try req.content.encode(payload)

Backend/Package.swift

@@ -130,7 +130,7 @@ internal struct OpenAIChatCompletionClient: ChatCompletionClientBase {
 
         // Log usage information
         logger.info(
-            "OpenAI chat completions result metadata",
+            "OpenAI chat completions result usage metadata",
             metadata: [
                 "to": .string("\(String(describing: Self.self)).\(#function)"),
                 "usage": .string("\(usage)"),
@@ -156,10 +156,10 @@ internal struct OpenAIChatCompletionClient: ChatCompletionClientBase {
         BackendMetric.chatCompletionServiceCall(platform: .openai, model: model, status: .success).increment()
         let metadata = try JSONEncoder().encode(result)
         logger.info(
-            "OpenAI chat completions result metadata",
+            "OpenAI chat completions result full metadata",
             metadata: [
                 "to": .string("\(String(describing: Self.self)).\(#function)"),
-                "metadata": .string(String(describing: metadata)),
+                "metadata": .string(String(reflecting: result)),
             ]
         )
 

Backend/Sources/App/Clients/AutomaWebCoreClient/AutomaWebCoreClient.swift

@@ -0,0 +1,28 @@
+// EnvironmentExtensions.swift
+// Copyright (c) 2025 GetAutomaApp
+// All source code and related assets are the property of GetAutomaApp.
+// All rights reserved.
+
+import Vapor
+
+internal extension Environment {
+    enum AppMode {
+        case http
+        case queue(name: String)
+    }
+
+    var appMode: AppMode {
+        if
+            CommandLine.arguments.contains("queues") ||
+            CommandLine.arguments.contains("vapor-queues")
+        {
+            guard let name = CommandLine.arguments.firstIndex(of: "--queue") else {
+                return .queue(name: "default")
+            }
+
+            return .queue(name: CommandLine.arguments[name + 1])
+        } else {
+            return .http
+        }
+    }
+}