railwatch 0.3.7 → 0.5.0

data/docs/embedded.md

@@ -44,6 +44,17 @@ an embedded install that has one configured still sends nothing.
 fails loudly if you ask for it and it cannot work. `railwatch:export:status`
 shows what is queued.
 
+## Railwatch Cloud runs the same models
+
+The hosted platform is this engine's telemetry layer plus what hosting adds
+(accounts, tokens, quotas, alert routing). It uses `Railwatch::Telemetry::*`,
+`Railwatch::Ingest::Batch`, `Railwatch::Telemetry::Aggregations` and the rest
+directly, with two seams: it tenants `Railwatch::TelemetryRecord` so each
+monitored environment gets its own database, and its `Environment` is an
+account-scoped Active Record row rather than the embedded singleton. Anything
+those models need from an environment is the surface `Railwatch::Environment`
+documents: `id`, `slug`, `name`, `with_telemetry`, and the display attributes.
+
 ## Install
 
 ```sh

data/lib/generators/railwatch/install/install_generator.rb

@@ -119,9 +119,13 @@ module Railwatch
         chmod ".kamal/hooks/post-deploy", 0o755
       end
 
+      # The one browser client, the same file the gem's own dashboard bundle
+      # is built from (Railwatch.browser_client_path). Copied rather than
+      # templated: there is nothing to interpolate, and a copy means the host
+      # sees exactly what the gem tests.
       def create_browser_client
         return unless File.directory?("app/frontend")
-        template "railwatch.ts", "app/frontend/lib/railwatch.ts"
+        copy_file Railwatch.browser_client_path.to_s, "app/frontend/lib/railwatch.ts"
       end
 
       # Adds the import and the call to the Inertia entrypoint, so page-visit

data/lib/railwatch/transport/http.rb

@@ -13,6 +13,16 @@ module Railwatch
     # Reporter owns retention and backoff between calls. A 401 marks the
     # transport unauthorized so no further requests are made.
     class Http
+      # The request headers a delivery carries besides the body. The receiver
+      # reads them by these names; Railwatch Cloud does so through this table.
+      HEADERS = {
+        dropped: "X-Railwatch-Dropped",
+        dropped_bytes: "X-Railwatch-Dropped-Bytes",
+        backpressure_factor: "X-Railwatch-Backpressure-Factor",
+        version: "X-Railwatch-Version",
+        batch_id: "X-Railwatch-Batch-Id"
+      }.freeze
+
       RETRYABLE_STATUSES = [ 402, 408, 429 ].freeze
       UNAUTHORIZED_STATUS = 401
 
@@ -143,17 +153,17 @@ module Railwatch
         headers.each { |name, value| req[name] = value.to_s }
         req["Content-Type"] = "application/x-ndjson"
         req["Content-Encoding"] = "gzip"
-        req["X-Railwatch-Dropped"] = dropped.to_s if dropped.positive?
-        req["X-Railwatch-Dropped-Bytes"] = dropped_bytes.to_s if dropped_bytes.positive?
+        req[HEADERS[:dropped]] = dropped.to_s if dropped.positive?
+        req[HEADERS[:dropped_bytes]] = dropped_bytes.to_s if dropped_bytes.positive?
         if backpressure_factor > 1.0
-          req["X-Railwatch-Backpressure-Factor"] = backpressure_factor.to_s
+          req[HEADERS[:backpressure_factor]] = backpressure_factor.to_s
         end
         # The version this payload was built by, which for a stored delivery is
         # not the version running now. The receiver digests this header, so
         # sending today's value would turn an upgrade into a conflict and
         # destroy a delivery it had already accepted.
-        req["X-Railwatch-Version"] = gem_version
-        req["X-Railwatch-Batch-Id"] = batch_id
+        req[HEADERS[:version]] = gem_version
+        req[HEADERS[:batch_id]] = batch_id
         req.body = body
         request(req)
       end

data/lib/railwatch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Railwatch
-  VERSION = "0.3.7"
+  VERSION = "0.5.0"
 end