aikido-zen 1.9.0.beta.2 → 1.9.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d41298c1b3dc0135c211b4beade2a723603cef96372b5526447e5a0d792d1bb9
-  data.tar.gz: 247dea5c7895db42823c445ce7e0f32995ba833cecbcf7430ad09f33c897c179
+  metadata.gz: ada1cbea91efe8d3351ac604504ce0153797785e1d054fd33838a26afcb5038b
+  data.tar.gz: cedb2ec0153e3604ece81999b7d9c87e32d67554c9544f4e43574fe8f0ea92b0
 SHA512:
-  metadata.gz: ada3f8112966d020346b164380a2cbff9e1ba7c68cfdde2ab2a440d41e1c241c6ef73c9214597fd004e408b61c00ecc9b78294bfd73bef0effd1ca91dbdee5b4
-  data.tar.gz: 7f61d126b05f54339ca7633e8058e36d298dcd0a4b0abf93eebe4abb96a5c66edbf0e56cc3e6457ed92f8cf46231d6f00f60dc5b8487bdd014532db48ef52dba
+  metadata.gz: 833b0e13c05805b86e9060ad6061bc574811347d821139683b3cd0f6d73710f2db7449643075946773d7e0779dc0b1a99c9af7e1abd457d747f81e481ce90721
+  data.tar.gz: ff86f644f5453d99b8acf72cdf76348c5292fa28df03a84fbf174782f5e1498b8a03da7508d4378ab6ac354495f9bef9f91c3698f5081e4f66ad8299341650d8

data/docs/custom-event-tracking.md

@@ -1,6 +1,6 @@
 # Track custom events
 
-Use `Aikido::Zen.track_custom_event` to report events that only your application knows about, such as failed logins. [Playbooks](https://help.aikido.dev/zen-firewall/zen-features/playbooks) can act when an event occurs repeatedly, for example by blocking an IP after three failed logins in five minutes.
+Use `Aikido::Zen.track` to report events that only your application knows about, such as failed logins. [Playbooks](https://help.aikido.dev/zen-firewall/zen-features/playbooks) can act when an event occurs repeatedly, for example by blocking an IP after three failed logins in five minutes.
 
 ```ruby
 # app/controllers/application_controller.rb
@@ -12,7 +12,7 @@ class ApplicationController < ActionController::Base
     # ...
 
     unless current_user
-        Aikido::Zen.track_custom_event("user.login_failed")
+        Aikido::Zen.track("user.login_failed")
         return
     end
 
@@ -21,13 +21,13 @@ class ApplicationController < ActionController::Base
       name: current_user.name
     )
 
-    Aikido::Zen.track_custom_event("user.login_succeeded")
+    Aikido::Zen.track("user.login_succeeded")
   end
 end
 ```
 
-After adding `Aikido::Zen.track_custom_event`, trigger the event at least once. It will then appear on the Playbooks page in the Aikido dashboard. From there, you can create a playbook and choose what should happen when the event occurs. Calling `Aikido::Zen.track_custom_event` by itself does not create a playbook or block anything.
+After adding `Aikido::Zen.track`, trigger the event at least once. It will then appear on the Playbooks page in the Aikido dashboard. From there, you can create a playbook and choose what should happen when the event occurs. Calling `Aikido::Zen.track` by itself does not create a playbook or block anything.
 
-Call `Aikido::Zen.track_custom_event` while handling an HTTP request. Zen associates the event with the request's IP address. Playbook counts are per IP, not across your whole app. If you call [`Aikido::Zen.set_user`](./rails.md#rate-limiting-and-user-blocking) before tracking the event, Zen also includes the current user. `Aikido::Zen.set_user` is optional. Events without a user are still tracked.
+Call `Aikido::Zen.track` while handling an HTTP request. Zen associates the event with the request's IP address. Playbook counts are per IP, not across your whole app. If you call [`Aikido::Zen.set_user`](./rails.md#rate-limiting-and-user-blocking) before tracking the event, Zen also includes the current user. `Aikido::Zen.set_user` is optional. Events without a user are still tracked.
 
 Event names can use any format. We recommend lowercase, dot-separated names such as `user.login_failed`.

data/lib/aikido/zen/agent.rb

@@ -160,7 +160,7 @@ module Aikido::Zen
       end
     end
 
-    # Reports a custom event tracked via Aikido::Zen.track_custom_event, if
+    # Reports a custom event tracked via Aikido::Zen.track, if
     # reporting is enabled.
     #
     # @param event [Aikido::Zen::Events::Custom]

data/lib/aikido/zen/event.rb

@@ -96,7 +96,7 @@ module Aikido::Zen
       end
     end
 
-    # Event sent by Aikido::Zen.track_custom_event to record a custom,
+    # Event sent by Aikido::Zen.track to record a custom,
     # user-named event happening during an HTTP request.
     class Custom < Event
       # @param name [String] the name of the tracked event.
@@ -112,11 +112,14 @@ module Aikido::Zen
       end
 
       def as_json
+        request_json = @request.as_json
+        request_json.delete("url")
+
         super.update(
           {
-            name: @name,
-            request: @request.as_json,
-            user: @user && {id: @user.id, name: @user.name}.compact
+            "name" => @name,
+            "request" => request_json,
+            "user" => @user && {"id" => @user.id, "name" => @user.name}.compact
           }.compact
         )
       end

data/lib/aikido/zen/version.rb

@@ -2,9 +2,9 @@
 
 module Aikido
   module Zen
-    VERSION = "1.9.0.beta.2"
+    VERSION = "1.9.0.beta.3"
 
     # The version of libzen_internals that we build against.
-    LIBZEN_VERSION = "0.1.61"
+    LIBZEN_VERSION = "0.1.74"
   end
 end

data/lib/aikido/zen.rb

@@ -282,14 +282,14 @@ module Aikido
     # a password reset request. Zen automatically attaches the IP address, user
     # agent, and current user (if you called .track_user) from the request.
     #
-    # Only works inside an HTTP request; if called from a background job or
-    # script, nothing gets sent.
+    # Only works inside an HTTP request; the custom event is not reported if
+    # called from a background job or script, or if the request is bypassed.
     #
     # @param name [String]
     # @return [void]
-    def self.track_custom_event(name)
+    def self.track(name)
       unless name.is_a?(String) && !name.empty?
-        config.logger.warn("track_custom_event expects a non-empty String as the event name")
+        config.logger.warn("track expects a non-empty String as the event name")
         return
       end
 
@@ -298,6 +298,8 @@ module Aikido
       context = current_context
       return unless context
 
+      return if request_bypassed?
+
       event = Events::Custom.new(
         name: name,
         request: context.request,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aikido-zen
 version: !ruby/object:Gem::Version
-  version: 1.9.0.beta.2
+  version: 1.9.0.beta.3
 platform: ruby
 authors:
 - Aikido Security
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-24 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby