mcpspan 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a76f8debbf2cfc4830ae61f49f68e8bea556dee0176e1707415d19ec6fe7b9
-  data.tar.gz: b7ab651d3b894265c4a7dd21d5827b31f5996f85cb734759e4e1fb420cb17dc6
+  metadata.gz: 996561d4546232205752457ea56cb9aa1570402a5f056b9578db0a6bc3a590d3
+  data.tar.gz: 846bdb5f3f05efac26377a3a52de6c0319c05acafa7b3e5a33cc808b63973590
 SHA512:
-  metadata.gz: 84bfdf6a1e69cb02d126641811e12730e72c2166fdb507c1d2dad5e2dd17cb26ddee618b9776742a6a63be2a79c1ae891cc6666409abfd08d9f41626a3c3dd3e
-  data.tar.gz: 235cbe6fbeae4a5e88c53048595c11dd8930a7a411a6c7c4fe449997393c9677181c26bc9d36e427d4f87f5efeab3c41d49114087c87cc1bdb68460e77ae8d3e
+  metadata.gz: 7295717445bbd5a6c57938769b3ebcb9d0185baf9d99f5f266387f900c7b86aa4881eadc31029232c6a754e4ca76b9419132524641b5c4d8c05ab9ddcbe6508f
+  data.tar.gz: 7758b51df47a9aa9c6956477dac680cf083f95a756f961c15116b316e7a17a1a35237daa954d151bdaf9cb0d502a15edd17c7127ef73fa8fc9f3912c0c030bd9

data/README.md

@@ -148,8 +148,9 @@ read from the server's wording.
 mode, not in debug.
 
 What is collected: the tool name, how long it took, whether it succeeded, the
-error type and a truncated message when it did not, which client called, and
-the SDK version. For a resource or a prompt, the same, under the name it was
+error type and a truncated message when it did not, how large the answer was
+in bytes (its size only, never its content), which client called, and the SDK
+version. For a resource or a prompt, the same, under the name it was
 registered with: never the address a client read, only its template or, for
 an address the server does not have, its scheme.
 

data/lib/mcpspan/collector.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "json"
 require "securerandom"
 
 module McpSpan
@@ -103,8 +104,23 @@ module McpSpan
         )
       end
 
-      # Builds the event for a finished call and queues it. It never blocks on the network.
-      def record(call, success:, source: nil, type: nil, message: nil)
+      # The largest size an event carries; anything larger is sent as this (contract, 3.7).
+      MAX_RESPONSE_BYTES = 2_147_483_647
+
+      # Size of an answer in bytes of its compact JSON (contract, 3.7), or nil when there is none or it cannot be
+      # encoded. The JSON is counted and dropped; nothing of it is kept or sent.
+      def response_bytes(response)
+        return nil if response.nil?
+
+        value = response.is_a?(Hash) || response.is_a?(Array) || response.is_a?(String) ? response : response.to_h
+        [JSON.generate(value).bytesize, MAX_RESPONSE_BYTES].min
+      rescue StandardError
+        nil
+      end
+
+      # Builds the event for a finished call and queues it. It never blocks on the network. `response` is the answer,
+      # when there was one, to be measured.
+      def record(call, success:, source: nil, type: nil, message: nil, response: nil)
         duration_ms = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - call.started) * 1000.0
         reporter = @reporter
         return if reporter.nil?
@@ -122,6 +138,7 @@ module McpSpan
           client_name: Text.client_name(call.client_name),
           client_version: Text.version(call.client_version),
           server_version: Text.version(call.server_version),
+          response_bytes: response_bytes(response),
           timestamp: call.timestamp.strftime("%Y-%m-%dT%H:%M:%S.%LZ"),
           session_id: call.session_id,
           parameters: call.parameters,

data/lib/mcpspan/event.rb

@@ -6,7 +6,8 @@ module McpSpan
   # One call of a tool, a resource or a prompt, in the shape the ingest API takes. Parameter values are never in it.
   Event = Struct.new(
     :id, :kind, :tool_name, :duration_ms, :success, :error_source, :error_type, :error_message,
-    :client_type, :client_name, :client_version, :server_version, :timestamp, :session_id, :parameters,
+    :client_type, :client_name, :client_version, :server_version, :response_bytes, :timestamp, :session_id,
+    :parameters,
     keyword_init: true,
   ) do
     # The event as the API takes it, leaving absent fields out rather than sending them as null.
@@ -24,6 +25,7 @@ module McpSpan
         clientName: client_name,
         clientVersion: client_version,
         serverVersion: server_version,
+        responseBytes: response_bytes,
         timestamp: timestamp,
         sdkVersion: VERSION,
         sessionId: session_id,

data/lib/mcpspan/instrumentation.rb

@@ -172,11 +172,12 @@ module McpSpan
       def __mcpspan_settled(call, state, result)
         # An interim result asking the client for input settles nothing; the call that follows it does.
         return if Instrumentation.interim?(result)
-        return Collector.record(call, success: true) unless result.is_a?(Hash) && result[:isError]
+        return Collector.record(call, success: true, response: result) unless result.is_a?(Hash) && result[:isError]
 
         # The gem refuses missing or invalid arguments with an error result, before the tool is called.
         if state.reached
-          Collector.record(call, success: false, source: Source::RESULT, message: Instrumentation.result_text(result))
+          Collector.record(call, success: false, source: Source::RESULT, message: Instrumentation.result_text(result),
+                                 response: result,)
         else
           Collector.record(call, success: false, source: Source::ARGUMENTS)
         end
@@ -204,9 +205,10 @@ module McpSpan
         if call
           hash = result.respond_to?(:to_h) ? result.to_h : {}
           if hash[:isError]
-            Collector.record(call, success: false, source: Source::RESULT, message: Instrumentation.result_text(hash))
+            Collector.record(call, success: false, source: Source::RESULT, message: Instrumentation.result_text(hash),
+                                   response: hash,)
           elsif !Instrumentation.interim?(result)
-            Collector.record(call, success: true)
+            Collector.record(call, success: true, response: hash)
           end
         end
         result

data/lib/mcpspan/primitives.rb

@@ -141,7 +141,7 @@ module McpSpan
 
       def __mcpspan_succeeded(call, result)
         # An interim result asking the client for input settles nothing; the request that follows it does.
-        Collector.record(call, success: true) unless Instrumentation.interim?(result)
+        Collector.record(call, success: true, response: result) unless Instrumentation.interim?(result)
       rescue *Instrumentation::INTERNAL
         nil
       end

data/lib/mcpspan/version.rb

@@ -2,5 +2,5 @@
 
 module McpSpan
   # The SDK's own version, reported with every event.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mcpspan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kacper Zatoń