llama_index icon indicating copy to clipboard operation
llama_index copied to clipboard

[Docs]: Add OpenLIT to Observability Docs

Open patcher9 opened this issue 9 months ago • 0 comments

Description

Added documentation on how to instrument LlamaIndex calls using OpenLIT and get observability on it.

OpenLIT provides OTel Auto instrumentation for LLM Applicatio which includes trace and metrics. This covers tracking of prompt, responses, costs, tokens, request/response metadata and performance metrics

Fixes # (issue) NA

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

  • [ ] Yes
  • [ ] No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • [ ] Yes
  • [ ] No

Type of Change

Please delete options that are not relevant.

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • [ ] Added new unit/integration tests
  • [ ] Added new notebook (that tests end-to-end)
  • [ ] I stared at the code and made sure it makes sense

Suggested Checklist:

  • [x] I have performed a self-review of my own code
  • [x] I have commented my code, particularly in hard-to-understand areas
  • [x] I have made corresponding changes to the documentation
  • [ ] I have added Google Colab support for the newly added notebooks.
  • [x] My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass locally with my changes
  • [ ] I ran make format; make lint to appease the lint gods

patcher9 avatar May 24 '24 11:05 patcher9