Official Ruby SDK for Doow usage telemetry and management.
| Feature | Description |
|---|---|
| Ruby 3.0+ | Modern Ruby with pattern matching and endless methods |
| Batching | Events queued and sent in configurable batches |
| Compression | Automatic gzip for payloads >1KB |
| Retries | Exponential backoff with configurable retry count |
| Type Safety | Struct-based models |
| Sidecar | Executable for stdin/file/tcp input modes |
gem 'doow_track'Or install directly:
gem install doow_trackrequire 'doow_track'
tracker = DoowTrack::Tracker.new('dk_your_api_key')
# Simple event
tracker.track(DoowTrack::TrackEvent.new(
metric: 'api_calls',
quantity: 1,
license_id: 'lic_abc123'
))
# Rich event with metadata
tracker.track(DoowTrack::TrackEvent.new(
metric: 'tokens_generated',
quantity: 1500,
license_id: 'lic_abc123',
unit: 'tokens',
attribution: { model: 'gpt-4', region: 'us-east-1' },
metadata: { request_id: 'req_xyz' }
))
tracker.shutdownrequire 'doow_track'
mgmt = DoowTrack::Management.new('dk_your_api_key')
# Create an app
app = mgmt.apps.create(
name: 'My SaaS Platform',
description: 'Usage-based billing'
)
puts "Created app: #{app.id}"
# Create a contract with license
contract = mgmt.contracts.create(app.id,
title: 'Enterprise Plan',
contract_type: DoowTrack::ContractType::PAY_AS_YOU_GO,
licenses: [
{ name: 'API Usage', license_type: DoowTrack::LicenseType::USAGE_BASED }
]
)
license_id = contract.licenses.first.id
# Create a metric
metric = mgmt.metrics.create(license_id, metric_type: 'api_calls')
puts "Created metric: #{metric.id}"tracker = DoowTrack::Tracker.new('dk_your_api_key',
endpoint: 'https://api.doow.co',
enabled: true,
debug: true,
flush_at: 20,
flush_interval: 10,
max_queue_size: 10_000,
timeout: 10,
retry_count: 3,
disable_compression: false,
attribution: { service: 'api-gateway' },
on_error: ->(e) { Rails.logger.error("Tracker error: #{e.message}") }
)| Variable | Description | Default |
|---|---|---|
DOOW_TRACK_API_KEY |
API key (overrides constructor) | — |
DOOW_TRACK_ENDPOINT |
Custom API endpoint | https://api.doow.co |
DOOW_TRACK_DISABLED |
Set true to disable tracking |
false |
DOOW_TRACK_DEBUG |
Set true for debug logs |
false |
begin
app = mgmt.apps.get('invalid_id')
rescue DoowTrack::Error => e
if e.not_found?
puts "App not found"
elsif e.unauthorized?
puts "Invalid API key"
elsif e.rate_limited?
puts "Rate limited"
else
puts "Error: #{e.message}"
end
endRun the SDK as a standalone sidecar that reads JSON events from stdin/file/tcp.
# Stdin mode
export DOOW_TRACK_API_KEY=dk_your_api_key
echo '{"metric":"api_calls","quantity":1,"license_id":"lic_123"}' | doow-sidecar
# File mode
DOOW_TRACK_INPUT=file:/var/log/events.jsonl doow-sidecar
# TCP mode
DOOW_TRACK_INPUT=tcp:9000 doow-sidecar| Variable | Description | Default |
|---|---|---|
DOOW_TRACK_API_KEY |
SDK API key (required) | — |
DOOW_TRACK_INPUT |
stdin, file:<path>, tcp:<port> |
stdin |
DOOW_TRACK_HEALTH_PORT |
Health check port | 9090 |
# config/initializers/doow.rb
DoowTrack.configure do |config|
config.api_key = Rails.application.credentials.doow_api_key
config.debug = Rails.env.development?
end
DOOW_TRACKER = DoowTrack::Tracker.new(DoowTrack.api_key)
at_exit { DOOW_TRACKER.shutdown }class ApiController < ApplicationController
def generate
DOOW_TRACKER.track(DoowTrack::TrackEvent.new(
metric: 'api_calls',
quantity: 1,
license_id: current_user.license_id
))
render json: { result: 'ok' }
end
endMIT