Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Enhanced Logging, Feedback Features, and Web UI for Production Use #401

Open
MingYHou opened this issue Aug 30, 2024 · 4 comments

Comments

@MingYHou
Copy link

1. Comprehensive Logging System:

I would like to request the implementation of a comprehensive logging system in TaskWeaver. The goal is to log all activities and processes related to the operation of TaskWeaver, ensuring that every detail is captured and stored permanently. Specifically, the following should be logged:

  • User Actions: All user interactions with the system, including commands executed, inputs provided, and any changes made.
  • Process Execution: Details of all processes initiated by TaskWeaver, including start time, end time, and any intermediate steps or sub-processes.
  • System Events: All system-level events related to TaskWeaver's operation, such as errors, warnings, and successful completions.
  • Role-Based Logging: Track and log the roles associated with each action, ensuring that permissions and responsibilities are clear.
  • Session History: Complete logs of session histories, including all inputs, outputs, and modifications within each session.
  • Data Flow: Details of any data exchanged or processed during the operation of TaskWeaver.
  • Security Events: Log security-related events, such as authentication attempts, access control checks, and any detected anomalies.
    These logs should be stored in a permanent storage solution with easy retrieval options for auditing and analysis.

2. User Feedback Feature in Web UI:

I propose the addition of a feedback feature in the TaskWeaver Web UI. This feature should allow users to provide feedback on their experience with TaskWeaver, specifically:

  • Session Feedback: Allow users to rate and comment on their experience during specific sessions. This could include feedback on the accuracy, relevance, and usability of TaskWeaver's responses.
  • Answer Feedback: Provide users the option to give feedback on individual answers provided by TaskWeaver. This can help in fine-tuning responses and improving the overall quality of the service.
  • Feedback Management: Implement a system for viewing, managing, and analyzing the feedback received to continuously improve the service.

3. Web UI for Production Use:

According to the documentation, the TaskWeaver Web UI is currently intended for development and testing purposes only. Could you please provide guidance on how the Web UI can be utilized in a production environment? Specifically:

  • Are there any configurations or modifications needed to make the Web UI production-ready?
  • What are the potential risks or limitations of using the Web UI in production?
  • Is there a roadmap for making the Web UI officially supported for production use?
    Understanding this will help us better integrate TaskWeaver into our workflow and ensure a smooth operation in a production setting.

Thank you for considering these feature requests. I believe they will add significant value to the TaskWeaver platform.

@liqul
Copy link
Contributor

liqul commented Sep 2, 2024

Thanks for the suggestions and welcome to contribute :)

@MingYHou
Copy link
Author

MingYHou commented Sep 3, 2024

Hi liqul,
Thanks for your reply!
I was wondering if there're any features already there or in development, such as logging, feedback feature or an ui that works in production environment.
Thanks!

@liqul
Copy link
Contributor

liqul commented Sep 3, 2024

I think you can find the current status of telemetry here which pretty much covered the session including input and output for important components.

We didn't spend much effort in building the UI so far, simply relying on the Chainlit lib for demonstration purpose. We don't have any plans (and also resources) to improve the UI for production usage. I think Chainlit provides basic support for feedback collection such as thumb up/down. If you need to store the feedback, you probably need to implement a hook.

@MingYHou
Copy link
Author

MingYHou commented Sep 3, 2024

Thanks! Is it ok to deploy the ui in production environment? I saw it in the documentation "TaskWeaver Web UI is currently intended for development and testing purposes only".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants