uptrace 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971f276de0abbfd5a5b4e505927b12a92f206a47f857c7d2a1f55106e1739dde
-  data.tar.gz: ed4e4cb6f17964dc4819dca13b998a69fba3ac20ccea4ba54b14701d069d584e
+  metadata.gz: 136e2ee49600cd4a46886e29ff523d8ae51ab6e13a821613e6e2b49fa6d2aad1
+  data.tar.gz: 5460a5c99eeea8be633e763ec6a842e7b9f7806c279b9aff2e68bce5ad5308a8
 SHA512:
-  metadata.gz: a4c60178f506bb083dc4fe13fedfac8f440feebac8a23c6dfd4040388448c2c20dee1977cdd65df69237dfd6626ed2604877fd418a699a4de58d91ffa844864b
-  data.tar.gz: edb380d1fabc98cfd62b667dc3cdb8b343398a97e6ef89a1769057d6c6e6f91548ba1e37b65af7e475d31ee66c12c9ae52947c77437c1de5eafe28191b797fed
+  metadata.gz: a07eb5fb3e35f581672d5ea10a5b1d79c24cd731e17bceed2a22959a1efdc033be4543c005dea8c3de682e5724b2db685e0bff088ddb5f3ee74b554f5c800148
+  data.tar.gz: 9203d15f70e209accc41845d2e16462bc248d5a7d736f7e0cbe2f3b91f682f33e89ff03cc32dc71b264d3aeff43e095902e74966be2c7f3790fdefe0a021453b

data/README.md

@@ -1,4 +1,4 @@
-# Uptrace Ruby exporter for OpenTelemetry
+# OpenTelemetry Ruby distro for Uptrace
 
 ![build workflow](https://github.com/uptrace/uptrace-ruby/actions/workflows/build.yml/badge.svg)
 [![Documentation](https://img.shields.io/badge/uptrace-documentation-informational)](https://uptrace.dev/get/opentelemetry-ruby)
@@ -10,8 +10,11 @@
 
 ## Introduction
 
-uptrace-ruby is an OpenTelemery distribution configured to export
-[traces](https://uptrace.dev/opentelemetry/distributed-tracing) to Uptrace.
+`uptrace-ruby` is a preconfigured [OpenTelemetry](https://opentelemetry.io)
+distribution for Ruby that exports **traces, logs, and metrics** to
+[Uptrace](https://uptrace.dev). It builds on top of
+[opentelemetry-ruby](https://github.com/open-telemetry/opentelemetry-ruby) and
+makes connecting your application to Uptrace fast and easy.
 
 ## Quickstart
 
@@ -21,7 +24,8 @@ Install uptrace-ruby:
 gem install uptrace
 ```
 
-Run the [basic example](example/basic) below using the DSN from the Uptrace project settings page.
+Run the [traces example](example/traces) below using the DSN from the Uptrace
+project settings page.
 
 ```ruby
 #!/usr/bin/env ruby
@@ -32,42 +36,52 @@ require 'bundler/setup'
 require 'uptrace'
 
 # Configure OpenTelemetry with sensible defaults.
-# Copy your project DSN here or use UPTRACE_DSN env var.
+# DSN can be set via UPTRACE_DSN environment variable.
+# Example: export UPTRACE_DSN="https://<project_secret>@uptrace.dev?grpc=4317"
 Uptrace.configure_opentelemetry(dsn: '') do |c|
-  # c is OpenTelemetry::SDK::Configurator
+  # c is an instance of OpenTelemetry::SDK::Configurator
+
+  # Configure service metadata (helps identify this service in Uptrace).
   c.service_name = 'myservice'
   c.service_version = '1.0.0'
 
+  # Add environment information
   c.resource = OpenTelemetry::SDK::Resources::Resource.create(
-    'deployment.environment' => 'production'
+    'deployment.environment.name' => ENV.fetch('RACK_ENV', 'development')
   )
 end
 
-# Create a tracer. Usually, tracer is a global variable.
-tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0')
-
-# Create a root span (a trace) to measure some operation.
-tracer.in_span('main-operation', kind: :client) do |main|
-  tracer.in_span('GET /posts/:id') do |child1|
-    child1.set_attribute('http.method', 'GET')
-    child1.set_attribute('http.route', '/posts/:id')
-    child1.set_attribute('http.url', 'http://localhost:8080/posts/123')
-    child1.set_attribute('http.status_code', 200)
-    child1.record_exception(ArgumentError.new('error1'))
+# Ensure spans are flushed even if the program exits unexpectedly.
+at_exit { OpenTelemetry.tracer_provider.shutdown }
+
+# Register a tracer (usually stored globally).
+TRACER = OpenTelemetry.tracer_provider.tracer('my_app', '0.1.0')
+
+# Example trace with nested spans.
+TRACER.in_span('main-operation', kind: :server) do |main_span|
+  # Simulate an HTTP request span.
+  TRACER.in_span('GET /posts/:id', kind: :client) do |http_span|
+    http_span.set_attribute('http.method', 'GET')
+    http_span.set_attribute('http.route', '/posts/:id')
+    http_span.set_attribute('http.url', 'http://localhost:8080/posts/123')
+    http_span.set_attribute('http.status_code', 200)
+    http_span.record_exception(ArgumentError.new('Invalid parameter'))
   end
 
-  tracer.in_span('SELECT') do |child2|
-    child2.set_attribute('db.system', 'mysql')
-    child2.set_attribute('db.statement', 'SELECT * FROM posts LIMIT 100')
+  # Simulate a database query span.
+  TRACER.in_span('SELECT posts', kind: :client) do |db_span|
+    db_span.set_attribute('db.system', 'mysql')
+    db_span.set_attribute('db.statement', 'SELECT * FROM posts LIMIT 100')
   end
 
-  puts("trace URL: #{Uptrace.trace_url(main)}")
+  # Print the trace URL (clickable in console).
+  puts "Trace URL: #{Uptrace.trace_url(main_span)}"
 end
-
-# Send buffered spans and free resources.
-OpenTelemetry.tracer_provider.shutdown
 ```
 
+Additional examples are available for [logs](example/logs) and
+[metrics](example/metrics).
+
 ## Links
 
 - [Examples](example)

data/RELEASING.md

@@ -0,0 +1,70 @@
+# Releasing
+
+This guide explains how to release a new version of the uptrace-ruby gem to
+RubyGems.
+
+## Managing Dependencies
+
+### Checking for outdated dependencies
+
+To view outdated dependencies:
+
+```shell
+bundle outdated
+```
+
+### Updating dependencies
+
+Edit the `Gemfile` to update dependency versions, then update the
+`Gemfile.lock`:
+
+```shell
+bundle update
+```
+
+### Installing dependencies
+
+To install all dependencies:
+
+```shell
+bundle install
+```
+
+## Running Tests
+
+Before releasing, ensure all tests pass:
+
+```shell
+rake test
+```
+
+## Running linter
+
+To run linter:
+
+```shell
+bundle exec rake
+```
+
+To auto-correct issues:
+
+```shell
+bundle exec rubocop -A
+```
+
+## Publishing a Release
+
+1. **Update the version**: Bump the version number in `lib/uptrace/version.rb`
+
+2. **Build and publish the gem**:
+
+   ```shell
+   gem build uptrace.gemspec
+   bundle install
+   gem push uptrace-X.Y.Z.gem
+   ```
+
+   Replace `X.Y.Z` with the actual version number you specified in step 1.
+
+**Note**: Make sure you have the necessary permissions to push to the uptrace
+gem on RubyGems before attempting to publish.

data/lib/uptrace/client.rb

@@ -9,7 +9,7 @@ module Uptrace
 
     # @param [string] dsn
     def initialize(dsn: '')
-      dsn = ENV.fetch('UPTRACE_DSN', '') if dsn.empty?
+      dsn = ENV.fetch('UPTRACE_DSN', '') if dsn.empty? || dsn == '<FIXME>'
 
       begin
         @dsn = DSN.new(dsn)
@@ -17,7 +17,7 @@ module Uptrace
         Uptrace.logger.error("Uptrace is disabled: #{e.message}")
         @disabled = true
 
-        @dsn = DSN.new('https://TOKEN@uptrace.dev')
+        @dsn = DSN.new('https://project_secret@api.uptrace.dev?grpc=4317')
       end
     end
 

data/lib/uptrace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uptrace
-  VERSION = '1.8.0'
+  VERSION = '1.8.1'
 end

data/lib/uptrace.rb

@@ -2,24 +2,23 @@
 
 require 'logger'
 
+require 'opentelemetry/sdk'
 require 'opentelemetry/exporter/otlp'
+
 require 'opentelemetry-metrics-sdk'
 require 'opentelemetry-exporter-otlp-metrics'
 
+require 'opentelemetry-logs-sdk'
+require 'opentelemetry/exporter/otlp_logs'
+
 # Uptrace provides Uptrace exporters for OpenTelemetry.
 module Uptrace
   extend self
 
   attr_accessor :logger
-  attr_writer :client
 
   self.logger = Logger.new($stdout)
 
-  # @return [Object, Client] registered client or a default no-op implementation of the client.
-  def client
-    @client ||= Client.new
-  end
-
   # @param [optional OpenTelemetry::Trace::Span] span
   # @return [String]
   def trace_url(span = nil)
@@ -33,15 +32,32 @@ module Uptrace
   # @yieldparam [OpenTelemetry::SDK::Configurator] c Yields a configurator to the
   #   provided block
   def configure_opentelemetry(dsn: '')
+    @client = Client.new(dsn: dsn)
+    return if @client.disabled?
+
     OpenTelemetry::SDK.configure do |c|
-      @client = Client.new(dsn: dsn) unless dsn.empty?
-      c.add_span_processor(span_processor(@client.dsn)) unless client.disabled?
+      # Set default IdGenerator and let users override
       c.id_generator = Uptrace::IdGenerator
+      c.add_span_processor(span_processor(@client.dsn))
 
       yield c if block_given?
+
+      # Merge resource
+      current_resource = c.instance_variable_get(:@resource)
+      current_resource ||= OpenTelemetry::SDK::Resources::Resource.create
+
+      host_resource = OpenTelemetry::SDK::Resources::Resource.create(
+        'host.name' => Socket.gethostname
+      )
+      c.resource = current_resource.merge(host_resource)
     end
 
-    OpenTelemetry.meter_provider.add_metric_reader(metric_exporter(@client.dsn))
+    me = metric_exporter(@client.dsn)
+    OpenTelemetry.meter_provider.add_metric_reader(me)
+
+    le = log_exporter(@client.dsn)
+    processor = OpenTelemetry::SDK::Logs::Export::BatchLogRecordProcessor.new(le)
+    OpenTelemetry.logger_provider.add_log_record_processor(processor)
   end
 
   private
@@ -67,6 +83,14 @@ module Uptrace
       compression: 'gzip'
     )
   end
+
+  def log_exporter(dsn)
+    OpenTelemetry::Exporter::OTLP::Logs::LogsExporter.new(
+      endpoint: "#{dsn.otlp_http_endpoint}/v1/logs",
+      headers: { 'uptrace-dsn': dsn.to_s },
+      compression: 'gzip'
+    )
+  end
 end
 
 require 'uptrace/version'

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: uptrace
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Uptrace Authors
 bindir: bin
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
@@ -43,28 +57,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-metrics-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp-logs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-logs-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +219,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.6
-description: Uptrace Ruby exporter for OpenTelemetry
+description: Configures OpenTelemetry Ruby to export data to Uptrace
 email:
 - support@uptrace.dev
 executables: []
@@ -187,7 +229,7 @@ files:
 - ".yardopts"
 - LICENSE
 - README.md
-- RELEASE.md
+- RELEASING.md
 - TODO.md
 - lib/uptrace.rb
 - lib/uptrace/client.rb
@@ -215,5 +257,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Uptrace Ruby exporter for OpenTelemetry
+summary: Uptrace wrapper for OpenTelemetry Ruby
 test_files: []

data/RELEASE.md

@@ -1,13 +0,0 @@
-Update dependencies:
-
-```
-bundle update
-```
-
-Bump version in `lib/uptrace/version.rb` and then run:
-
-```shell
-gem build uptrace.gemspec
-bundle install
-gem push uptrace-0.2.0.gem
-```