docs-website
docs-website copied to clipboard
feat: OpenLIT Integration Documentation
Please follow conventional commit standards in your commit messages and pull request title.
Give us some context
- What problems does this PR solve?
- This PR adds documentation on how users can use OpenLT for complete LLM Stack Observability (LLMs, VectorDBs, GPUs) and send the OTel native metrics and traces to New Relic.
- Add any context that will help us review your changes such as testing notes,
links to related docs, screenshots, etc.
- This doc is similar to the one added for Traceloop. For reference, OpenLIT is also referenced in the official OTel Blog on LLM Observability (here)
- If your issue relates to an existing GitHub issue, please link to it.
- No open issue
Question: I have linked a pre-built dashboard too in the doc but wondering if the dashboard JSON needs to be added to this repo or not.
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.
:white_check_mark: nbaenam
:x: patcher9
patcher9 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.
Hi @patcher9 👋
Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.
We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).
Deploy Preview for docs-website-netlify ready!
| Name | Link |
|---|---|
| Latest commit | 5f64bf7a0a38aacd894f30172167c18265d68b1e |
| Latest deploy log | https://app.netlify.com/sites/docs-website-netlify/deploys/670513e89830f30008de1a07 |
| Deploy Preview | https://deploy-preview-18332--docs-website-netlify.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Hey @ally-sassman, this PR is related to OTEL, so I think you prefer to review it. Let me know if you don't do OTEL docs anymore. I just got back from vacation.
Hey @ally-sassman, I just realized that you're on vacation until the 20th, so I'll check it.
Hey @patcher9, do you work for NR?
Hi @patcher9, thanks for adding this! I've added some TW edits
Thanks @nbaenam, LGTM
Hey @patcher9, do you work for NR?
Hey @patcher9, do you work for NR?
Hey, Nope. I am one of the maintainer of OpenLIT
Hi @patcher9, I'll merge it when the eng team tests this new update.
Hi @patcher9, I'll merge it when the eng team tests this new update.
Sounds good
This is the Eng ticket: NR-304719
Thanks @nbaenam for the update!
Hey @nbaenam Any update on this?
Hey @patcher9, our engineers are reviewing it. I'll merge it when I have their approval ;-)
Hi @patcher9, Can we connect regarding adding in-platform integration with OpenLIT?
@shwartzm-NR Sure that'll be lovely, You can reach out to me at [email protected] or Aman who is also a maintainer for OpenLIT at [email protected]
Hello
We have Created a simple application using the code provided in the docs And created a Dashboard using the example dashboard provided in this docs.
However, We see so much data missing when used this dashboard provided in docs, We did modify some queries to minimise the missing parts. Still, some parts as shown in pictures below are missing.
Links to comparing dashboard example provided in openlit and updated ones
We wanted to bring this to your notice and know if this is the expected behaviour.
Hey @konda-lavanya
Thanks for the review. The empty panels for VectorDB is expected as we don't use that in our example application so shoudn't generate any usage data. (We wanted to keep it part of same dashboard as people use LLMs and VectorDBs together most cases)
I see a panel in the last picture was wrongly named so fixed that. and the empty columns in tables are also removed. Thanks for catching that.
You can find the updated dashboard (Its the same link as before) - https://docs.openlit.io/latest/connections/new-relic#dashboard
Also if you need a sample application with vectordb, You can try out code from this gist aswell - https://gist.github.com/patcher9/103a95a3268ff68f055b59cecf9ea836
happy to help if you face any issues
Hello @patcher9, Looks like the dashboard is not updated in https://docs.openlit.io/latest/connections/new-relic#dashboard as a lot of data is missing. Please refer to images uploaded.
Hey @konda-lavanya, I did find a couple issues in the dashboard and I have fixed those. I have also attached te screenshot for the filled dashboard after the update I just made. Tested it with another account for sanity. Lemme know if you still face any issues.
The dashboard JSON is updated aswell here
Hey @patcher9 , I have re-tested with the updated query and there is only a minor thing missing, Some columns are missing in GenAI Requests table as shown in table. I've added the query change too, Please check.
Query provided in dashboard
SELECT timestamp, trace.id, gen_ai.operation.name AS 'Category', gen_ai.environment AS 'Environment', gen_ai.application_name AS 'Application', gen_ai.request.model AS 'Model', gen_ai.usage.cost AS 'Usage Cost', duration.ms AS 'Duration' FROM Span WHERE gen_ai.operation.name != 'vectordb' And gen_ai.operation.name != 'framework'
Updated Query
SELECT timestamp, trace.id, gen_ai.operation.name AS 'Category', gen_ai.environment AS 'Environment', gen_ai.application_name AS 'Application', gen_ai.request.model AS 'Model', gen_ai.usage.cost AS 'Usage Cost', duration.ms AS 'Duration' FROM Span WHERE gen_ai.operation.name != 'vectordb' And gen_ai.operation.name != 'framework' And telemetry.sdk.name = 'openlit'
Adding screenshots of dashboard created for record:
Hey @konda-lavanya Thanks for the update and the suggestion! I have fixed the dashboard JSON which includes your suggestion. Really Appreciate it!
@nbaenam Checking in on this - is this ready to be merged?
This looks good to go. Thank you @patcher9 for all the updates.
Hey @patcher9, the PR is ready to merge now, but could you sign the CLA again, even if you have signed it in the past? We can't merge it without signing the CLA. Thanks!
Hey @nbaenam Mind if I create another PR and close this one? Context: I updated my GitHub email id and now all the commits are not linked to my account which is causing the CLA failure (I cant seem to be able to sign it again aswell)
No, I don't mind, @patcher9