Skip to content

Add telemetry docs for python SDK#1083

Merged
scosman merged 1 commit intomainfrom
scosman/telemetry_docs_2
Feb 24, 2026
Merged

Add telemetry docs for python SDK#1083
scosman merged 1 commit intomainfrom
scosman/telemetry_docs_2

Conversation

@scosman
Copy link
Collaborator

@scosman scosman commented Feb 24, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guidance on connecting to telemetry and MLOps platforms, including supported integrations and provider information.

@scosman scosman requested a review from leonardmq February 24, 2026 16:19
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @scosman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation for the Kiln Python SDK by introducing a dedicated section on integrating with telemetry and MLOps platforms. The update provides users with clear guidance on leveraging the SDK's capabilities for trace tracking and observability through its LiteLLM dependency, thereby improving the discoverability and utility of these features.

Highlights

  • Telemetry/MLOps Documentation: Added a new section to the README.md detailing how to connect the Kiln SDK to various MLOps, trace tracking, and telemetry platforms.
  • LiteLLM Integration: The new documentation highlights that Kiln uses the LiteLLM SDK, which supports major telemetry providers like OpenTelemetry, Braintrust, MLFlow, and LangFuse, with links to their respective setup guides.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • libs/core/README.md
    • Added a new entry to the table of contents for 'Connecting to Telemetry / MLOps'.
    • Inserted a new section titled 'Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc.)' which explains the integration via LiteLLM SDK and provides links to specific provider documentation.
Activity
  • No specific activity has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 24, 2026

Walkthrough

Documentation update to the README file adding a new subsection about telemetry and MLOps integrations, describing supported providers including OpenTelemetry, Braintrust, MLFlow, and LangFuse with references.

Changes

Cohort / File(s) Summary
Documentation
libs/core/README.md
Added new "Connecting to Telemetry / MLOps" section to Table of Contents with descriptions of telemetry providers and supported integrations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

📚 A rabbit hops through README pages bright,
Adding telemetry's guiding light,
MLOps paths now clearly shown,
From Braintrust beams to LangFuse's throne,
Documentation blooms—what a delight! 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided; the template requires sections like 'What does this PR do?', 'Related Issues', and checklist items. Add a complete pull request description following the required template, including the PR objective, related issues, CLA confirmation, and completed checklists.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding telemetry documentation for the Python SDK.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch scosman/telemetry_docs_2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for connecting the Python SDK to telemetry and MLOps platforms. The changes are confined to libs/core/README.md, where a new section is added to explain the integration via LiteLLM and provides links to relevant documentation. The additions are clear and valuable. I have one suggestion to improve a link for better usability.

@github-actions
Copy link

📊 Coverage Report

Overall Coverage: 91%

Diff: origin/main...HEAD

No lines with coverage information in this diff.


Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@libs/core/README.md`:
- Line 445: Change the markdown link text "LangFuse" to use the canonical
product casing "Langfuse" in the README entry (update the link text inside the
list item currently showing
"[LangFuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)"
to
"[Langfuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)").
Ensure only the displayed text is changed, not the URL.
- Line 436: Update the Markdown heading "## Connecting to Telemetry / MLOps
(OpenTelemetry, Braintrust, etc)" to include the missing period after "etc"
(i.e., change to "etc.") so it follows American English convention; make the
change in the README heading text exactly where the heading string appears to
ensure links/anchors remain valid.

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e80c067 and ce6b564.

📒 Files selected for processing (1)
  • libs/core/README.md


While Kiln is designed for deploying to LlamaIndex, you don't need to use it. The `iter_llama_index_nodes` returns a `TextNode` object which includes all the data you need to build a RAG index in any stack: embedding, text, document name, chunk ID, etc.

## Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Minor: missing period after etc in section heading.

The static analysis tool flags this correctly — American English convention requires etc. (with a period).

✏️ Proposed fix
-## Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc)
+## Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc.)

The trailing period is stripped by GitHub's anchor-slug algorithm, so the TOC link at Line 51 (#connecting-to-telemetry--mlops-opentelemetry-braintrust-etc) remains valid after this change.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc)
## Connecting to Telemetry / MLOps (OpenTelemetry, Braintrust, etc.)
🧰 Tools
🪛 LanguageTool

[style] ~436-~436: In American English, abbreviations like “etc.” require a period.
Context: ...try / MLOps (OpenTelemetry, Braintrust, etc) You can connect the Kiln SDK to a wid...

(ETC_PERIOD)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@libs/core/README.md` at line 436, Update the Markdown heading "## Connecting
to Telemetry / MLOps (OpenTelemetry, Braintrust, etc)" to include the missing
period after "etc" (i.e., change to "etc.") so it follows American English
convention; make the change in the README heading text exactly where the heading
string appears to ensure links/anchors remain valid.

- [OpenTelemetry](https://docs.litellm.ai/docs/observability/opentelemetry_integration)
- [Braintrust](https://docs.litellm.ai/docs/observability/braintrust)
- [MLFlow](https://docs.litellm.ai/docs/observability/mlflow)
- [LangFuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Nit: casing inconsistency — LangFuseLangfuse.

The official product name (per its GitHub repo langfuse/langfuse and the LiteLLM docs title "Langfuse OpenTelemetry Integration") is Langfuse with a lowercase f. The other three entries use the providers' canonical capitalisation, so this one stands out.

✏️ Proposed fix
-- [LangFuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)
+- [Langfuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [LangFuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)
- [Langfuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@libs/core/README.md` at line 445, Change the markdown link text "LangFuse" to
use the canonical product casing "Langfuse" in the README entry (update the link
text inside the list item currently showing
"[LangFuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)"
to
"[Langfuse](https://docs.litellm.ai/docs/observability/langfuse_otel_integration)").
Ensure only the displayed text is changed, not the URL.

@scosman scosman merged commit 07e0fe3 into main Feb 24, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants