Enhancement - Improve playground error message and introduce new CLI command for cloudwatch logs

agenta-backend/agenta_backend/routers/app_router.py

@@ -1,10 +1,11 @@
 import os
 import logging
-from docker.errors import DockerException
-from fastapi.responses import JSONResponse
-from agenta_backend.config import settings
 from typing import List, Optional
+
+from fastapi.responses import JSONResponse
 from fastapi import APIRouter, HTTPException, Request
+
+from agenta_backend.config import settings
 from agenta_backend.services.selectors import get_user_own_org
 from agenta_backend.services import (
     app_manager,
@@ -26,6 +27,9 @@
 )
 from agenta_backend.models import converters
 
+from docker.errors import DockerException
+
+
 if os.environ["FEATURE_FLAG"] in ["cloud", "ee"]:
     from agenta_backend.commons.services.selectors import (
         get_user_and_org_id,

agenta-backend/agenta_backend/routers/variants_router.py

@@ -1,18 +1,15 @@
 import os
 import logging
-from docker.errors import DockerException
-from fastapi.responses import JSONResponse
 from typing import Any, Optional, Union
+
+from fastapi.responses import JSONResponse
 from fastapi import APIRouter, HTTPException, Request, Body
-from agenta_backend.services import (
-    app_manager,
-    db_manager,
-)
+
+from agenta_backend.services import app_manager, db_manager
 from agenta_backend.utils.common import (
     check_access_to_variant,
 )
 from agenta_backend.models import converters
-
 from agenta_backend.models.api.api_models import (
     Image,
     URI,
@@ -24,10 +21,14 @@
     VariantActionEnum,
 )
 
+from docker.errors import DockerException
+
+
 if os.environ["FEATURE_FLAG"] in ["cloud", "ee"]:
     from agenta_backend.commons.services.selectors import (
         get_user_and_org_id,
     )  # noqa pylint: disable-all
+    from agenta_backend.cloud.services import logs_manager
 else:
     from agenta_backend.services.selectors import get_user_and_org_id
 
@@ -275,3 +276,22 @@ async def start_variant(
             app_variant_db, envvars, **user_org_data
         )
     return url
+
+
+@router.get("/{variant_id}/logs/")
+async def retrieve_variant_logs(variant_id: str, request: Request):
+    app_variant = await db_manager.get_app_variant_instance_by_id(variant_id)
+    deployment = await db_manager.get_deployment_by_appId(str(app_variant.app.id))
+    if os.environ["FEATURE_FLAG"] == "cloud":
+        try:
+            logs_result = logs_manager.retrieve_cloudwatch_logs(
+                deployment.container_name
+            )
+        except Exception as exc:
+            raise HTTPException(500, {"message": str(exc)})
+        return logs_result
+
+    if os.environ["FEATURE_FLAG"] == "ee":
+        ...
+
+    return "Please specify the required agenta version for retrieving the logs."

agenta-backend/agenta_backend/services/db_manager.py

@@ -470,6 +470,23 @@ async def get_deployment_by_objectid(
     return deployment
 
 
+async def get_deployment_by_appId(app_id: str) -> DeploymentDB:
+    """Get the deployment object from the database with the provided app id.
+
+    Args:
+        app_id (str): The app ID
+
+    Returns:
+        DeploymentDB: instance of deployment object
+    """
+
+    deployment = await engine.find_one(
+        DeploymentDB, DeploymentDB.app == ObjectId(app_id)
+    )
+    logger.debug(f"deployment: {deployment}")
+    return deployment
+
+
 async def get_organization_object(organization_id: str) -> OrganizationDB:
     """
     Fetches an organization by its ID.
@@ -1213,7 +1230,7 @@ async def get_app_variant_by_app_name_and_environment(
     return app_variant_db
 
 
-async def get_app_variant_instance_by_id(variant_id: str):
+async def get_app_variant_instance_by_id(variant_id: str) -> AppVariantDB:
     """Get the app variant object from the database with the provided id.
 
     Arguments:

agenta-cli/agenta/cli/main.py

@@ -10,6 +10,7 @@
 
 from agenta.cli import helper
 from agenta.client import client
+from agenta.cli import variant_logs
 from agenta.cli import variant_configs
 from agenta.cli import variant_commands
 
@@ -192,6 +193,7 @@ def init(app_name: str):
 
 # Add the commands to the CLI group
 cli.add_command(init)
+cli.add_command(variant_logs.get)
 cli.add_command(variant_configs.config)
 cli.add_command(variant_commands.variant)
 

agenta-cli/agenta/cli/variant_logs.py

@@ -0,0 +1,116 @@
+import toml
+import click
+from pathlib import Path
+from agenta.client import client
+from agenta.cli.variant_commands import get_host
+
+
+@click.group()
+def get():
+    """Commands for variant logs"""
+    pass
+
+
+def config_check(app_folder: str):
+    """Check the config file and update it from the backend
+
+    Arguments:
+        app_folder -- the app folder
+    """
+
+    click.echo(click.style("\nChecking config file...", fg="yellow"))
+    app_folder = Path(app_folder)
+    config_file = app_folder / "config.toml"
+    if not config_file.exists():
+        click.echo(
+            click.style(
+                f"Config file not found in {app_folder}. Make sure you are in the right folder and that you have run agenta init first.",
+                fg="red",
+            )
+        )
+        return
+    return
+
+
+def get_api_key(app_folder: str) -> str:
+    """Retrieve app api key.
+
+    Args:
+        app_folder (str): The current folder of the app
+
+    Returns:
+        str: the api key
+    """
+
+    app_path = Path(app_folder)
+    config_file = app_path / "config.toml"
+    config = toml.load(config_file)
+    api_key = config.get("api_key", None)
+    return api_key
+
+
+@get.command(
+    name="logs",
+    context_settings=dict(
+        ignore_unknown_options=True,
+        allow_extra_args=True,
+    ),
+)
+@click.option("--variant", help="The ID of the variant.")
+@click.option("--app_folder", default=".")
+@click.pass_context
+def get_variant_logs_stream(ctx, variant: str, app_folder: str):
+    """Fetch the logs stream and events for a given lambda app function"""
+
+    try:
+        if not variant and len(ctx.args) > 0:
+            variant = ctx.args[0]
+
+        config_check(app_folder)
+        click.echo(
+            click.style(
+                "Retrieving variant logs stream from cloudwatch...", fg="yellow"
+            )
+        )
+        api_key = get_api_key(app_folder)
+        if not api_key:
+            click.echo(click.style(f"API Key is not specified\n", fg="red"))
+            return
+
+        backend_host = get_host(app_folder)
+        api_valid = client.validate_api_key(api_key=api_key, host=backend_host)
+        if api_valid:
+            logs_messages = client.retrieve_variant_logs(
+                variant_id=variant, api_key=api_key, host=backend_host
+            )
+            click.echo(
+                click.style(
+                    f"Successfully retrieved logs stream for variant {variant}! 🎉",
+                    fg="green",
+                )
+            )
+            click.echo(
+                click.style(
+                    "\n====================\nLOGS OUTPUT: \n===================="
+                )
+            )
+            if isinstance(logs_messages, list):
+                for item in logs_messages:
+                    click.echo(click.style(f"- {item.strip()}"))
+            else:
+                click.echo(click.style(f"- {logs_messages}"))
+            return
+        else:
+            click.echo(
+                click.style(
+                    "API Key is invalid. Please, update config.toml with the correct key.",
+                    fg="red",
+                )
+            )
+    except Exception as ex:
+        click.echo(
+            click.style(
+                f"Error fetching logs streams for variant {variant}: {ex}\n",
+                fg="red",
+            )
+        )

agenta-cli/agenta/client/client.py

@@ -524,3 +524,28 @@ def retrieve_user_id(host: str, api_key: Optional[str] = None) -> str:
         return response.json()["id"]
     except RequestException as e:
         raise APIRequestError(f"Request failed: {str(e)}")
+
+
+def retrieve_variant_logs(variant_id: str, api_key: Optional[str], host: str):
+    """Retrieve variant logs from the server.
+
+    Args:
+        app_name (str): The required app name
+        host (str): The URL of the Agenta backend
+        api_key (str): The API key to validate with
+    """
+
+    try:
+        response = requests.get(
+            f"{host}/{BACKEND_URL_SUFFIX}/variants/{variant_id}/logs/",
+            headers={"Authorization": api_key},
+            timeout=600,
+        )
+        if response.status_code != 200:
+            error_message = response.json().get("detail", "Unknown error")
+            raise APIRequestError(
+                f"Request to retrieve_variant_logs endpoint failed with status code {response.status_code}. Error message: {error_message}"
+            )
+        return response.json()
+    except RequestException as e:
+        raise APIRequestError(f"Request failed: {str(e)}")

agenta-web/src/components/Playground/ViewNavigation.tsx

@@ -9,13 +9,14 @@ import {useState} from "react"
 import axios from "axios"
 import {createUseStyles} from "react-jss"
 import {
+    getProfile,
     getAppContainerURL,
     removeVariant,
     restartAppVariantContainer,
     waitForAppToStart,
 } from "@/lib/services/api"
 import {useAppsData} from "@/contexts/app.context"
-import {isDemo} from "@/lib/helpers/utils"
+import {isDemo, isCloud, isEnterprise} from "@/lib/helpers/utils"
 
 interface Props {
     variant: Variant
@@ -111,14 +112,16 @@ const ViewNavigation: React.FC<Props> = ({
 
     if (isError) {
         let variantDesignator = variant.templateVariantName
-        let imageName = `agentaai/${(currentApp?.app_name || "").toLowerCase()}_`
+        let appName = currentApp?.app_name || ""
+        let imageName = `agentaai/${appName.toLowerCase()}_`
 
         if (!variantDesignator || variantDesignator === "") {
             variantDesignator = variant.variantName
             imageName += variantDesignator.toLowerCase()
         } else {
             imageName += variantDesignator.toLowerCase()
         }
+        console.log("Variant: ", variant)
 
         const variantContainerPath = async () => {
             const url = await getAppContainerURL(appId, variant.variantId, variant.baseId)
@@ -154,6 +157,7 @@ const ViewNavigation: React.FC<Props> = ({
         }
 
         const apiAddress = `${containerURI}/openapi.json`
+        const containerName = `${appName}-${variant.baseName}-${containerURI.split("/")[3]}` // [3] is the user organization id
         return (
             <div>
                 {error ? (
@@ -170,18 +174,46 @@ const ViewNavigation: React.FC<Props> = ({
                                 Verify whether the API is up by checking if {apiAddress} is
                                 accessible.
                             </li>
-                            <li>
-                                Check if the Docker container for the variant {variantDesignator} is
-                                running. The image should be called {imageName}.
-                            </li>
+                            {isCloud() && (
+                                <div>
+                                    <li>
+                                        Check if the lambda function for the variant{" "}
+                                        {variantDesignator} is active by running the following
+                                        command in your terminal:
+                                        <pre>
+                                            agenta get logs --variant {variant.variantId}
+                                        </pre> or <pre>agenta get logs {variant.variantId}</pre>
+                                        Running the above command will enable you to view the lambda
+                                        function latest logs stream events.
+                                    </li>
+                                </div>
+                            )}
+                            {isEnterprise() && (
+                                <div>
+                                    <li></li>
+                                </div>
+                            )}
+                            {!isCloud() && (
+                                <div>
+                                    <li>
+                                        Check if the Docker container for the variant{" "}
+                                        {variantDesignator} is active by running the following
+                                        command in your terminal:
+                                        <pre>docker logs {containerName} --tail 50 -f</pre>
+                                        Running the above command will enable you to continuously
+                                        stream the container logs in real-time as they are
+                                        generated.
+                                    </li>
+                                    <p>
+                                        {" "}
+                                        In case the docker container is not running, please check
+                                        the Docker logs to understand the issue. Most of the time,
+                                        it is due to missing requirements. Also, please attempt
+                                        restarting it (using cli or docker desktop).
+                                    </p>
+                                </div>
+                            )}
                         </ul>
-                        <p>
-                            {" "}
-                            In case the docker container is not running. Please check the logs from
-                            docker to understand the issue. Most of the time it is a missing
-                            requirements. Also, please attempt restarting it (using cli or docker
-                            desktop)
-                        </p>
                         <p>
                             {" "}
                             If the issue persists please file an issue in github here: