agentcat 0.0.1 → 1.1.0
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.
- checksums.yaml +4 -4
- data/LICENSE +2 -11
- data/README.md +265 -20
- data/lib/agentcat/adapters/base.rb +98 -0
- data/lib/agentcat/adapters/official.rb +277 -0
- data/lib/agentcat/client.rb +189 -0
- data/lib/agentcat/clock.rb +16 -0
- data/lib/agentcat/custom_event.rb +215 -0
- data/lib/agentcat/delivery.rb +58 -0
- data/lib/agentcat/diagnostics.rb +434 -0
- data/lib/agentcat/error_capture.rb +117 -0
- data/lib/agentcat/event_id.rb +19 -0
- data/lib/agentcat/event_pipeline.rb +82 -0
- data/lib/agentcat/event_queue.rb +151 -0
- data/lib/agentcat/exporters/base.rb +135 -0
- data/lib/agentcat/exporters/datadog.rb +137 -0
- data/lib/agentcat/exporters/otlp.rb +157 -0
- data/lib/agentcat/exporters/posthog.rb +185 -0
- data/lib/agentcat/exporters/sentry.rb +242 -0
- data/lib/agentcat/exporters/trace_context.rb +79 -0
- data/lib/agentcat/exporters.rb +108 -0
- data/lib/agentcat/fork_safety.rb +30 -0
- data/lib/agentcat/hooks.rb +190 -0
- data/lib/agentcat/http_post.rb +61 -0
- data/lib/agentcat/interceptor.rb +728 -0
- data/lib/agentcat/log.rb +80 -0
- data/lib/agentcat/options.rb +313 -0
- data/lib/agentcat/payload_limits.rb +71 -0
- data/lib/agentcat/private_members.rb +286 -0
- data/lib/agentcat/redaction.rb +176 -0
- data/lib/agentcat/rejected_calls.rb +147 -0
- data/lib/agentcat/request_context.rb +266 -0
- data/lib/agentcat/sanitization.rb +191 -0
- data/lib/agentcat/schema/prompts.rb +44 -0
- data/lib/agentcat/server_info.rb +280 -0
- data/lib/agentcat/session_manager.rb +83 -0
- data/lib/agentcat/tags.rb +61 -0
- data/lib/agentcat/test_mode.rb +86 -0
- data/lib/agentcat/testing.rb +153 -0
- data/lib/agentcat/text.rb +68 -0
- data/lib/agentcat/token_estimate.rb +98 -0
- data/lib/agentcat/tool_call.rb +129 -0
- data/lib/agentcat/tool_handle.rb +289 -0
- data/lib/agentcat/tracker.rb +204 -0
- data/lib/agentcat/truncation.rb +265 -0
- data/lib/agentcat/unredacted_event.rb +155 -0
- data/lib/agentcat/user_identity.rb +11 -0
- data/lib/agentcat/version.rb +2 -2
- data/lib/agentcat.rb +393 -21
- metadata +194 -16
- data/agentcat.gemspec +0 -30
data/lib/agentcat.rb
CHANGED
|
@@ -1,27 +1,399 @@
|
|
|
1
|
-
#
|
|
1
|
+
# typed: true
|
|
2
|
+
|
|
3
|
+
require "sorbet-runtime"
|
|
2
4
|
|
|
3
5
|
require_relative "agentcat/version"
|
|
6
|
+
require_relative "agentcat/clock"
|
|
7
|
+
require_relative "agentcat/log"
|
|
8
|
+
require_relative "agentcat/private_members"
|
|
9
|
+
require_relative "agentcat/http_post"
|
|
10
|
+
require_relative "agentcat/test_mode"
|
|
11
|
+
require_relative "agentcat/diagnostics"
|
|
12
|
+
require_relative "agentcat/schema/prompts"
|
|
13
|
+
require_relative "agentcat/options"
|
|
14
|
+
require_relative "agentcat/hooks"
|
|
15
|
+
require_relative "agentcat/session_manager"
|
|
16
|
+
require_relative "agentcat/event_id"
|
|
17
|
+
require_relative "agentcat/user_identity"
|
|
18
|
+
require_relative "agentcat/request_context"
|
|
19
|
+
require_relative "agentcat/tool_call"
|
|
20
|
+
require_relative "agentcat/client"
|
|
21
|
+
require_relative "agentcat/tool_handle"
|
|
22
|
+
require_relative "agentcat/adapters/base"
|
|
23
|
+
require_relative "agentcat/adapters/official"
|
|
24
|
+
require_relative "agentcat/text"
|
|
25
|
+
require_relative "agentcat/unredacted_event"
|
|
26
|
+
require_relative "agentcat/token_estimate"
|
|
27
|
+
require_relative "agentcat/payload_limits"
|
|
28
|
+
require_relative "agentcat/tags"
|
|
29
|
+
require_relative "agentcat/sanitization"
|
|
30
|
+
require_relative "agentcat/truncation"
|
|
31
|
+
require_relative "agentcat/error_capture"
|
|
32
|
+
require_relative "agentcat/redaction"
|
|
33
|
+
require_relative "agentcat/event_queue"
|
|
34
|
+
require_relative "agentcat/delivery"
|
|
35
|
+
require_relative "agentcat/exporters"
|
|
36
|
+
require_relative "agentcat/event_pipeline"
|
|
37
|
+
require_relative "agentcat/fork_safety"
|
|
38
|
+
require_relative "agentcat/custom_event"
|
|
39
|
+
require_relative "agentcat/server_info"
|
|
40
|
+
require_relative "agentcat/interceptor"
|
|
41
|
+
require_relative "agentcat/tracker"
|
|
4
42
|
|
|
5
|
-
# AgentCat — analytics for MCP servers.
|
|
6
|
-
#
|
|
7
|
-
# This release is a name placeholder. The official AgentCat Ruby SDK, built on
|
|
8
|
-
# the official Model Context Protocol Ruby SDK (the `mcp` gem), is in active
|
|
9
|
-
# development and will ship as version 1.0.0.
|
|
10
|
-
#
|
|
11
|
-
# Until then, see the reference implementations:
|
|
12
|
-
# TypeScript — https://github.com/agentcathq/agentcat-typescript-sdk
|
|
13
|
-
# Python — https://github.com/agentcathq/agentcat-python-sdk
|
|
14
|
-
# Go — https://github.com/agentcathq/agentcat-go-sdk
|
|
15
43
|
module AgentCat
|
|
16
|
-
#
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
#
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
44
|
+
# `AgentCat.fake` and its assertions. Loaded on first use, not with the SDK.
|
|
45
|
+
autoload :Testing, File.expand_path("agentcat/testing", __dir__)
|
|
46
|
+
|
|
47
|
+
PROJECT_ID_PATTERN = /\Aproj_[A-Za-z0-9]{27}\z/
|
|
48
|
+
ADAPTERS = [Adapters::Official].freeze
|
|
49
|
+
# Like TS's 5 s graceful shutdown.
|
|
50
|
+
AT_EXIT_FLUSH_TIMEOUT = 5
|
|
51
|
+
|
|
52
|
+
# Server => Tracker, both held weakly, so a server built per request (the README's
|
|
53
|
+
# stateless pattern) is collected with its tracker once the request is done. The
|
|
54
|
+
# server keeps its own tracker alive: the dispatch wrapper and the tool handles that
|
|
55
|
+
# `Tracker#install!` puts on it reference the tracker. WeakMap compares keys by
|
|
56
|
+
# identity on every Ruby we support. Not `ObjectSpace::WeakKeyMap` (3.3+): it holds
|
|
57
|
+
# values strongly and the tracker references its server (through the adapter), so no
|
|
58
|
+
# server would ever be collected.
|
|
59
|
+
@trackers = ObjectSpace::WeakMap.new
|
|
60
|
+
@mutex = Mutex.new
|
|
61
|
+
@event_queue = T.let(nil, T.nilable(EventQueue))
|
|
62
|
+
@event_queue_mutex = Mutex.new
|
|
63
|
+
@event_queue_epoch = T.let(0, Integer)
|
|
64
|
+
@at_exit_registered = false
|
|
65
|
+
# The first tracked server's non-empty `Options#exporters`. Untracked custom events
|
|
66
|
+
# (no tracker, so no options of their own) go here, like TS's process-wide
|
|
67
|
+
# telemetry manager, which is also first-wins.
|
|
68
|
+
@process_exporters = T.let([], T::Array[T.untyped])
|
|
69
|
+
# `AgentCat.fake`'s recorder while a test uses one.
|
|
70
|
+
@fake = T.let(nil, T.untyped)
|
|
71
|
+
# A `track` ran while AgentCat was off (test mode or AGENTCAT_ENABLED=false).
|
|
72
|
+
@skipped_track = T.let(false, T::Boolean)
|
|
73
|
+
# Malformed project IDs already warned about, so a per-request `track` logs one line.
|
|
74
|
+
@warned_project_ids = T.let({}, T::Hash[String, TrueClass])
|
|
75
|
+
|
|
76
|
+
class << self
|
|
77
|
+
extend T::Sig
|
|
78
|
+
|
|
79
|
+
# Instruments `server` so that every tool call is attributed to a session and reported to AgentCat.
|
|
80
|
+
#
|
|
81
|
+
# Returns the server. Tracking is idempotent per server instance, and a server no adapter
|
|
82
|
+
# recognises is returned untouched.
|
|
83
|
+
#
|
|
84
|
+
# `project_id` nil, empty or blank means telemetry only: events go to `Options#exporters`
|
|
85
|
+
# and not to AgentCat (TS parity; `AGENTCAT_PROJECT_ID` is not read). A project ID that
|
|
86
|
+
# does not look like `proj_` plus 27 letters or digits logs one warning and is sent as
|
|
87
|
+
# given, like the TypeScript and PHP SDKs: the AgentCat API decides.
|
|
88
|
+
#
|
|
89
|
+
# `AGENTCAT_ENABLED` turns AgentCat off everywhere with `false`, `0`, `no` or `off`, and
|
|
90
|
+
# on everywhere with `true`, `1`, `yes` or `on`. Otherwise AgentCat does nothing in test
|
|
91
|
+
# environments (Minitest or RSpec loaded, or `RAILS_ENV`/`RACK_ENV`/`APP_ENV` set to
|
|
92
|
+
# `test` or `testing`) unless the test called `AgentCat.fake` first. "Nothing" means the
|
|
93
|
+
# server comes back untouched: no instrumentation, no delivery, no diagnostics.
|
|
94
|
+
sig { params(server: T.untyped, project_id: T.nilable(String), options: T.nilable(AgentCat::Options)).returns(T.untyped) }
|
|
95
|
+
def track(server, project_id = nil, options = nil)
|
|
96
|
+
unless TestMode.sdk_enabled?
|
|
97
|
+
@mutex.synchronize { @skipped_track = true }
|
|
98
|
+
return server
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
project_id = normalize_project_id(project_id)
|
|
102
|
+
options ||= Options.new
|
|
103
|
+
# A fake sends nothing, diagnostics included.
|
|
104
|
+
unless active_fake
|
|
105
|
+
Diagnostics.init(
|
|
106
|
+
project_id: project_id,
|
|
107
|
+
integration: integration_name(options),
|
|
108
|
+
disabled: options.disable_diagnostics
|
|
109
|
+
)
|
|
110
|
+
Diagnostics.record(:info, "AgentCat setup started | project #{project_display(project_id)}")
|
|
111
|
+
# Before anything can fail: a process whose `track` fails and then exits still
|
|
112
|
+
# sends that diagnostics record from the at_exit flush.
|
|
113
|
+
register_at_exit_flush!
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
begin
|
|
117
|
+
warn_if_malformed_project_id(project_id)
|
|
118
|
+
%i[identify resolve_session_id event_tags event_properties].each do |name|
|
|
119
|
+
Hooks.warn_if_two_arguments(options.public_send(name), name.to_s)
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
adapter_class = detect_adapter(server)
|
|
123
|
+
unless adapter_class
|
|
124
|
+
Diagnostics.record(:warn, "AgentCat setup skipped | no adapter for #{server.class}")
|
|
125
|
+
return server
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Once per process: every `mcp` gem internal AgentCat uses is there, or its
|
|
129
|
+
# feature is off (one ERROR line each).
|
|
130
|
+
PrivateMembers.check! if adapter_class == Adapters::Official
|
|
131
|
+
|
|
132
|
+
# Process-wide: captures incoming HTTP headers for `parameters.extra`. A
|
|
133
|
+
# no-op for stdio and for a process where the HTTP transport isn't loaded
|
|
134
|
+
# (yet); idempotent, so a second `track` doesn't re-patch.
|
|
135
|
+
RequestContext.install!
|
|
136
|
+
|
|
137
|
+
@mutex.synchronize do
|
|
138
|
+
return server if @trackers.key?(server)
|
|
139
|
+
|
|
140
|
+
# Built first: if building it raises, the first-wins process-wide settings
|
|
141
|
+
# below stay free for a `track` that works.
|
|
142
|
+
tracker = Tracker.new(adapter: adapter_class.new(server), project_id: project_id, options: options)
|
|
143
|
+
configure_default_client(options)
|
|
144
|
+
@process_exporters = options.exporters.dup.freeze if @process_exporters.empty? && !options.exporters.empty?
|
|
145
|
+
begin
|
|
146
|
+
tracker.install!
|
|
147
|
+
rescue => e
|
|
148
|
+
Log.error("AgentCat failed to instrument the server, so some of its calls are not tracked: #{e.class}: #{e.message}")
|
|
149
|
+
Diagnostics.record(:warn, "AgentCat failed to instrument server | #{e.class}: #{e.message}")
|
|
150
|
+
end
|
|
151
|
+
@trackers[server] = tracker
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
server
|
|
155
|
+
rescue => e
|
|
156
|
+
# `track` never raises into setup code. A wrong argument type still
|
|
157
|
+
# fails fast in the sig above, before this method body runs.
|
|
158
|
+
Log.error("AgentCat setup failed, the server is not tracked: #{e.class}: #{e.message}")
|
|
159
|
+
Diagnostics.record(:error, "AgentCat setup failed | #{e.class}: #{e.message}")
|
|
160
|
+
server
|
|
161
|
+
end
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
sig { params(server: T.untyped).returns(T.nilable(AgentCat::Tracker)) }
|
|
165
|
+
def tracker_for(server)
|
|
166
|
+
@mutex.synchronize { @trackers[server] }
|
|
167
|
+
end
|
|
168
|
+
alias_method :_tracking_data, :tracker_for
|
|
169
|
+
|
|
170
|
+
sig { params(server: T.untyped).returns(T::Boolean) }
|
|
171
|
+
def tracked?(server)
|
|
172
|
+
!tracker_for(server).nil?
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Forgets every tracked server. Instrumentation already installed on a server stays in place.
|
|
176
|
+
# The event queue is torn down and rebuilt lazily, so nothing queued (or retrying) from before
|
|
177
|
+
# the reset can publish into whatever follows it.
|
|
178
|
+
#
|
|
179
|
+
# Also removes `AgentCat.fake`'s recorder: call it in your test's teardown.
|
|
180
|
+
sig { void }
|
|
181
|
+
def reset!
|
|
182
|
+
Diagnostics.reset!
|
|
183
|
+
Log.reset!
|
|
184
|
+
PrivateMembers.reset!
|
|
185
|
+
ServerInfo.reset!
|
|
186
|
+
@event_queue_mutex.synchronize do
|
|
187
|
+
@event_queue_epoch += 1
|
|
188
|
+
@event_queue&.shutdown
|
|
189
|
+
@event_queue = nil
|
|
190
|
+
end
|
|
191
|
+
@mutex.synchronize do
|
|
192
|
+
@trackers = ObjectSpace::WeakMap.new
|
|
193
|
+
@process_exporters = []
|
|
194
|
+
@fake = nil
|
|
195
|
+
@skipped_track = false
|
|
196
|
+
@warned_project_ids = {}
|
|
197
|
+
end
|
|
198
|
+
end
|
|
199
|
+
|
|
200
|
+
# Starts recording for your test suite and returns the recorder to assert on. While
|
|
201
|
+
# it is active, AgentCat instruments servers even in a test environment (and even
|
|
202
|
+
# with AGENTCAT_ENABLED=false), but every event goes to the fake instead of AgentCat,
|
|
203
|
+
# the exporters or diagnostics. Call it before `track`: in a test environment, a
|
|
204
|
+
# server tracked before `fake` is not tracked at all. A second call replaces the
|
|
205
|
+
# recorder. `AgentCat.reset!` (in your teardown) removes it.
|
|
206
|
+
#
|
|
207
|
+
# fake = AgentCat.fake
|
|
208
|
+
# AgentCat.track(server, "proj_...")
|
|
209
|
+
# # ... call a tool ...
|
|
210
|
+
# fake.assert_tracked("my_tool")
|
|
211
|
+
sig { returns(AgentCat::Testing::Fake) }
|
|
212
|
+
def fake
|
|
213
|
+
recorder = Testing::Fake.new
|
|
214
|
+
@mutex.synchronize { @fake = recorder }
|
|
215
|
+
recorder
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# The active `fake`, or nil. Internal: the event pipeline asks it.
|
|
219
|
+
sig { returns(T.nilable(AgentCat::Testing::Fake)) }
|
|
220
|
+
def active_fake
|
|
221
|
+
@fake
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# Whether a `track` ran while AgentCat was off, for the fake's failure messages.
|
|
225
|
+
sig { returns(T::Boolean) }
|
|
226
|
+
def skipped_track?
|
|
227
|
+
@skipped_track
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# See `@process_exporters` above.
|
|
231
|
+
sig { returns(T::Array[T.untyped]) }
|
|
232
|
+
def process_exporters
|
|
233
|
+
@mutex.synchronize { @process_exporters }
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Monotonic counter bumped by `reset!`. `Delivery` compares against it between publish
|
|
237
|
+
# attempts so an event enqueued before a reset isn't delivered into a stale process state.
|
|
238
|
+
sig { returns(Integer) }
|
|
239
|
+
def event_epoch
|
|
240
|
+
@event_queue_mutex.synchronize { @event_queue_epoch }
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
sig { params(server: T.untyped).returns(T.nilable(T.class_of(AgentCat::Adapters::Base))) }
|
|
244
|
+
def detect_adapter(server)
|
|
245
|
+
ADAPTERS.find { |adapter| adapter.supports?(server) }
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
# Lazy, process-wide. Created on first use rather than at `track()` time, so a
|
|
249
|
+
# process that never publishes anything never spawns a worker thread. `queue_size`
|
|
250
|
+
# only takes effect on that first creation, same as the client timeout.
|
|
251
|
+
sig { params(queue_size: T.nilable(Integer)).returns(EventQueue) }
|
|
252
|
+
def event_queue(queue_size: nil)
|
|
253
|
+
@event_queue_mutex.synchronize do
|
|
254
|
+
@event_queue ||= begin
|
|
255
|
+
ForkSafety.install!
|
|
256
|
+
register_at_exit_flush!
|
|
257
|
+
EventQueue.new(max_size: queue_size || EventQueue::DEFAULT_MAX_SIZE)
|
|
258
|
+
end
|
|
259
|
+
end
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
# For the `Process._fork` hook — not meant to be called directly.
|
|
263
|
+
sig { void }
|
|
264
|
+
def reset_event_queue_after_fork!
|
|
265
|
+
@event_queue&.reset_after_fork!
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
# Waits for queued events to publish, then sends AgentCat's pending diagnostics
|
|
269
|
+
# records (at most about 1 s more, see Diagnostics::TOTAL_TIMEOUT). Returns whether
|
|
270
|
+
# the event queue drained in time. `at_exit` calls this too (with a 5 s budget), but
|
|
271
|
+
# that's best-effort only — no SIGKILL, no guaranteed ordering against Puma's
|
|
272
|
+
# shutdown — so call it explicitly on shutdown if you're in a container or anything
|
|
273
|
+
# short-lived.
|
|
274
|
+
sig { params(timeout: Numeric).returns(T::Boolean) }
|
|
275
|
+
def flush(timeout: 5)
|
|
276
|
+
drained = @event_queue.nil? || @event_queue.flush(timeout: timeout)
|
|
277
|
+
# After the events: a publish that gave up records a diagnostics line.
|
|
278
|
+
Diagnostics.flush
|
|
279
|
+
drained
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
# Publishes one `agentcat:custom` event for work that is not a tool call - a
|
|
283
|
+
# background job, a webhook, a checkout step, anything you want on the same
|
|
284
|
+
# timeline as the tool calls AgentCat captures automatically.
|
|
285
|
+
#
|
|
286
|
+
# `server_or_session_id` is either a server already passed to `track()`, or a
|
|
287
|
+
# session ID string used verbatim (never validated, trimmed, or derived - this is
|
|
288
|
+
# a deliberate call, not an agent's guess). `session_id:` takes precedence over
|
|
289
|
+
# a string first argument, and attributes the event to a task; without one, a
|
|
290
|
+
# tracked server publishes without a session (handles are per-request, so a
|
|
291
|
+
# tracked server has no ambient one to fall back on).
|
|
292
|
+
#
|
|
293
|
+
# `project_id` is used as given in the session-ID-string form. In the tracked-
|
|
294
|
+
# server form it's ignored - the project captured at `track()` time wins, so a
|
|
295
|
+
# telemetry-only server still publishes.
|
|
296
|
+
#
|
|
297
|
+
# Does nothing where `track` does nothing (see `AGENTCAT_ENABLED` there); with
|
|
298
|
+
# `AgentCat.fake`, the event goes to the fake.
|
|
299
|
+
#
|
|
300
|
+
# Fire-and-forget: never raises. A mistyped `resource_name`/`message`/`duration`/
|
|
301
|
+
# `is_error`/`tags` costs that field, not the event; a non-Hash `parameters`/
|
|
302
|
+
# `response`/`properties` is wrapped as `{value: ...}` and kept, since the wire
|
|
303
|
+
# field holds an object and the payload is yours to keep.
|
|
304
|
+
#
|
|
305
|
+
# Every customer-data param below is `T.untyped`, not the type it's documented to
|
|
306
|
+
# want: a `sig` must not be what enforces this (same rule as hook return values,
|
|
307
|
+
# see Options' typing note) - a mistyped field has to reach CustomEvent's own
|
|
308
|
+
# wire_* coercion to be downgraded gracefully, not raise here first.
|
|
309
|
+
sig do
|
|
310
|
+
params(
|
|
311
|
+
server_or_session_id: T.untyped,
|
|
312
|
+
project_id: T.untyped,
|
|
313
|
+
session_id: T.untyped,
|
|
314
|
+
resource_name: T.untyped,
|
|
315
|
+
parameters: T.untyped,
|
|
316
|
+
response: T.untyped,
|
|
317
|
+
message: T.untyped,
|
|
318
|
+
duration: T.untyped,
|
|
319
|
+
is_error: T.untyped,
|
|
320
|
+
error: T.untyped,
|
|
321
|
+
tags: T.untyped,
|
|
322
|
+
properties: T.untyped
|
|
323
|
+
).void
|
|
324
|
+
end
|
|
325
|
+
def publish_custom_event(
|
|
326
|
+
server_or_session_id,
|
|
327
|
+
project_id,
|
|
328
|
+
session_id: nil,
|
|
329
|
+
resource_name: nil,
|
|
330
|
+
parameters: nil,
|
|
331
|
+
response: nil,
|
|
332
|
+
message: nil,
|
|
333
|
+
duration: nil,
|
|
334
|
+
is_error: nil,
|
|
335
|
+
error: nil,
|
|
336
|
+
tags: nil,
|
|
337
|
+
properties: nil
|
|
338
|
+
)
|
|
339
|
+
return unless TestMode.sdk_enabled?
|
|
340
|
+
|
|
341
|
+
CustomEvent.publish(
|
|
342
|
+
server_or_session_id, project_id,
|
|
343
|
+
session_id: session_id, resource_name: resource_name, parameters: parameters,
|
|
344
|
+
response: response, message: message, duration: duration, is_error: is_error,
|
|
345
|
+
error: error, tags: tags, properties: properties
|
|
346
|
+
)
|
|
347
|
+
end
|
|
348
|
+
|
|
349
|
+
private
|
|
350
|
+
|
|
351
|
+
sig { void }
|
|
352
|
+
def register_at_exit_flush!
|
|
353
|
+
return if @at_exit_registered
|
|
354
|
+
|
|
355
|
+
@at_exit_registered = true
|
|
356
|
+
at_exit { flush(timeout: AT_EXIT_FLUSH_TIMEOUT) }
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
# First `track` wins, like the event queue's size.
|
|
360
|
+
sig { params(options: AgentCat::Options).void }
|
|
361
|
+
def configure_default_client(options)
|
|
362
|
+
return unless options.default_client?
|
|
363
|
+
|
|
364
|
+
Client.configure_timeout(options.request_timeout)
|
|
365
|
+
base_url = options.api_base_url
|
|
366
|
+
Client.configure_base_url(base_url) if base_url
|
|
367
|
+
end
|
|
368
|
+
|
|
369
|
+
# nil, "" and whitespace-only all mean telemetry only.
|
|
370
|
+
sig { params(project_id: T.nilable(String)).returns(T.nilable(String)) }
|
|
371
|
+
def normalize_project_id(project_id)
|
|
372
|
+
return nil if project_id.nil? || project_id.strip.empty?
|
|
373
|
+
|
|
374
|
+
project_id
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
sig { params(project_id: T.nilable(String)).void }
|
|
378
|
+
def warn_if_malformed_project_id(project_id)
|
|
379
|
+
return if project_id.nil? || project_id.match?(PROJECT_ID_PATTERN)
|
|
380
|
+
first_time = @mutex.synchronize { @warned_project_ids.store(project_id, true) unless @warned_project_ids.key?(project_id) }
|
|
381
|
+
return unless first_time
|
|
382
|
+
|
|
383
|
+
message = "project_id #{project_id.inspect} does not match proj_ followed by 27 letters or digits; " \
|
|
384
|
+
"events are sent with it as given, and the AgentCat API can reject them"
|
|
385
|
+
logger.warn(message)
|
|
386
|
+
Diagnostics.record(:warn, "AgentCat setup warning | #{message}")
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
sig { params(_options: AgentCat::Options).returns(String) }
|
|
390
|
+
def integration_name(_options)
|
|
391
|
+
"ruby"
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
sig { params(project_id: T.nilable(String)).returns(String) }
|
|
395
|
+
def project_display(project_id)
|
|
396
|
+
project_id.to_s.empty? ? "(telemetry-only)" : project_id.to_s
|
|
397
|
+
end
|
|
26
398
|
end
|
|
27
399
|
end
|
metadata
CHANGED
|
@@ -1,28 +1,207 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: agentcat
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 1.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- AgentCat, Inc.
|
|
8
|
-
autorequire:
|
|
9
8
|
bindir: bin
|
|
10
9
|
cert_chain: []
|
|
11
|
-
date:
|
|
12
|
-
dependencies:
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
-
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: agentcat-api
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - '='
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: 0.0.4
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - '='
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: 0.0.4
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: sorbet-runtime
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - ">="
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0.5'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - ">="
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '0.5'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: mcp
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: 0.23.0
|
|
47
|
+
type: :runtime
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: 0.23.0
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: minitest
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - ">="
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '6'
|
|
61
|
+
type: :development
|
|
62
|
+
prerelease: false
|
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '6'
|
|
68
|
+
- !ruby/object:Gem::Dependency
|
|
69
|
+
name: minitest-mock
|
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - ">="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '5.27'
|
|
75
|
+
type: :development
|
|
76
|
+
prerelease: false
|
|
77
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - ">="
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '5.27'
|
|
82
|
+
- !ruby/object:Gem::Dependency
|
|
83
|
+
name: rack
|
|
84
|
+
requirement: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '2.2'
|
|
89
|
+
type: :development
|
|
90
|
+
prerelease: false
|
|
91
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - ">="
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '2.2'
|
|
96
|
+
- !ruby/object:Gem::Dependency
|
|
97
|
+
name: rake
|
|
98
|
+
requirement: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - ">="
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: '13'
|
|
103
|
+
type: :development
|
|
104
|
+
prerelease: false
|
|
105
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - ">="
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: '13'
|
|
110
|
+
- !ruby/object:Gem::Dependency
|
|
111
|
+
name: simplecov
|
|
112
|
+
requirement: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - ">="
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: '0.22'
|
|
117
|
+
type: :development
|
|
118
|
+
prerelease: false
|
|
119
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
120
|
+
requirements:
|
|
121
|
+
- - ">="
|
|
122
|
+
- !ruby/object:Gem::Version
|
|
123
|
+
version: '0.22'
|
|
124
|
+
- !ruby/object:Gem::Dependency
|
|
125
|
+
name: sorbet
|
|
126
|
+
requirement: !ruby/object:Gem::Requirement
|
|
127
|
+
requirements:
|
|
128
|
+
- - ">="
|
|
129
|
+
- !ruby/object:Gem::Version
|
|
130
|
+
version: '0.5'
|
|
131
|
+
type: :development
|
|
132
|
+
prerelease: false
|
|
133
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
134
|
+
requirements:
|
|
135
|
+
- - ">="
|
|
136
|
+
- !ruby/object:Gem::Version
|
|
137
|
+
version: '0.5'
|
|
138
|
+
- !ruby/object:Gem::Dependency
|
|
139
|
+
name: standard
|
|
140
|
+
requirement: !ruby/object:Gem::Requirement
|
|
141
|
+
requirements:
|
|
142
|
+
- - ">="
|
|
143
|
+
- !ruby/object:Gem::Version
|
|
144
|
+
version: 1.35.1
|
|
145
|
+
type: :development
|
|
146
|
+
prerelease: false
|
|
147
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
148
|
+
requirements:
|
|
149
|
+
- - ">="
|
|
150
|
+
- !ruby/object:Gem::Version
|
|
151
|
+
version: 1.35.1
|
|
152
|
+
description: AgentCat is an analytics platform for MCP server owners. It tracks tool
|
|
153
|
+
usage patterns of the MCP servers built on the official mcp gem and provides insights.
|
|
18
154
|
executables: []
|
|
19
155
|
extensions: []
|
|
20
156
|
extra_rdoc_files: []
|
|
21
157
|
files:
|
|
22
158
|
- LICENSE
|
|
23
159
|
- README.md
|
|
24
|
-
- agentcat.gemspec
|
|
25
160
|
- lib/agentcat.rb
|
|
161
|
+
- lib/agentcat/adapters/base.rb
|
|
162
|
+
- lib/agentcat/adapters/official.rb
|
|
163
|
+
- lib/agentcat/client.rb
|
|
164
|
+
- lib/agentcat/clock.rb
|
|
165
|
+
- lib/agentcat/custom_event.rb
|
|
166
|
+
- lib/agentcat/delivery.rb
|
|
167
|
+
- lib/agentcat/diagnostics.rb
|
|
168
|
+
- lib/agentcat/error_capture.rb
|
|
169
|
+
- lib/agentcat/event_id.rb
|
|
170
|
+
- lib/agentcat/event_pipeline.rb
|
|
171
|
+
- lib/agentcat/event_queue.rb
|
|
172
|
+
- lib/agentcat/exporters.rb
|
|
173
|
+
- lib/agentcat/exporters/base.rb
|
|
174
|
+
- lib/agentcat/exporters/datadog.rb
|
|
175
|
+
- lib/agentcat/exporters/otlp.rb
|
|
176
|
+
- lib/agentcat/exporters/posthog.rb
|
|
177
|
+
- lib/agentcat/exporters/sentry.rb
|
|
178
|
+
- lib/agentcat/exporters/trace_context.rb
|
|
179
|
+
- lib/agentcat/fork_safety.rb
|
|
180
|
+
- lib/agentcat/hooks.rb
|
|
181
|
+
- lib/agentcat/http_post.rb
|
|
182
|
+
- lib/agentcat/interceptor.rb
|
|
183
|
+
- lib/agentcat/log.rb
|
|
184
|
+
- lib/agentcat/options.rb
|
|
185
|
+
- lib/agentcat/payload_limits.rb
|
|
186
|
+
- lib/agentcat/private_members.rb
|
|
187
|
+
- lib/agentcat/redaction.rb
|
|
188
|
+
- lib/agentcat/rejected_calls.rb
|
|
189
|
+
- lib/agentcat/request_context.rb
|
|
190
|
+
- lib/agentcat/sanitization.rb
|
|
191
|
+
- lib/agentcat/schema/prompts.rb
|
|
192
|
+
- lib/agentcat/server_info.rb
|
|
193
|
+
- lib/agentcat/session_manager.rb
|
|
194
|
+
- lib/agentcat/tags.rb
|
|
195
|
+
- lib/agentcat/test_mode.rb
|
|
196
|
+
- lib/agentcat/testing.rb
|
|
197
|
+
- lib/agentcat/text.rb
|
|
198
|
+
- lib/agentcat/token_estimate.rb
|
|
199
|
+
- lib/agentcat/tool_call.rb
|
|
200
|
+
- lib/agentcat/tool_handle.rb
|
|
201
|
+
- lib/agentcat/tracker.rb
|
|
202
|
+
- lib/agentcat/truncation.rb
|
|
203
|
+
- lib/agentcat/unredacted_event.rb
|
|
204
|
+
- lib/agentcat/user_identity.rb
|
|
26
205
|
- lib/agentcat/version.rb
|
|
27
206
|
homepage: https://agentcat.com
|
|
28
207
|
licenses:
|
|
@@ -30,10 +209,9 @@ licenses:
|
|
|
30
209
|
metadata:
|
|
31
210
|
homepage_uri: https://agentcat.com
|
|
32
211
|
source_code_uri: https://github.com/agentcathq/agentcat-ruby-sdk
|
|
212
|
+
changelog_uri: https://github.com/agentcathq/agentcat-ruby-sdk/blob/main/CHANGELOG.md
|
|
33
213
|
bug_tracker_uri: https://github.com/agentcathq/agentcat-ruby-sdk/issues
|
|
34
|
-
documentation_uri: https://docs.agentcat.com
|
|
35
214
|
rubygems_mfa_required: 'true'
|
|
36
|
-
post_install_message:
|
|
37
215
|
rdoc_options: []
|
|
38
216
|
require_paths:
|
|
39
217
|
- lib
|
|
@@ -41,15 +219,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
41
219
|
requirements:
|
|
42
220
|
- - ">="
|
|
43
221
|
- !ruby/object:Gem::Version
|
|
44
|
-
version:
|
|
222
|
+
version: '3.3'
|
|
45
223
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
46
224
|
requirements:
|
|
47
225
|
- - ">="
|
|
48
226
|
- !ruby/object:Gem::Version
|
|
49
227
|
version: '0'
|
|
50
228
|
requirements: []
|
|
51
|
-
rubygems_version: 3.
|
|
52
|
-
signing_key:
|
|
229
|
+
rubygems_version: 3.6.9
|
|
53
230
|
specification_version: 4
|
|
54
|
-
summary: Analytics for MCP
|
|
231
|
+
summary: Analytics tool for MCP (Model Context Protocol) servers, Claude Connectors,
|
|
232
|
+
and ChatGPT Plugins
|
|
55
233
|
test_files: []
|