foam-otel 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b07d2871b1487fa11be678a0179ce2f6ba1b32b0679bfad73b0b19a33e06cc14
-  data.tar.gz: a9d5c842c339f817fede0f0296003c2d4549c08ecadc831f721c6c5f39f180f9
+  metadata.gz: 55498709d9b6b79c84356755456455766ce4cc3293174efce14e21e4666a19d2
+  data.tar.gz: f7e5a00c801883644e33995415c538ae0410cd52926515be110c35803dfe7222
 SHA512:
-  metadata.gz: 7b19e7be4ae42b34e09497350412c1fb2fcdd51ebdfdeed4478abe78a502b342dfaa931c581e2d69fec0ee97482a38ca98385730b5c2fa90f059b91b118ab349
-  data.tar.gz: a4b4d88120536447457adf6de03fc9692a9a0b1d129ceb3b79b7ec94f37bac9b2b359757cb0233a3bd4323842f5bc6c22edbc4ba78dfea6bfcdae453e0fc4aeb
+  metadata.gz: fbc098c14d51948a8849f4f1fd8522876fcde089a1e065bded46547d4298148c8465c4d630803ace66aa7d38612f4a07f20ad1c921eea8dfeeb24ea99bb76a69
+  data.tar.gz: 3d19f5acc8ab0acd77d3ce0f0f851cd84edcb24afa84335d283ace4680e648a50b4720d3117c93bdd5a9c2edce6755a5c3a0ff6d13e0b904cfb30f3e2cd14930

data/README.md

@@ -48,7 +48,7 @@ Foam::Otel.init(
   name: "checkout-api",                       # → service.name
   environment: ENV.fetch("APP_ENV", "development"),  # → deployment.environment.name (verbatim)
   enabled: !%w[test ci].include?(ENV["APP_ENV"]),    # silence tests/CI; export everywhere else
-  token: ENV.fetch("FOAM_TOKEN"),             # required WHEN enabled — wire it explicitly
+  token: ENV.fetch("FOAM_OTEL_TOKEN"),             # required WHEN enabled — wire it explicitly
   version: ENV["GIT_SHA"]                      # → service.version (recommended; optional)
 )
 ```
@@ -68,7 +68,7 @@ now flows to foam, with the redaction floor applied on the wire.
 | `name:` | String | yes | — | `service.name`. Blank → raises at boot. |
 | `environment:` | String | yes | — | `deployment.environment.name`, exported verbatim. A value outside `{production, staging, development, test}` warns but is never rewritten. Blank → raises. |
 | `enabled:` | Boolean | yes | — | The config switch. `false` = fully inert (no SDK, no providers, no network, helpers no-op). `true` = export, in EVERY environment. No default — you write the logic. |
-| `token:` | String | when enabled | — | `Authorization: Bearer` for export. Required (and validated) only when `enabled: true`; wired explicitly from your secret source — never an env fallback. Blank while enabled → raises at boot. |
+| `token:` | String | when enabled | — | `Authorization: Bearer` for export. Required (and validated) only when `enabled: true`; wired explicitly from your secret source — never an env fallback read by the gem. **Fleet convention: read it from the `FOAM_OTEL_TOKEN` env var.** Blank while enabled → raises at boot. |
 | `version:` | String | no | nil | `service.version`, verbatim (git SHA recommended). Missing → warns and continues. Never detected at runtime. |
 | `redact_keys:` | Array<String> | no | `[]` | Extra field names treated as SECRETS (tail-masked). EXTENDS the always-on floor. |
 | `redact_pii_keys:` | Array<String> | no | `[]` | Field names treated as PII (full `[REDACTED]`, no tail). Foam ships no PII preset — this is your enumeration. |
@@ -165,7 +165,7 @@ Disjoint pipelines: foam runs its own beside the agent, touching nothing. Add th
 agent's intake host so foam's outbound instrumentation doesn't shadow its egress.
 
 ```ruby
-Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_TOKEN,
+Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_OTEL_TOKEN,
                 ignored_outbound_hosts: ["trace.agent.datadoghq.com"])
 ```
 
@@ -175,7 +175,7 @@ Attach the tenant's processor via the seam, and add its exporter host to the
 ignore list (its exports would otherwise be shadow-spanned into a loop).
 
 ```ruby
-Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_TOKEN,
+Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_OTEL_TOKEN,
                 additional_span_processors: [EvalTool::SpanProcessor.new(project: "prod")],
                 ignored_outbound_hosts: ["ingest.eval-tool.example"])
 ```
@@ -198,7 +198,7 @@ Signals are independent. A foreign SDK owning only traces still gets foam for
 metrics and logs on the full contract:
 
 ```ruby
-Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_TOKEN)
+Foam::Otel.init(name: "checkout-api", environment: env, enabled: true, token: FOAM_OTEL_TOKEN)
 # → warns: traces foreign-owned (foam dark for traces); metrics + logs → foam, full contract.
 ```
 
@@ -211,7 +211,7 @@ Foam::Otel.init(name: "checkout-api", environment: "test", enabled: false)
 ### Scenario 7 — serverless / short-lived (flush at the end)
 
 ```ruby
-Foam::Otel.init(name: "orders-fn", environment: "production", enabled: true, token: FOAM_TOKEN)
+Foam::Otel.init(name: "orders-fn", environment: "production", enabled: true, token: FOAM_OTEL_TOKEN)
 
 def handler(event:, context:)
   run(event)
@@ -229,7 +229,7 @@ worker gets its own pipeline and a unique `service.instance.id`:
 ```ruby
 # config/puma.rb
 on_worker_boot do
-  Foam::Otel.init(name: "checkout-api", environment: ENV["APP_ENV"], enabled: true, token: ENV["FOAM_TOKEN"])
+  Foam::Otel.init(name: "checkout-api", environment: ENV["APP_ENV"], enabled: true, token: ENV["FOAM_OTEL_TOKEN"])
   # or, if you init in an initializer: Foam::Otel.after_fork!
 end
 ```

data/lib/foam/otel/version.rb

@@ -7,6 +7,8 @@ module Foam
     # 1.0.0: first pass aligned to docs/BASE_PACKAGE_SPEC.md (fleet convention,
     # matching the JS core's alignment bump). Breaking: the stamped/rid/
     # request-context architecture is gone; the init surface changed.
-    VERSION = "1.0.1"
+    # 1.0.1 (#80): HTTP-client instrumentation class resolved for the loop guard.
+    # 1.0.2: FOAM_OTEL_TOKEN doc convention (token comment source change); drop-in.
+    VERSION = "1.0.2"
   end
 end

data/lib/foam/otel.rb

@@ -4,7 +4,7 @@
 # docs/BASE_PACKAGE_SPEC.md.
 #
 #   Foam::Otel.init(name: "checkout-api", environment: ENV["APP_ENV"],
-#                   enabled: ENV["APP_ENV"] != "test", token: ENV["FOAM_TOKEN"])
+#                   enabled: ENV["APP_ENV"] != "test", token: ENV["FOAM_OTEL_TOKEN"])
 #
 # A thin, safe wrapper over the official OpenTelemetry libraries: foam owns
 # the PIPELINE (providers, batch processors, OTLP export to the pinned fleet

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foam-otel
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Foam
@@ -152,7 +152,12 @@ dependencies:
 description: 'A thin, safe wrapper over the official OpenTelemetry libraries: foam
   owns the pipeline (providers, batch processors, OTLP export to the foam fleet endpoint,
   an always-on redaction floor), turns on automatic tier-1/2 instrumentation, and
-  ships a small set of never-throw helpers. Built to docs/BASE_PACKAGE_SPEC.md.'
+  ships a small set of never-throw helpers. Configure with Foam::Otel.init(name:,
+  environment:, enabled:, token:); the ingest token is passed EXPLICITLY — the fleet
+  convention is to read it from the FOAM_OTEL_TOKEN environment variable and hand
+  it to init. The gem never reads the token (or any config) from the environment itself.
+  Built to docs/BASE_PACKAGE_SPEC.md; full usage in the README (shown on the source
+  page and on rubydoc.info, not on the RubyGems gem page).'
 executables: []
 extensions: []
 extra_rdoc_files: []