Add initial share logs page (#4965)

* Add initial share logs page

* Fix title sizes

* Update share_logs.md

Added some text for reasons to share logs

* Add section on how to share logs using e2b

* Fix path to images with sizes

* Fix paths to images in docs

* Fix formatting

* Fix formatting

* Fix grammar

* Make position in menu more prominent

* original log directory was incorrect

I took the directory from usage.md but that is incorrect

* Updated the directory for the logs

Updated the directory for the logs

* added some text

and made it pretty

---------

Co-authored-by: NeonN3mesis <129052650+NeonN3mesis@users.noreply.github.com>
Co-authored-by: Reinier van der Leer <github@pwuts.nl>
This commit is contained in:
Vasek Mlejnsky
2023-07-13 18:14:57 -06:00
committed by GitHub
parent ed12b2c7d6
commit 7c4fc45b4a
7 changed files with 64 additions and 3 deletions

BIN
docs/imgs/e2b-dashboard.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 504 KiB

BIN
docs/imgs/e2b-log-url.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

BIN
docs/imgs/e2b-new-tag.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

52
docs/share-your-logs.md Normal file
View File

@@ -0,0 +1,52 @@
## Share your logs with us to help improve Auto-GPT
Do you notice weird behavior with your agent? Do you have an interesting use case? Do you have a bug you want to report?
Follow the steps below to enable your logs and upload them. You can include these logs when making an issue report or discussing an issue with us.
### Enable Debug Logs
Activity, Error, and Debug logs are located in `./logs`
To print out debug logs:
``` shell
./run.sh --debug # on Linux / macOS
.\run.bat --debug # on Windows
docker-compose run --rm auto-gpt --debug # in Docker
```
### Inspect and share logs
You can inspect and share logs via [e2b](https://e2b.dev).
![E2b logs dashboard](./imgs/e2b-dashboard.png)
1. Go to [autogpt.e2b.dev](https://autogpt.e2b.dev) and sign in.
2. You'll see logs from other members of the AutoGPT team that you can inspect.
3. Or you upload your own logs. Click on the "Upload log folder" button and select the debug logs dir that you generated. Wait a 1-2 seconds and the page reloads.
4. You can share logs via sharing the URL in your browser.
![E2b log URL](./imgs/e2b-log-url.png)
### Add tags to logs
You can add custom tags to logs for other members of your team. This is useful if you want to indicate that the agent is for example having issues with challenges.
E2b offers 3 types of severity:
- Success
- Warning
- Error
You can name your tag any way you want.
#### How to add a tag
1. Click on the "plus" button on the left from the logs folder name.
![E2b tag button](./imgs/e2b-tag-button.png)
2. Type the name of a new tag.
3. Select the severity.
![E2b new tag](./imgs/e2b-new-tag.png)

View File

@@ -89,12 +89,20 @@ This may give your bot increased intelligence.
## Logs
Activity and error logs are located in the `./output/logs`
Activity, Error, and Debug logs are located in `./logs`
!!! tip
Do you notice weird behavior with your agent? Do you have an interesting use case? Do you have a bug you want to report?
Follow the step below to enable your logs. You can include these logs when making an issue report or discussing an issue with us.
To print out debug logs:
``` shell
./run.sh --debug
./run.sh --debug # on Linux / macOS
.\run.bat --debug # on Windows
docker-compose run --rm auto-gpt --debug # in Docker
```
## Disabling Command Categories

View File

@@ -12,7 +12,8 @@ nav:
- Voice: configuration/voice.md
- Image Generation: configuration/imagegen.md
- Contributing:
- Help us improve Auto-GPT:
- Share your debug logs with us: share-your-logs.md
- Contribution guide: contributing.md
- Running tests: testing.md
- Code of Conduct: code-of-conduct.md