traceloop / traceloop/openllmetry

🚀 Feature: Suggestion: Add beginner-friendly example for LLM tracing

Open
#4,069 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
7.4k
Forks
1.1k
Avg merge
8d 14h
Merged PRs (30d)
2

Description

Which component is this feature for?

AlephAlpha Instrumentation

🔖 Feature description

Hi,

This project is very interesting and useful for LLM observability.

I think adding a simple beginner-friendly example (e.g., tracking a basic LLM call step-by-step) would help new users understand how to get started quickly.

I’d be happy to contribute to this if it’s helpful.

Thanks!

🎤 Why is this feature needed ?

Currently, new users who are not familiar with LLM observability may find it difficult to understand how to get started with tracing.

While the documentation is helpful, a simple step-by-step beginner example demonstrating how to trace a basic LLM call would make onboarding much easier.

This would help users quickly understand how the library works in practice and reduce the learning curve, especially for those new to observability concepts.

✌️ How do you aim to achieve this?

I plan to create a simple, beginner-friendly example demonstrating LLM tracing.

This would include:

  • A minimal setup guide for installing and initializing the library
  • A basic example of making an LLM call
  • Adding tracing to capture the request and response
  • Showing how to view or log the trace output

The example will be written in a clear, step-by-step format so that new users can easily follow and understand how the tracing works in practice.

🔄️ Additional Information

No response

👀 Have you spent some time to check if this feature request has been raised before?
  • I checked and didn't find similar issue
Are you willing to submit PR?

Yes I am willing to submit a PR!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the AlephAlpha Instrumentation documentation and its current installation, initialization, LLM-call, and trace-output guidance. Add a clear beginner example that walks through setup, a basic LLM call, request and response tracing, and viewing or logging the resulting trace. It is done when a new user can follow the steps from setup through visible trace output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ai, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.