Add Documentation for Monitoring

[patcher9]

Hi team, I've updated the documentation to include both Julep's built-in Prometheus metrics and how to integrate with OpenLIT for better monitoring.

I am one of the maintainers of OpenLIT and we support Obserability for LLM apps built using Julep AI, It is all OpenTelemetry-native so the traces and metrics can be sent to any platform like Grafana or any OSS OTel tools

Although I know Julep has Prometheus metrics inbuilt like various countres, OpenLIT helps when the users are using LLM + VectorDBs + Other framework actions as the consolidated monitoring gives them a complete picture.

Figured the mention here might be useful for developers using Julep hence adding the reference in documentation page.

Let me know your thoughts on this and placement for this!

Important

Adds docs/monitoring.md with instructions for setting up monitoring using Prometheus and OpenTelemetry with OpenLIT.

• Documentation:
  • Adds docs/monitoring.md with a guide for setting up monitoring using Prometheus and Grafana.
  • Includes instructions for integrating OpenTelemetry with OpenLIT.
• Prometheus Setup:
  • Steps to clone the Julep repository and set up Grafana and Prometheus using Docker Compose.
  • Lists available Prometheus metrics for monitoring Julep operations.
• OpenTelemetry Integration:
  • Instructions for installing openlit and julep.
  • Steps to deploy OpenLIT stack and instrument Julep AI application.
  • Details on configuring OpenTelemetry endpoints and visualizing data.

^{This description was created by for 7ecb62a. It will automatically update as commits are pushed.}

[standard-input]

No issues flagged.
Standard Input can make mistakes. Check important info.

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 7ecb62a in 11 seconds

More details

• Looked at 265 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 3 drafted comments based on config settings.

1. docs/monitoring.md:8

• Draft comment:
  Typo: 'Montoring' should be 'Monitoring'.
• Reason this comment was not posted:
  Confidence changes required: 50%
  The word 'Monitoring' is misspelled as 'Montoring'.

2. docs/monitoring.md:15

• Draft comment:
  Typo in repository URL: 'juelp-ai' should be 'julep-ai'.
• Reason this comment was not posted:
  Confidence changes required: 50%
  The GitHub repository URL has a typo in the organization name 'juelp-ai', it should be 'julep-ai'.

3. docs/monitoring.md:92

• Draft comment:
  Use 'docker-compose up -d' for consistency with previous command style.
• Reason this comment was not posted:
  Confidence changes required: 50%
  The command 'docker compose up -d' should be 'docker-compose up -d' for consistency with the previous command style.

Workflow ID: wflow_pCvXBgi4IU3XUvy3

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[creatorrr]

Thanks for the PR, @patcher9 ! I'd love to explore integrating openlit with julep even more closely. We are Apache 2.0 licensed, does that work with you guys?

[patcher9]

@creatorrr We love Apache 2.0! (OpenLIT is also completely Apache 2.0). And yup would love integrating with you folks!

[patcher9]

Hey @creatorrr I can also directly add this in the Julep code base, Such that when we detect the required ENVs, We can directly initialize monitoring for the user. What do you think?