Merge pull request #38 from basedosdados/add-env-variables

chore: add env variables

Author: vrtornisiello

.env.example

@@ -0,0 +1,17 @@
+# Backend API host and port
+API_HOST=localhost
+API_PORT=8000
+
+# Log level
+LOG_LEVEL=DEBUG
+
+# Whether the full stacktrace should be shown when logging exceptions.
+LOG_BACKTRACE=true
+
+# Whether exception traces should display the variables values,
+# for debugging. Should be se to False in production.
+LOG_DIAGNOSE=false
+
+# Whether the messages to be logged should first pass through
+# a multiprocessing-safe queue before reaching the sink.
+LOG_ENQUEUE=true

.github/workflows/deploy-dev.yaml

@@ -59,6 +59,13 @@ jobs:
               name: ghcr.io/${{ github.repository }}
               tag: dev
               pullPolicy: Always
+            env:
+              API_HOST: api-development-service
+              API_PORT: 80
+              LOG_LEVEL: INFO
+              LOG_BACKTRACE: true
+              LOG_DIAGNOSE: false
+              LOG_ENQUEUE: true
             replicas: 1
             resources:
               requests:

README.md

@@ -1,32 +1,33 @@
 # Interface do Chatbot da BD, feita com [Streamlit](https://streamlit.io/)
 
 ## Instruções
-A interface do chatbot pode ser executada localmente utilizando o Docker ou o Python.
+Copie o arquivo `.env.example` e ajuste os valores:
+```bash
+cp .env.example .env
+```
+Em seguida, execute a aplicação localmente utilizando o Docker ou o Python. 
 
 ### Docker
-Instale o Docker seguindo as [instruções de instalação](https://docs.docker.com/engine/install/), de acordo com a distribuição linux que você usa. Em seguida, a partir da raiz deste repositório, execute os comandos:
+Instale o Docker seguindo as [instruções de instalação](https://docs.docker.com/engine/install/), de acordo com a distribuição linux que você usa. Em seguida, a partir da raiz do repositório, construa a imagem:
+```bash
+docker build -t nome-da-tag:latest .
 ```
-docker build -t <nome-da-tag>:latest .
-docker run <nome-da-tag>:latest
+E execute o container:
+```bash
+docker run --env-file .env -p 8501:8501 nome-da-tag:latest
 ```
+A aplicação estará disponível em `http://localhost:8501`
+
 > [!TIP]
 > Você pode adicionar a flag `--rm` ao comando `docker run` para remover o container após a sua execução.
 ### Python
 
-Crie um ambiente virtual e ative-o:
-```
-python3 -m venv <caminho-para-o-venv>
-. <caminho-para-o-venv>/bin/activate
-```
-Em seguida, a partir da raíz deste repositório, instale o pacote:
-```
-pip install --upgrade pip
-pip install .
-```
-E execute-o utilizando o streamlit:
+Instale o [Poetry](https://python-poetry.org/docs/). Em seguida, a partir da raíz do repositório, instale o pacote: 
+```bash
+poetry install
 ```
+
+E execute a aplicação utilizando o streamlit:
+```bash
 streamlit run frontend/main.py
 ```
-> [!TIP]
-> - Você pode adicionar a flag `-e` para instalar o pacote no modo editável durante o desenvolvimento.
-> - Você pode criar o ambiente virtual e fazer a instalação do pacote utilizando ferramentas como o [uv](https://docs.astral.sh/uv/) ou o [poetry](https://python-poetry.org/docs/).

charts/basedosdados-chatbot-frontend/templates/deployment.yaml

@@ -34,9 +34,16 @@ spec:
           ports:
             - name: streamlit
               containerPort: 8501
-          volumeMounts:
-            - name: chatbot-log-volume
-              mountPath: /var/log/chatbot
+          env:
+            {{- $env := .Values.chatbotFrontend.env | default dict }}
+            - name: API_HOST
+              value: {{ required ".Values.chatbotFrontend.env.API_HOST is required" $env.API_HOST | quote }}
+            - name: API_PORT
+              value: {{ required ".Values.chatbotFrontend.env.API_PORT is required" $env.API_PORT | quote }}
+          {{- range $key, $value := omit $env "API_HOST" "API_PORT" }}
+            - name: {{ $key }}
+              value: {{ $value | quote }}
+          {{- end }}
           {{- with .Values.chatbotFrontend.resources }}
           resources:
             {{- toYaml . | nindent 12 }}
@@ -53,9 +60,4 @@ spec:
               port: 8501
             initialDelaySeconds: 10
             periodSeconds: 10
-      # TODO: use persistent volume
-      volumes:
-        - name: chatbot-log-volume
-          emptyDir:
-            sizeLimit: 500Mi
       restartPolicy: Always

charts/basedosdados-chatbot-frontend/values.yaml

@@ -9,16 +9,25 @@ chatbotFrontend:
     tag: stable
     pullPolicy: Always
 
+  # Environment variables
+  env:
+    API_HOST: localhost
+    API_PORT: 8000
+    LOG_LEVEL: DEBUG
+    LOG_BACKTRACE: true
+    LOG_DIAGNOSE: false
+    LOG_ENQUEUE: true
+
   # Number of replicas
   replicas: 1
 
   # Resource specification
   resources:
     requests:
-      cpu: 1
+      cpu: 250m
       memory: 500Mi
     limits:
-      cpu: 1
+      cpu: 500m
       memory: 1Gi
 
   # Ingress configuration

frontend/main.py

@@ -1,24 +1,19 @@
+import sys
 import time
 from functools import cache
-from pathlib import Path
 
 import streamlit as st
 from loguru import logger
 
 from frontend.api import APIClient
 from frontend.components.chat_page import ChatPage
 from frontend.utils.constants import (BASE_URL, LOG_BACKTRACE, LOG_DIAGNOSE,
-                                      LOG_ENQUEUE, LOG_FILE_PATH, LOG_LEVEL,
-                                      LOG_RETENTION, LOG_ROTATION, NEW_CHAT)
+                                      LOG_ENQUEUE, LOG_LEVEL, NEW_CHAT)
 from frontend.utils.logos import BD_LOGO
 
 
 @cache
 def _setup_logger():
-    # Create log directory
-    log_path = Path(LOG_FILE_PATH)
-    log_path.parent.mkdir(parents=True, exist_ok=True)
-
     # Remove default handler
     logger.remove()
 
@@ -37,11 +32,9 @@ def _format(record):
 
     # Add handler to logger
     logger.add(
-        sink=LOG_FILE_PATH,
+        sink=sys.stdout,
         level=LOG_LEVEL,
         format=_format,
-        rotation=LOG_ROTATION,
-        retention=LOG_RETENTION,
         backtrace=LOG_BACKTRACE,
         diagnose=LOG_DIAGNOSE,
         enqueue=LOG_ENQUEUE
@@ -109,27 +102,27 @@ def about():
 
     st.write("\n")
 
-    st.subheader("Bem Vindo(a)! :wave:")
+    st.subheader("Bem Vindo(a)! 👋")
     st.write(f"Bem vindo(a) ao chatbot da BD! Ele vai te ajudar a conversar com seus dados! Basta entrar na página de chat no menu à esquerda e começar a conversa. Faça perguntas sobre os dados disponíveis e o chatbot dará o seu melhor para respondê-las!", unsafe_allow_html=True)
 
     st.write("\n")
 
     # Available models
-    st.subheader("Modelo :brain:")
+    st.subheader("Modelo 🧠")
     st.write("O modelo por trás do chatbot é o Gemini, do Google.")
 
     st.write("\n")
 
     # Available features
-    st.subheader("Funcionalidades :memo:")
+    st.subheader("Funcionalidades 🛠️")
     st.write("""
-        - **Feedback (:material/thumb_up: ou :material/thumb_down:):** Clique nos botões de feedback para enviar feedbacks sobre as respostas recebidas, com comentários opcionais.
-        - **Excluir Conversa (:material/delete:):** Clique no botão de excluir conversa para excluir a conversa com o chatbot. Essa ação é irreversível."""
+        - **Feedback (:material/thumb_up: ou :material/thumb_down:):** Clique nos botões de feedback para avaliar as respostas, com comentários opcionais.
+        - **Excluir Conversa (:material/delete:):** Clique no botão de excluir conversa para excluir a conversa com o chatbot. As mensagens permanecerão salvas em nosso banco de dados para análise e melhoria do produto."""
     )
     st.write("\n")
 
     # Prompting guide
-    st.subheader("Guia de Prompt :clipboard:")
+    st.subheader("Guia de Prompt 📋")
     st.write("A forma como você conversa com o chatbot pode influenciar na qualidade das respostas! Por isso, abaixo estão listadas algumas dicas para te ajudar a elaborar suas perguntas. Elas podem ser úteis caso as respostas fornecidas estejam incorretas ou não sejam boas o suficiente!")
     st.write("""
         1. Tente fazer uma pergunta por vez. Caso sua pergunta seja muito complexa, ou talvez seja um conjunto de várias perguntas, tente separá-la em perguntas menores e mais simples.
@@ -140,8 +133,8 @@ def about():
     st.write("\n")
 
     # Important information
-    st.subheader("Importante :pushpin:")
-    st.info("Depois de enviar uma pergunta ao chatbot, espere até que uma resposta seja fornecida antes de trocar de página ou clicar em qualquer botão dentro da aplicação. Você pode alternar entre as abas do seu navegador normalmente.")
+    st.subheader("Importante 📌")
+    st.info("⏳ Depois de enviar uma pergunta ao chatbot, aguarde a resposta completa antes de trocar de página ou clicar em botões. Você pode alternar entre abas do navegador normalmente.")
 
 if st.session_state.get("logged_in"):
     about_page = st.Page(page=about, title="Conheça o App", icon=":material/lightbulb_2:")

frontend/utils/constants.py

@@ -1,30 +1,27 @@
-# API variables
-API_HOST = "api-development-service"
-API_PORT = 80
-BASE_URL = f"http://{API_HOST}:{API_PORT}" # Base API URL
+import os
 
-# Set log sink.
-LOG_FILE_PATH = "/var/log/chatbot/frontend.log"
+import dotenv
 
-# Set log level.
-LOG_LEVEL = "DEBUG"
+dotenv.load_dotenv()
 
-# Rotate logs daily.
-LOG_ROTATION = "1 day"
+# API variables
+API_HOST = os.environ["API_HOST"]
+API_PORT = os.environ["API_PORT"]
+BASE_URL = f"http://{API_HOST}:{API_PORT}" # Base API URL
 
-# Don't delete old logs.
-LOG_RETENTION = None
+# Set log level
+LOG_LEVEL = os.getenv("LOG_LEVEL", "DEBUG")
 
-# Whether the full stacktrace should be shown when logging exceptions.
-LOG_BACKTRACE = True
+# Whether the full stacktrace should be shown when logging exceptions
+LOG_BACKTRACE = os.getenv("LOG_BACKTRACE", "true").lower() == "true"
 
 # Whether exception traces should display the variables values,
-# for debugging. Should be se to False in production.
-LOG_DIAGNOSE = False
+# for debugging. Should be se to False in production
+LOG_DIAGNOSE = os.getenv("LOG_DIAGNOSE", "false").lower() == "true"
 
 # Whether the messages to be logged should first pass through
-# a multiprocessing-safe queue before reaching the sink.
-LOG_ENQUEUE = True
+# a multiprocessing-safe queue before reaching the sink
+LOG_ENQUEUE = os.getenv("LOG_ENQUEUE", "true").lower() == "true"
 
-# Key for storing an empty chat page in the session state.
+# Key for storing an empty chat page in the session state
 NEW_CHAT = "new_chat"

poetry.lock

@@ -11,6 +11,7 @@ dependencies = [
     "httpx (>=0.28.1,<0.29.0)",
     "loguru (>=0.7.3,<0.8.0)",
     "pydantic (>=2.11.7,<3.0.0)",
+    "python-dotenv (>=1.2.1,<2.0.0)",
     "sqlparse (>=0.5.3,<0.6.0)",
     "streamlit (==1.49.0)",
     "streamlit-extras (==0.5.5)"