logbrew-sdk 0.1.2 → 0.1.4

data/examples/first_useful_telemetry.rb

@@ -13,97 +13,115 @@ outgoing_headers = LogBrew::Traceparent.create_headers(
 )
 session_id = "sess_checkout_123"
 route_template = "/checkout/:cart_id"
+service_resource = LogBrew::TelemetryResource.create
+  .with_service(name: "checkout-service", version: "1.2.3")
+  .with_deployment(environment: "production", release: "checkout@1.2.3")
+  .with_framework(name: "rack")
+  .build
+service_context = LogBrew::TelemetryContext.create
+  .with_resource(service_resource)
+  .with_tag("region", "global")
+  .build
+request_context = LogBrew::TelemetryContext.create
+  .with_session(id: session_id)
+  .with_subject(id: "subject_checkout_123", kind: "user")
+  .with_tags("journey" => "checkout", "surface" => "payment")
+  .build
+active_trace = LogBrew::Trace.create(
+  trace_id: trace_context.trace_id,
+  span_id: child_span_id,
+  parent_span_id: trace_context.parent_span_id,
+  trace_flags: trace_context.trace_flags
+)
 
 client = LogBrew::Client.create(
   api_key: "LOGBREW_API_KEY",
   sdk_name: "checkout-service",
-  sdk_version: "1.2.3"
+  sdk_version: "1.2.3",
+  context: service_context
 )
 client.release(
   "evt_release_checkout",
   "2026-06-02T10:00:00Z",
   version: "1.2.3",
-  commit: "abc123def456",
-  metadata: { service: "checkout-service" }
+  commit: "abc123def456"
 )
 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" }
-  )
+  region: "global"
 )
-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,
+LogBrew::Telemetry.with_context(request_context) do
+  LogBrew::Trace.with_context(active_trace) do
+    client.log(
+      "evt_log_checkout_started",
+      "2026-06-02T10:00:02Z",
+      message: "checkout request started",
+      level: "info",
+      logger: "checkout",
+      metadata: { 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",
+      description: "Duration of one completed server request.",
+      kind: "histogram",
+      value: 183.4,
+      unit: "ms",
+      temporality: "delta",
       metadata: {
-        sampled: trace_context.sampled,
+        method: "POST",
         routeTemplate: route_template,
-        sessionId: session_id
+        statusCode: 202
       }
     )
-  )
-)
+    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
+          }
+        )
+      )
+    )
+  end
+end
 
 puts client.preview_json
 

data/examples/http_trace_correlation.rb

@@ -61,6 +61,7 @@ app = lambda do |env|
     "evt_metric_checkout_trace",
     "2026-06-02T10:00:05Z",
     name: "http.server.duration",
+    description: "Duration of one completed server request.",
     kind: "histogram",
     value: 183.4,
     unit: "ms",

data/examples/issue_diagnostics.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "json"
+require "logbrew"
+
+module CheckoutFailureFixture
+  def self.fail_checkout
+    raise RuntimeError, "sensitive provider response fixture"
+  end
+end
+
+client = LogBrew::Client.create(
+  api_key: "LOGBREW_API_KEY",
+  sdk_name: "checkout-ruby-service",
+  sdk_version: "1.4.2"
+)
+breadcrumbs = [
+  LogBrew::IssueDiagnostics.breadcrumb(
+    timestamp: "2026-08-02T10:14:58.125+00:00",
+    category: "checkout.navigation",
+    type: "navigation",
+    level: "info",
+    message: "User reached payment review",
+    data: { step: "payment" }
+  ),
+  LogBrew::IssueDiagnostics.breadcrumb(
+    timestamp: "2026-08-02T10:14:59Z",
+    category: "checkout.request",
+    type: "http",
+    level: "warn",
+    data: { method: "POST", statusCode: 503 }
+  )
+]
+
+begin
+  CheckoutFailureFixture.fail_checkout
+rescue RuntimeError => error
+  client.issue(
+    "evt_issue_checkout_failure",
+    "2026-08-02T10:15:00Z",
+    LogBrew::IssueDiagnostics.from_exception(
+      error,
+      message: "Checkout could not be completed.",
+      mechanism_type: "ruby.exception",
+      handled: true,
+      metadata: { routeTemplate: "/checkout/:cart_id" },
+      breadcrumbs: breadcrumbs
+    )
+  )
+end
+
+puts client.preview_json
+
+response = client.shutdown(LogBrew::RecordingTransport.always_accept)
+warn JSON.generate(ok: true, status: response.status_code, events: 1)

data/examples/readme_example.rb

@@ -55,7 +55,8 @@ if __FILE__ == $PROGRAM_NAME
   client = LogBrew::Client.create(
     api_key: "LOGBREW_API_KEY",
     sdk_name: "logbrew-ruby",
-    sdk_version: "0.1.0"
+    sdk_version: "0.1.0",
+    capture_runtime_context: false
   )
   enqueue_all(client)
 

data/examples/real_user_smoke.rb

@@ -12,7 +12,8 @@ require_relative "readme_example"
 client = LogBrew::Client.create(
   api_key: "LOGBREW_API_KEY",
   sdk_name: "logbrew-ruby",
-  sdk_version: "0.1.0"
+  sdk_version: "0.1.0",
+  capture_runtime_context: false
 )
 enqueue_all(client)
 
@@ -22,7 +23,8 @@ response = client.shutdown(LogBrew::RecordingTransport.always_accept)
 retry_client = LogBrew::Client.create(
   api_key: "LOGBREW_API_KEY",
   sdk_name: "logbrew-ruby",
-  sdk_version: "0.1.0"
+  sdk_version: "0.1.0",
+  capture_runtime_context: false
 )
 enqueue_all(retry_client)
 retry_response = retry_client.flush(

data/examples/sidekiq_tracing.rb

@@ -6,7 +6,7 @@ require "sidekiq"
 
 transport = LogBrew::HttpTransport.new(timeout: 10)
 client = LogBrew::Client.create_automatic(
-  api_key: ENV.fetch("LOGBREW_API_KEY"),
+  api_key: ENV.fetch("LOGBREW_SERVER_API_KEY"),
   sdk_name: "checkout-worker",
   sdk_version: "1.0.0",
   transport: transport