foam-otel 3.0.0.alpha.1 → 3.0.0.alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -0
  3. data/lib/foam/otel/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2685d07a37df1e0cba2d05502a1770ac4acc6ff9b84cf0b88617ab136ce51f39
4
- data.tar.gz: 1a3ad50dcd4d820f3e075514ae05d03bb27af6debb671f18d4f2a5c9ea01f810
3
+ metadata.gz: 84aeaf2ff147abcf6caa5daf14bfdcc6337fad7818bc179211940b5e0783e29a
4
+ data.tar.gz: 5245d54ff60bf26ad881f567ba1759ed35e0fef3e30ff86e7d1269f4cc53492b
5
5
  SHA512:
6
- metadata.gz: acaa38fe67202a49d8489cdc091025484aa1fc77758e689805ba94cae6e1487c79b7aeaf8ae2996ef21ff265cd0c4bed42610bafea8cf6b5378ab00855976673
7
- data.tar.gz: f8f0354cef8c5e1c31be1ba1065a2e8f8fd02b807a60e655ca98615040ce8b1c699bf7da6d9220b00923bbc8fbefef2e0166ef4c7c838f2bd7e800eeea0182c5
6
+ metadata.gz: 32b2b4fd511ff967b5aee4be97b2851818133173855f8b147d7814f3c21aebed7893f2b54c76a9433cc4e6077e506bae17e8f4e0a0a9e6acac85e446a78cb329
7
+ data.tar.gz: 417c68d1de6399ab2fd82e4607b70eaeb172878c9beebfcbf9914495fc37fe500127fc17e97e4b23af0c3ab38db7318b25c9fe58510a7d39d8e84976c397c592
data/README.md CHANGED
@@ -75,6 +75,32 @@ trilogy.
75
75
  To install an instrumentation outside the bundle, list it in
76
76
  `additional_instrumentations`.
77
77
 
78
+ TODO(jhartquist): Revisit and review this compatibility guidance.
79
+
80
+ ### Instrumentation versions
81
+
82
+ Bundler keeps one version of each gem in the application. By the time Foam
83
+ starts, those versions are already fixed. `additional_instrumentations` only
84
+ configures an instrumentation that Bundler installed and Ruby loaded; it
85
+ cannot choose or install another version.
86
+
87
+ If a bundled instrumentation does not support the library version your app
88
+ uses, pin a compatible `opentelemetry-instrumentation-*` gem in the `Gemfile`
89
+ and run `bundle install` again.
90
+
91
+ If Bundler accepts the pin, restart the app and the whole bundle will use that
92
+ instrumentation version. If it conflicts with `foam-otel` or
93
+ `opentelemetry-instrumentation-all`, those versions cannot live in the same
94
+ bundle. At that point, change the application library, use a compatible Foam
95
+ release, or accept the telemetry gap: the app can keep running, but Foam will
96
+ not receive the spans that instrumentation would have produced.
97
+
98
+ Even a successful `bundle install` only means the declared gem dependencies
99
+ agree. The instrumentation checks the target library when `init` runs. If the
100
+ target is unsupported, Foam leaves that instrumentation out of
101
+ `state[:instrumentations]`. `additional_instrumentations` cannot bypass the
102
+ check or load a second version of the gem.
103
+
78
104
  The `pg`, `mysql2`, and `trilogy` instrumentations send the full SQL
79
105
  statement (`db_statement: :include`); the others keep their upstream
80
106
  defaults. To disable one instrumentation or change its options, pass it
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Foam
4
4
  module Otel
5
- VERSION = "3.0.0.alpha.1"
5
+ VERSION = "3.0.0.alpha.2"
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: foam-otel
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0.alpha.1
4
+ version: 3.0.0.alpha.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Foam
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-09-08 00:00:00.000000000 Z
11
+ date: 2026-09-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: opentelemetry-exporter-otlp