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

Docs for Bee Observe #6

Open
mmurad2 opened this issue Nov 17, 2024 · 2 comments
Open

Docs for Bee Observe #6

mmurad2 opened this issue Nov 17, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@mmurad2
Copy link
Member

mmurad2 commented Nov 17, 2024

Is your feature request related to a problem? Please describe.
Users need additional guidance to make the most out of the framework's emitter, logging, and observability functionality. Ideally this should be one guide that ties all these concepts together.

Describe the solution you'd like
A user-facing docs page that would either live as a module here, or as a separate page under i-am-bee docs page.

The docs should cover the following:

  • Why observability is important for building production-grade agents
  • How Bee-observe helps users (key feature / functionality highlights). It would be good here to explain the connection to the framework's emitter functionality.
  • Getting started guide (pull from readme)
  • How to use the MLflow integration -- it would be good here to explain how data gets visualized and how to interpret different errors.
  • How to use other backends / observability UIs

Describe alternatives you've considered
NA

Additional context
This is coming from a user request with a specific ask to cover the following:

  • What are the partial updates?
  • Why do some updates track LLM streaming output while others don't
@mmurad2 mmurad2 added the documentation Improvements or additions to documentation label Nov 17, 2024
@Max-Jesch
Copy link

I failed to setup up bee-observe locally. I find the documentation confusing. There is a yarn, a npm and a docker approach described and there is also a docker_compose file wich is not mentioned in the readme.

In the bee-frameworker-starter there is also a short description which is kind of conflicting with this readme .

@Max-Jesch
Copy link

Max-Jesch commented Jan 9, 2025

The mentioned ./compose-before.yml does also not exist. It is also unclear to me why Get started with Observe is completly different from Local set-up

I would absolutly love to use this though. It sounds amazing. Keep up the great work :-)

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

No branches or pull requests

2 participants