logbrew-sdk 0.1.0 → 0.1.2

data/examples/first_useful_telemetry.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "json"
+require "logbrew"
+
+incoming_traceparent = "00-4BF92F3577B34DA6A3CE929D0E0E4736-00F067AA0BA902B7-01"
+trace_context = LogBrew::Traceparent.parse(incoming_traceparent)
+child_span_id = "b7ad6b7169203331"
+outgoing_headers = LogBrew::Traceparent.create_headers(
+  trace_id: trace_context.trace_id,
+  span_id: child_span_id,
+  trace_flags: trace_context.trace_flags
+)
+session_id = "sess_checkout_123"
+route_template = "/checkout/:cart_id"
+
+client = LogBrew::Client.create(
+  api_key: "LOGBREW_API_KEY",
+  sdk_name: "checkout-service",
+  sdk_version: "1.2.3"
+)
+client.release(
+  "evt_release_checkout",
+  "2026-06-02T10:00:00Z",
+  version: "1.2.3",
+  commit: "abc123def456",
+  metadata: { service: "checkout-service" }
+)
+client.environment(
+  "evt_environment_checkout",
+  "2026-06-02T10:00:01Z",
+  name: "production",
+  region: "global",
+  metadata: { service: "checkout-service" }
+)
+client.log(
+  "evt_log_checkout_started",
+  "2026-06-02T10:00:02Z",
+  message: "checkout request started",
+  level: "info",
+  logger: "checkout",
+  metadata: {
+    traceId: trace_context.trace_id,
+    sessionId: session_id,
+    routeTemplate: route_template
+  }
+)
+client.action(
+  "evt_action_checkout_submit",
+  "2026-06-02T10:00:03Z",
+  LogBrew::ProductTimeline.product_action(
+    name: "checkout.submit",
+    route_template: "https://shop.example/checkout/:cart_id?coupon=sample#review",
+    session_id: session_id,
+    trace_id: trace_context.trace_id,
+    screen: "Checkout",
+    funnel: "checkout",
+    step: "submit",
+    metadata: { cartTier: "gold" }
+  )
+)
+client.action(
+  "evt_action_payment_api",
+  "2026-06-02T10:00:04Z",
+  LogBrew::ProductTimeline.network_milestone(
+    route_template: "https://api.example/payments/:payment_id?card=sample",
+    method: "post",
+    status_code: 202,
+    duration_ms: 183.4,
+    session_id: session_id,
+    trace_id: trace_context.trace_id,
+    metadata: { dependency: "payments" }
+  )
+)
+client.metric(
+  "evt_metric_http_server_duration",
+  "2026-06-02T10:00:05Z",
+  name: "http.server.duration",
+  kind: "histogram",
+  value: 183.4,
+  unit: "ms",
+  temporality: "delta",
+  metadata: {
+    method: "POST",
+    routeTemplate: route_template,
+    statusCode: 202,
+    traceId: trace_context.trace_id
+  }
+)
+client.span(
+  "evt_span_checkout_request",
+  "2026-06-02T10:00:06Z",
+  LogBrew::Traceparent.span_attributes_from_traceparent(
+    trace_context,
+    LogBrew::TraceparentSpanInput.new(
+      name: "POST /checkout/:cart_id",
+      span_id: child_span_id,
+      duration_ms: 183.4,
+      metadata: {
+        sampled: trace_context.sampled,
+        routeTemplate: route_template,
+        sessionId: session_id
+      }
+    )
+  )
+)
+
+puts client.preview_json
+
+transport = LogBrew::RecordingTransport.always_accept
+response = client.shutdown(transport)
+warn JSON.generate(
+  ok: true,
+  status: response.status_code,
+  attempts: response.attempts,
+  events: 7,
+  outgoingTraceparent: outgoing_headers.fetch("traceparent")
+)

data/examples/http_trace_correlation.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "json"
+require "logbrew"
+
+incoming_traceparent = "00-4BF92F3577B34DA6A3CE929D0E0E4736-00F067AA0BA902B7-01"
+route_template = "/checkout/:cart_id"
+
+client = LogBrew::Client.create(
+  api_key: "LOGBREW_API_KEY",
+  sdk_name: "checkout-rack-app",
+  sdk_version: "1.2.3"
+)
+client.release(
+  "evt_release_checkout_trace",
+  "2026-06-02T10:00:00Z",
+  version: "1.2.3",
+  commit: "abc123def456",
+  metadata: { service: "checkout" }
+)
+client.environment(
+  "evt_environment_checkout_trace",
+  "2026-06-02T10:00:01Z",
+  name: "production",
+  region: "global",
+  metadata: { service: "checkout" }
+)
+
+logger = LogBrew::Logger.new(
+  client: client,
+  logger_name: "checkout",
+  event_id_prefix: "ruby_http_trace",
+  metadata: { service: "checkout", ignored: [] },
+  timestamp_provider: -> { Time.utc(2026, 6, 2, 10, 0, 2) }
+)
+
+app = lambda do |env|
+  trace = LogBrew::Trace.current
+  raise "missing active trace" unless trace
+
+  logger.warn("checkout request is slow")
+  client.issue(
+    "evt_issue_checkout_trace",
+    "2026-06-02T10:00:03Z",
+    title: "PaymentProviderWarning",
+    level: "warning",
+    message: "payment provider latency crossed threshold",
+    metadata: { routeTemplate: route_template }
+  )
+  client.action(
+    "evt_action_checkout_trace",
+    "2026-06-02T10:00:04Z",
+    LogBrew::ProductTimeline.product_action(
+      name: "checkout.submit",
+      status: "running",
+      route_template: "https://shop.example/checkout/:cart_id?coupon=sample#review",
+      metadata: { cartTier: "gold" }
+    )
+  )
+  client.metric(
+    "evt_metric_checkout_trace",
+    "2026-06-02T10:00:05Z",
+    name: "http.server.duration",
+    kind: "histogram",
+    value: 183.4,
+    unit: "ms",
+    temporality: "delta",
+    metadata: { routeTemplate: route_template, statusCode: 202 }
+  )
+  env["logbrew.outgoing_traceparent"] = LogBrew::Trace.create_headers(trace).fetch("traceparent")
+  [202, { "content-type" => "text/plain" }, ["accepted"]]
+end
+
+rack = LogBrew::RackMiddleware.new(
+  app,
+  client: client,
+  event_id_prefix: "ruby_http_trace",
+  metadata: { service: "checkout", ignored: [] },
+  timestamp_provider: -> { Time.utc(2026, 6, 2, 10, 0, 6) }
+)
+env = {
+  "REQUEST_METHOD" => "POST",
+  "PATH_INFO" => route_template,
+  "QUERY_STRING" => "coupon=sample",
+  "HTTP_TRACEPARENT" => incoming_traceparent
+}
+response = rack.call(env)
+raise "unexpected Rack response" unless response[0] == 202
+
+puts client.preview_json
+transport = LogBrew::RecordingTransport.always_accept
+flush_response = client.shutdown(transport)
+warn JSON.generate(
+  ok: true,
+  status: flush_response.status_code,
+  attempts: flush_response.attempts,
+  events: 7,
+  outgoingTraceparent: env.fetch("logbrew.outgoing_traceparent")
+)

data/examples/persistent_worker_delivery.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "json"
+require "logbrew"
+
+queue_path = ENV.fetch("LOGBREW_PERSISTENT_QUEUE_PATH")
+dropped = 0
+last_drop_reason = nil
+loaded_spec = Gem.loaded_specs["logbrew-sdk"]
+client = LogBrew::Client.create(
+  api_key: "LOGBREW_API_KEY",
+  sdk_name: "logbrew-ruby-persistent-worker",
+  sdk_version: loaded_spec ? loaded_spec.version.to_s : "0.1.0",
+  persistent_queue_path: queue_path,
+  on_event_dropped: lambda do |notice|
+    dropped = notice.dropped_events
+    last_drop_reason = notice.reason
+  end
+)
+
+client.release("evt_worker_release", "2026-07-13T18:00:00Z", version: "2.0.0")
+client.environment("evt_worker_environment", "2026-07-13T18:00:01Z", name: "production")
+client.log("evt_worker_started", "2026-07-13T18:00:02Z", message: "worker started", level: "info")
+
+response = client.shutdown(LogBrew::RecordingTransport.always_accept)
+puts JSON.generate(
+  ok: response.status_code == 202,
+  status: response.status_code,
+  attempts: response.attempts,
+  batches: response.batches,
+  dropped: dropped,
+  lastDropReason: last_drop_reason
+)

data/examples/real_user_smoke.rb

@@ -29,6 +29,19 @@ retry_response = retry_client.flush(
   LogBrew::RecordingTransport.new([LogBrew::TransportError.network("temporary outage"), 202])
 )
 
+support_draft = LogBrew::SupportTicketDraft.create(
+  source: "sdk",
+  category: "ingest_failure",
+  title: "Telemetry flush failed",
+  description: "Flush returned usage_limit_exceeded",
+  trace_id: "4BF92F3577B34DA6A3CE929D0E0E4736",
+  diagnostics: {
+    apiKey: "lbw_ingest_hidden",
+    endpoint: "https://api.example/ingest?debug=true#frag",
+    error: RuntimeError.new("contains hidden token")
+  }
+)
+
 rejected_after_shutdown = false
 begin
   client.action("evt_action_002", "2026-06-02T10:00:06Z", name: "deploy", status: "success")
@@ -41,5 +54,7 @@ $stderr.puts JSON.generate(
   status: response.status_code,
   attempts: response.attempts,
   retryAttempts: retry_response.attempts,
+  supportDraftRedacted: support_draft.dig("diagnostics", "apiKey") == "[redacted]",
+  supportDraftTrace: support_draft.fetch("trace_id"),
   events: 6
 )

data/examples/sidekiq_tracing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "logbrew"
+require "logbrew/sidekiq"
+require "sidekiq"
+
+transport = LogBrew::HttpTransport.new(timeout: 10)
+client = LogBrew::Client.create_automatic(
+  api_key: ENV.fetch("LOGBREW_API_KEY"),
+  sdk_name: "checkout-worker",
+  sdk_version: "1.0.0",
+  transport: transport
+)
+instrumentation = LogBrew::Sidekiq::Instrumentation.create(client: client, max_retries: 25)
+
+Sidekiq.configure_client { |config| instrumentation.register_client(config) }
+Sidekiq.configure_server do |config|
+  instrumentation.register_client(config)
+  instrumentation.register_server(config)
+  config.on(:quiet) { instrumentation.quiet }
+  config.on(:shutdown) { instrumentation.shutdown }
+end