Skip to content

Commit

Permalink
Update traceloop.md (#90)
Browse files Browse the repository at this point in the history
  • Loading branch information
bilgeyucel authored Dec 19, 2023
1 parent 4b9f7b6 commit 6a552be
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions integrations/traceloop.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,14 @@ repo: https://github.com/traceloop/openllmetry
type: Monitoring
report_issue: https://github.com/traceloop/openllmetry/issues
logo: /logos/traceloop.png
toc: true
---

- [OpenLLMetry](#openllmetry)
- [Installation](#installation)
- [Example](#example)
- [About Traceloop](#about-traceloop)

# OpenLLMetry

OpenLLMetry is an open-source Python package built and maintained by Traceloop that instruments your Haystack-based applications with OpenTelemetry. This gives you full visibility to your LLM app, right in your existing observability stack. You can also connect this to Traceloop to get quality evaluation metrics and LLM-specific capabilities like Prompt Playground.
Expand All @@ -22,13 +28,13 @@ OpenLLMetry is an open-source Python package built and maintained by Traceloop t

More info on the [documentation](https://traceloop.com/docs/python-sdk).

# Installation
## Installation

```
pip install traceloop-sdk
```

# Integration
## Example

Basic integration is as simple as adding one line to your code:

Expand All @@ -39,14 +45,14 @@ Traceloop.init(app_name="your_app_name")
When you run your code, you'll get a link to the Traceloop UI where you can see your app's traces.
If you want to connect to a different observability platform, [follow the guide for exporting your traces](https://traceloop.com/docs/python-sdk/exporting).

## Use a Traceloop API Key
### Use a Traceloop API Key

If you have an account with Traceloop and would like to see your traces on your account dashboard:

- Create an API key on Traceloop
- Export the API key in an environment variable called `TRACELOOP_API_KEY`

## Trace Haystack Pipelines
### Trace Haystack Pipelines

Once you've initialized a Traceloop app, any Haystack pipeline that you run in the same environment will get logged in the dashboard provided by the generated Traceloop URL.
For example, below is a simple Haystack pipeline and its traceloop logs:
Expand Down

0 comments on commit 6a552be

Please sign in to comment.