vitalrix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93255b47a14ac846e6b1c893f1efa58ff45c77ece320b05fb60d2a7cfec60f25
+  data.tar.gz: 3fa5684934d90c7928411dfb40c5154df36b6728dc1cdd3de973f335761fbf9d
+SHA512:
+  metadata.gz: 602fa953ff5b9896d1d4dc79e1d3fad3e610a1afd7707453a1825c33a2e073c0efb0a6fd59ed937547e9062944969840f4fc17ff17301cd4aa7eda74302e871b
+  data.tar.gz: 0b6f97518b156d6d1d7479f42cc5f207a7a1157b439ce2b08669e306c88eb551085b6430d0736cd1ea5029ba23910d358b2082bf18fd230631d6dc8f45601925

data/README.md

@@ -0,0 +1,26 @@
+# vitalrix (Ruby)
+
+Send traces, metrics and logs from Ruby to [VitalRix](https://vitalrix.com) with the official OpenTelemetry SDK (OTLP/HTTP).
+
+```ruby
+# Gemfile
+gem "vitalrix"
+gem "opentelemetry-instrumentation-all"   # optional: Rails, Rack, Sinatra, Net::HTTP, pg, Redis, Sidekiq, Logger, ...
+```
+
+```bash
+VITALRIX_URL=https://api.vitalrix.com
+VITALRIX_API_KEY=pk_...              # log.write, metric.write, trace.write (the Connect tab in VitalRix creates it)
+OTEL_SERVICE_NAME=shop-api           # the application's name in VitalRix
+DEPLOYMENT_ENVIRONMENT=production
+SERVICE_VERSION=1.4.2                # optional: marks deployments
+```
+
+```ruby
+require "vitalrix"
+Vitalrix.init                              # Rails: in config/initializers/vitalrix.rb
+Vitalrix.log(:info, "order placed", order_id: id)
+```
+
+`init` sets the standard OpenTelemetry variables (values you set yourself win) and turns on every installed
+instrumentation. Check the key: `bundle exec vitalrix check`. Ruby 3.1+.

data/exe/vitalrix

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# `vitalrix check`: sends one test log so you know the key and URL work.
+require "vitalrix"
+
+unless ARGV.first == "check"
+  warn "usage: vitalrix check"
+  exit 2
+end
+begin
+  puts Vitalrix.check
+rescue StandardError => e
+  warn "vitalrix: #{e.message}"
+  exit 1
+end

data/lib/vitalrix/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vitalrix
+  VERSION = "0.1.0"
+end

data/lib/vitalrix.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "json"
+require "socket"
+require "net/http"
+require "uri"
+require_relative "vitalrix/version"
+
+# VitalRix for Ruby: the official OpenTelemetry SDK wired to VitalRix (traces, metrics and logs over OTLP/HTTP).
+#
+#   require "vitalrix"
+#   Vitalrix.init          # reads VITALRIX_URL, VITALRIX_API_KEY, OTEL_SERVICE_NAME, ...
+module Vitalrix
+  Config = Struct.new(:url, :api_key, :service, :environment, :version, :sample_rate) do
+    def endpoint(path) = "#{url}/api/v1/#{path}"
+  end
+
+  # Settings from VITALRIX_URL, VITALRIX_API_KEY, OTEL_SERVICE_NAME, DEPLOYMENT_ENVIRONMENT, SERVICE_VERSION, TRACE_SAMPLE_RATE.
+  def self.config(env = ENV)
+    pick = ->(k, d) { (v = env[k]).nil? || v.empty? ? d : v }
+    rate = Float(pick.("TRACE_SAMPLE_RATE", "1"), exception: false) || 1.0
+    Config.new(pick.("VITALRIX_URL", "https://api.vitalrix.com").sub(%r{/+\z}, ""), pick.("VITALRIX_API_KEY", ""),
+               pick.("OTEL_SERVICE_NAME", "unknown"), pick.("DEPLOYMENT_ENVIRONMENT", "production"),
+               pick.("SERVICE_VERSION", "0.0.0"), rate.clamp(0.0, 1.0))
+  end
+
+  # The standard OpenTelemetry variables that point the SDK at VitalRix. Values the application already set win.
+  def self.otel_environment(c = config)
+    {
+      "OTEL_SERVICE_NAME" => c.service,
+      # host.name: VitalRix counts APM hosts by it, the same way for every SDK.
+      "OTEL_RESOURCE_ATTRIBUTES" => "deployment.environment.name=#{c.environment},service.version=#{c.version},host.name=#{Socket.gethostname}",
+      "OTEL_EXPORTER_OTLP_PROTOCOL" => "http/protobuf",
+      "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT" => c.endpoint("traces/otlp/v1/traces"),
+      "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT" => c.endpoint("metrics/otlp/v1/metrics"),
+      "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT" => c.endpoint("logs/otlp/v1/logs"),
+      "OTEL_EXPORTER_OTLP_HEADERS" => "x-api-key=#{c.api_key}",
+      "OTEL_TRACES_EXPORTER" => "otlp",
+      "OTEL_METRICS_EXPORTER" => "otlp",
+      "OTEL_LOGS_EXPORTER" => "otlp",
+      # Parent-based: a request arriving with a sampled traceparent (browser, another service) stays sampled.
+      "OTEL_TRACES_SAMPLER" => "parentbased_traceidratio",
+      "OTEL_TRACES_SAMPLER_ARG" => c.sample_rate.to_s,
+    }
+  end
+
+  # Starts sending. Returns false (and sends nothing) without VITALRIX_API_KEY. Turns on every installed
+  # opentelemetry-instrumentation-* gem (Rails, Rack, Sinatra, Net::HTTP, pg, Redis, Sidekiq, Logger, ...).
+  def self.init(instrument: true)
+    return true if @started
+    c = config
+    if c.api_key.empty?
+      warn "[vitalrix] VITALRIX_API_KEY is not set: nothing is sent"
+      return false
+    end
+    otel_environment(c).each { |k, v| ENV[k] = v if ENV[k].nil? || ENV[k].empty? }
+    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"
+    OpenTelemetry::SDK.configure { |cfg| cfg.use_all if instrument }
+    @started = true
+    at_exit { shutdown }
+    true
+  end
+
+  # A log line with the current trace id. No-op before init.
+  def self.log(severity, message, attributes = {})
+    return unless @started
+    logger = OpenTelemetry.logger_provider.logger(name: "vitalrix", version: VERSION)
+    logger.on_emit(severity_text: severity.to_s.upcase, severity_number: SEVERITY.fetch(severity.to_sym, 9), body: message.to_s,
+                   attributes: attributes.transform_keys(&:to_s), context: OpenTelemetry::Context.current)
+  end
+  SEVERITY = { debug: 5, info: 9, warn: 13, error: 17, fatal: 21 }.freeze
+
+  # Flushes and stops (also runs at exit).
+  def self.shutdown
+    return unless @started
+    OpenTelemetry.tracer_provider.shutdown if OpenTelemetry.tracer_provider.respond_to?(:shutdown)
+    OpenTelemetry.meter_provider.shutdown if OpenTelemetry.meter_provider.respond_to?(:shutdown)
+    OpenTelemetry.logger_provider.shutdown if OpenTelemetry.logger_provider.respond_to?(:shutdown)
+    @started = false
+  end
+
+  # Sends one test log line; raises with the server's answer when the key or URL does not work.
+  def self.check(c = config)
+    raise "VITALRIX_API_KEY is not set" if c.api_key.empty?
+    uri = URI(c.endpoint("logs"))
+    body = { logs: [{ level: "info", message: "vitalrix check: connection works", service: c.service, environment: c.environment }] }.to_json
+    res = Net::HTTP.post(uri, body, "content-type" => "application/json", "x-api-key" => c.api_key)
+    raise "#{res.code} #{res.body}" unless res.is_a?(Net::HTTPSuccess)
+    %(ok: a test log from "#{c.service}" (#{c.environment}) reached #{c.url})
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: vitalrix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- VitalRix
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-logs-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp-logs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-metrics-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-exporter-otlp-metrics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Configures the official OpenTelemetry Ruby SDK to export traces, metrics
+  and logs to VitalRix over OTLP/HTTP, turns on installed instrumentations, and adds
+  a `vitalrix check` command.
+executables:
+- vitalrix
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/vitalrix
+- lib/vitalrix.rb
+- lib/vitalrix/version.rb
+homepage: https://vitalrix.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/avinashManiTripathi/vitalrix-sdks
+  documentation_uri: https://docs.vitalrix.com/apm/setup
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.23
+specification_version: 4
+summary: Send traces, metrics and logs from Ruby to VitalRix in one call (OpenTelemetry
+  under the hood).
+test_files: []