Skip to content

Commit e6bab0c

Browse files
committed
Add README and community documentation
1 parent b829255 commit e6bab0c

4 files changed

Lines changed: 91 additions & 0 deletions

File tree

CODEOWNERS

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Lines starting with '#' are comments.
2+
# Each line is a file pattern followed by one or more owners.
3+
4+
# More details are here: https://help.github.com/articles/about-codeowners/
5+
6+
# The '*' pattern is global owners.
7+
8+
# Order is important. The last matching pattern has the most precedence.
9+
# The folders are ordered as follows:
10+
11+
# In each subsection folders are ordered first by depth, then alphabetically.
12+
# This should make it easy to add new rules without breaking existing ones.
13+
14+
# Global rule:
15+
* @clarissalimab

CODE_OF_CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Code of conduct
2+
3+
By participating in this project, you agree to abide by the
4+
[thoughtbot code of conduct][1].
5+
6+
[1]: https://thoughtbot.com/open-source-code-of-conduct

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) Clarissa Borges and thoughtbot, inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# OpenTelemetry RubyLLM Instrumentation
2+
3+
OpenTelemetry instrumentation for [RubyLLM](https://rubyllm.com).
4+
5+
## How do I get started?
6+
7+
Install the gem using:
8+
9+
```sh
10+
gem opentelemetry-instrumentation-ruby_llm
11+
```
12+
13+
Or, if you use [bundler](https://bundler.io/), include `opentelemetry-instrumentation-ruby_llm` in your `Gemfile`.
14+
15+
## Usage
16+
17+
To use the instrumentation, call `use` with the name of the instrumentation:
18+
19+
```ruby
20+
OpenTelemetry::SDK.configure do |c|
21+
c.use 'OpenTelemetry::Instrumentation::RubyLLM'
22+
end
23+
```
24+
25+
Alternatively, you can also call `use_all` to install all the available instrumentation.
26+
27+
```ruby
28+
OpenTelemetry::SDK.configure do |c|
29+
c.use_all
30+
end
31+
```
32+
33+
## What's traced?
34+
35+
| Feature | Status |
36+
|---------|--------|
37+
| Chat completions | Supported |
38+
| Tool calls | Supported |
39+
| Error handling | Supported |
40+
| Embeddings | Planned |
41+
| Streaming | Planned |
42+
43+
This gem follows the [OpenTelemetry GenAI Semantic Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/).
44+
45+
## License
46+
47+
Copyright (c) Clarissa Borges and thoughtbot, inc.
48+
49+
This gem is free software and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)