Adding RubyLLM Support

README.md

@@ -68,6 +68,66 @@ That's it. You're now tracing your code with OpenLLMetry!
 
 Now, you need to decide where to export the traces to.
 
+## ⚙️ Configuration
+
+### Service Name
+
+You can customize your service name by providing a `name` parameter:
+
+```ruby
+require "traceloop/sdk"
+
+# Without name parameter (uses OTEL_SERVICE_NAME as-is)
+traceloop = Traceloop::SDK::Traceloop.new
+# Service name: value of OTEL_SERVICE_NAME, or "unknown_service:ruby"
+
+# With name parameter (combines name with OTEL_ENVIRONMENT)
+traceloop = Traceloop::SDK::Traceloop.new(name: "worker")
+# Service name: "worker-production" (if OTEL_ENVIRONMENT="production")
+# Service name: "worker-unknown" (if OTEL_ENVIRONMENT not set)
+```
+
+### Multiple Service Instances
+
+You can create multiple Traceloop instances with different service names in the same application:
+
+```ruby
+traceloop_api = Traceloop::SDK::Traceloop.new(name: "api")
+traceloop_worker = Traceloop::SDK::Traceloop.new(name: "worker")
+traceloop_scheduler = Traceloop::SDK::Traceloop.new(name: "scheduler")
+
+# Each instance traces with its own service name (assuming OTEL_ENVIRONMENT="production"):
+# - "api-production"
+# - "worker-production"
+# - "scheduler-production"
+```
+
+### Environment Variables
+
+Control your service naming using standard OpenTelemetry environment variables:
+
+```bash
+# Used when no name parameter is provided
+export OTEL_SERVICE_NAME="my-app"
+
+# Combined with name parameter: "worker-production"
+export OTEL_ENVIRONMENT="production"
+```
+
+Defaults:
+- `OTEL_SERVICE_NAME` defaults to `"unknown_service:ruby"`
+- `OTEL_ENVIRONMENT` defaults to `"unknown"`
+
+### Cleanup
+
+When shutting down your application, ensure spans are properly flushed:
+
+```ruby
+traceloop = Traceloop::SDK::Traceloop.new
+# ... use traceloop ...
+traceloop.shutdown  # Flush remaining spans before exit
+```
+
 ## ⏫ Supported (and tested) destinations
 
 - [x] [Traceloop](https://www.traceloop.com/docs/openllmetry/integrations/traceloop)

sample-app/Gemfile.lock

@@ -30,7 +30,7 @@ GEM
     faraday-typhoeus (1.1.0)
       faraday (~> 2.0)
       typhoeus (~> 1.4)
-    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0)
     gemini-ai (4.2.0)
       event_stream_parser (~> 1.0)
       faraday (~> 2.10)
@@ -39,7 +39,7 @@ GEM
       typhoeus (~> 1.4, >= 1.4.1)
     google-cloud-env (2.2.1)
       faraday (>= 1.0, < 3.a)
-    google-protobuf (3.25.5-arm64-darwin)
+    google-protobuf (3.25.5)
     googleapis-common-protos-types (1.16.0)
       google-protobuf (>= 3.18, < 5.a)
     googleauth (1.11.2)
@@ -100,6 +100,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-23
+  x86_64-linux
 
 DEPENDENCIES
   aws-sdk-bedrockruntime (~> 1.14)

sample-app/bedrock.rb

@@ -1,8 +1,15 @@
 require 'aws-sdk-bedrockruntime'
 require "traceloop/sdk"
 
+# Example 1: No name parameter (backward compatible)
+# Uses OTEL_SERVICE_NAME as-is, or defaults to "unknown_service:ruby"
 traceloop = Traceloop::SDK::Traceloop.new
 
+# Example 2: With name parameter
+# Creates service name as "#{name}-#{OTEL_ENVIRONMENT}"
+# If OTEL_ENVIRONMENT="production", this creates "bedrock-worker-production"
+# traceloop = Traceloop::SDK::Traceloop.new(name: "bedrock-worker")
+
 model = "anthropic.claude-3-sonnet-20240229-v1:0"
 
 traceloop.llm_call(provider="bedrock", model=model) do |tracer|

sample-app/gemini.rb

@@ -9,8 +9,15 @@
   options: { model: 'gemini-pro', server_sent_events: true }
 )
 
+# Example 1: No name parameter (backward compatible)
+# Uses OTEL_SERVICE_NAME as-is, or defaults to "unknown_service:ruby"
 traceloop = Traceloop::SDK::Traceloop.new
 
+# Example 2: With name parameter
+# Creates service name as "#{name}-#{OTEL_ENVIRONMENT}"
+# If OTEL_ENVIRONMENT="production", this creates "gemini-worker-production"
+# traceloop = Traceloop::SDK::Traceloop.new(name: "gemini-worker")
+
 traceloop.llm_call(provider="vertexai", model="gemini-pro") do |tracer|
   tracer.log_prompt(user_prompt="Tell me a joke about OpenTelemetry")
   response = client.generate_content(

sample-app/openai.rb

@@ -7,8 +7,22 @@
 
 client = OpenAI::Client.new
 
+# Example 1: No name parameter (backward compatible)
+# Uses OTEL_SERVICE_NAME as-is, or defaults to "unknown_service:ruby"
 traceloop = Traceloop::SDK::Traceloop.new
 
+# Example 2: With name parameter
+# Creates service name as "#{name}-#{OTEL_ENVIRONMENT}"
+# If OTEL_ENVIRONMENT="production", this creates "worker-production"
+# traceloop_worker = Traceloop::SDK::Traceloop.new(name: "worker")
+
+# Example 3: Multiple instances with different names
+# If OTEL_ENVIRONMENT="production":
+# - traceloop_api: "api-production"
+# - traceloop_background: "background-production"
+# traceloop_api = Traceloop::SDK::Traceloop.new(name: "api")
+# traceloop_background = Traceloop::SDK::Traceloop.new(name: "background")
+
 traceloop.workflow("joke_generator") do
   traceloop.llm_call(provider="openai", model="gpt-3.5-turbo") do |tracer|
     tracer.log_prompt(user_prompt="Tell me a joke about OpenTelemetry")

semantic_conventions_ai/lib/opentelemetry/semantic_conventions.rb

@@ -30,6 +30,18 @@ module SpanAttributes
 
       # Deprecated
       TRACELOOP_CORRELATION_ID = "traceloop.correlation.id"
+
+      # Gen AI
+      GEN_AI_REQUEST_MODEL = "gen_ai.request.model"
+      GEN_AI_RESPONSE_MODEL = "gen_ai.response.model"
+      GEN_AI_USAGE_OUTPUT_TOKENS = "gen_ai.usage.output_tokens"
+      GEN_AI_USAGE_INPUT_TOKENS = "gen_ai.usage.input_tokens"
+      GEN_AI_COMPLETIONS = "gen_ai.completion"
+      GEN_AI_PROMPTS = "gen_ai.prompt"
+      GEN_AI_SYSTEM = "gen_ai.system"
+      GEN_AI_PROVIDER = "gen_ai.provider.name"
+      GEN_AI_CONVERSATION_ID = "gen_ai.conversation.id"
+      GEN_AI_BEDROCK_GUARDRAILS = "gen_ai.bedrock.guardrail"
     end
 
     module LLMRequestTypeValues