e11y 0.2.0 → 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.
Files changed (288) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +130 -10
  3. data/CHANGELOG.md +80 -1
  4. data/CLAUDE.md +168 -0
  5. data/CONTRIBUTING.md +640 -0
  6. data/README.md +165 -701
  7. data/RELEASE.md +41 -12
  8. data/Rakefile +249 -57
  9. data/config/README.md +1 -1
  10. data/config/loki-local-config.yaml +12 -0
  11. data/config/otel-collector-config.yaml +44 -0
  12. data/cucumber.yml +1 -0
  13. data/docker-compose.yml +18 -2
  14. data/docs/ADAPTERS.md +76 -0
  15. data/docs/ADAPTIVE_SAMPLING.md +59 -0
  16. data/docs/COMPARISON.md +104 -0
  17. data/docs/CONFIGURATION.md +52 -0
  18. data/docs/DISTRIBUTED_TRACING.md +44 -0
  19. data/docs/LIMITATIONS.md +13 -0
  20. data/docs/METRICS_DSL.md +84 -0
  21. data/docs/PERFORMANCE.md +60 -0
  22. data/docs/PII_FILTERING.md +40 -0
  23. data/docs/PRESETS.md +65 -0
  24. data/docs/QUICK-START.md +546 -587
  25. data/docs/RAILS_INTEGRATION.md +79 -0
  26. data/docs/SCHEMA_VALIDATION.md +63 -0
  27. data/docs/SLO-PROMQL-ALERTS.md +161 -0
  28. data/docs/TESTING.md +69 -0
  29. data/docs/{ADR-001-architecture.md → architecture/ADR-001-architecture.md} +36 -65
  30. data/docs/{ADR-002-metrics-yabeda.md → architecture/ADR-002-metrics-yabeda.md} +62 -236
  31. data/docs/architecture/ADR-003-slo-observability.md +1402 -0
  32. data/docs/{ADR-004-adapter-architecture.md → architecture/ADR-004-adapter-architecture.md} +163 -146
  33. data/docs/{ADR-005-tracing-context.md → architecture/ADR-005-tracing-context.md} +10 -9
  34. data/docs/{ADR-006-security-compliance.md → architecture/ADR-006-security-compliance.md} +184 -191
  35. data/docs/{ADR-007-opentelemetry-integration.md → architecture/ADR-007-opentelemetry-integration.md} +3 -21
  36. data/docs/{ADR-008-rails-integration.md → architecture/ADR-008-rails-integration.md} +182 -743
  37. data/docs/{ADR-009-cost-optimization.md → architecture/ADR-009-cost-optimization.md} +45 -54
  38. data/docs/architecture/ADR-010-developer-experience.md +522 -0
  39. data/docs/{ADR-011-testing-strategy.md → architecture/ADR-011-testing-strategy.md} +44 -86
  40. data/docs/{ADR-012-event-evolution.md → architecture/ADR-012-event-evolution.md} +11 -11
  41. data/docs/{ADR-013-reliability-error-handling.md → architecture/ADR-013-reliability-error-handling.md} +37 -12
  42. data/docs/{ADR-014-event-driven-slo.md → architecture/ADR-014-event-driven-slo.md} +12 -24
  43. data/docs/{ADR-015-middleware-order.md → architecture/ADR-015-middleware-order.md} +43 -59
  44. data/docs/{ADR-016-self-monitoring-slo.md → architecture/ADR-016-self-monitoring-slo.md} +58 -355
  45. data/docs/{ADR-017-multi-rails-compatibility.md → architecture/ADR-017-multi-rails-compatibility.md} +4 -11
  46. data/docs/architecture/ADR-018-memory-optimization.md +366 -0
  47. data/docs/{ADR-INDEX.md → architecture/ADR-INDEX.md} +11 -6
  48. data/docs/plans/2026-03-20-browser-overlay-svelte.md +281 -0
  49. data/docs/{00-ICP-AND-TIMELINE.md → prd/00-ICP-AND-TIMELINE.md} +6 -6
  50. data/docs/{01-SCALE-REQUIREMENTS.md → prd/01-SCALE-REQUIREMENTS.md} +6 -6
  51. data/docs/prd/01-overview-vision.md +19 -14
  52. data/docs/use_cases/README.md +22 -23
  53. data/docs/use_cases/UC-001-request-scoped-debug-buffering.md +50 -44
  54. data/docs/use_cases/UC-002-business-event-tracking.md +26 -95
  55. data/docs/use_cases/UC-003-event-metrics.md +66 -0
  56. data/docs/use_cases/UC-004-zero-config-slo-tracking.md +33 -684
  57. data/docs/use_cases/UC-005-sentry-integration.md +13 -15
  58. data/docs/use_cases/UC-006-trace-context-management.md +30 -28
  59. data/docs/use_cases/UC-007-pii-filtering.md +35 -87
  60. data/docs/use_cases/UC-008-opentelemetry-integration.md +51 -89
  61. data/docs/use_cases/UC-009-multi-service-tracing.md +30 -178
  62. data/docs/use_cases/UC-010-background-job-tracking.md +24 -91
  63. data/docs/use_cases/UC-011-rate-limiting.md +95 -168
  64. data/docs/use_cases/UC-012-audit-trail.md +21 -46
  65. data/docs/use_cases/UC-013-high-cardinality-protection.md +29 -167
  66. data/docs/use_cases/UC-014-adaptive-sampling.md +2 -2
  67. data/docs/use_cases/UC-015-cost-optimization.md +46 -99
  68. data/docs/use_cases/UC-016-rails-logger-migration.md +39 -213
  69. data/docs/use_cases/UC-017-local-development.md +203 -777
  70. data/docs/use_cases/UC-018-testing-events.md +3 -3
  71. data/docs/use_cases/UC-019-retention-based-routing.md +53 -106
  72. data/docs/use_cases/UC-020-event-versioning.md +8 -9
  73. data/docs/use_cases/UC-021-error-handling-retry-dlq.md +18 -22
  74. data/docs/use_cases/UC-022-event-registry.md +15 -21
  75. data/docs/use_cases/backlog.md +119 -87
  76. data/e11y.gemspec +2 -2
  77. data/gems/e11y-devtools/README.md +158 -0
  78. data/gems/e11y-devtools/config/routes.rb +15 -0
  79. data/gems/e11y-devtools/e11y-devtools.gemspec +25 -0
  80. data/gems/e11y-devtools/exe/e11y +34 -0
  81. data/gems/e11y-devtools/frontend/.gitignore +24 -0
  82. data/gems/e11y-devtools/frontend/README.md +51 -0
  83. data/gems/e11y-devtools/frontend/index.html +14 -0
  84. data/gems/e11y-devtools/frontend/package-lock.json +3707 -0
  85. data/gems/e11y-devtools/frontend/package.json +28 -0
  86. data/gems/e11y-devtools/frontend/public/mocks/v1/events/recent.json +4205 -0
  87. data/gems/e11y-devtools/frontend/public/mocks/v1/interactions.json +194 -0
  88. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/0a2e04027cfa22d014bc22e8b27cd913/events.json +86 -0
  89. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/0e1543af6a630fb3af6b52283154b3e0/events.json +169 -0
  90. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/1838b691faa49564f97db8592ff3978d/events.json +78 -0
  91. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/29f198f6588dacffb687777eb5f8f118/events.json +197 -0
  92. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/34bc3c9c0097de28a7a6f99b90a8e7bc/events.json +194 -0
  93. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/3ba6c20d068ab9cee00e51b180e66444/events.json +184 -0
  94. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/435bfd8f17b9009146a79812d7c3726d/events.json +144 -0
  95. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/4c7676e3fe668e99edb2b94d7d5678a9/events.json +222 -0
  96. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/6daf0d47974bedfc55d5de7004a3ea9f/events.json +194 -0
  97. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/8a81ada42834d15f287bb40010043605/events.json +194 -0
  98. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/8c0a98900edaae105469df8daedccf02/events.json +198 -0
  99. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/8e4f645180f8a7d1dce426b07380466b/events.json +222 -0
  100. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/93db346fa5d44a032605a13b627f4b80/events.json +128 -0
  101. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/98ff6146faf7bd9be8bd03a8275817ba/events.json +223 -0
  102. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/9997ddd0247bc7e25f2ca7a5c415c93d/events.json +197 -0
  103. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/99e35f8ef3baedd798cc4fd085980ad9/events.json +194 -0
  104. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/b4f3095c1909924cbc98889a86c83d6d/events.json +131 -0
  105. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/b54b7fc32b7575a7110de809d11ccda0/events.json +128 -0
  106. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/c0b48033fa06746bcc5886745e053cff/events.json +169 -0
  107. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/c44649ac76701b4558927cd2305ab535/events.json +169 -0
  108. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/d601ae3320057580a39dbdac2edfdf4a/events.json +248 -0
  109. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/e67e724bab422d2b52eeb49635e512e1/events.json +194 -0
  110. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/e6c72765a28f158a8485b35fa63f73da/events.json +194 -0
  111. data/gems/e11y-devtools/frontend/public/mocks/v1/traces/f541b87405c9a54819b18ebe529f6419/events.json +194 -0
  112. data/gems/e11y-devtools/frontend/scripts/generate_mocks.rb +397 -0
  113. data/gems/e11y-devtools/frontend/src/App.svelte +827 -0
  114. data/gems/e11y-devtools/frontend/src/components/Fab.svelte +19 -0
  115. data/gems/e11y-devtools/frontend/src/components/FilterBar.svelte +38 -0
  116. data/gems/e11y-devtools/frontend/src/components/FullscreenPanel.svelte +82 -0
  117. data/gems/e11y-devtools/frontend/src/components/InteractionsTimeline.svelte +264 -0
  118. data/gems/e11y-devtools/frontend/src/components/RecentHistogram.svelte +354 -0
  119. data/gems/e11y-devtools/frontend/src/lib/api.ts +37 -0
  120. data/gems/e11y-devtools/frontend/src/lib/eventIdentity.ts +12 -0
  121. data/gems/e11y-devtools/frontend/src/lib/format.ts +37 -0
  122. data/gems/e11y-devtools/frontend/src/lib/listFilter.ts +43 -0
  123. data/gems/e11y-devtools/frontend/src/lib/recentVolume.ts +80 -0
  124. data/gems/e11y-devtools/frontend/src/lib/router.ts +12 -0
  125. data/gems/e11y-devtools/frontend/src/lib/transitions.ts +34 -0
  126. data/gems/e11y-devtools/frontend/src/lib/viewportOrigin.ts +25 -0
  127. data/gems/e11y-devtools/frontend/src/main.ts +8 -0
  128. data/gems/e11y-devtools/frontend/src/overlay-entry.ts +24 -0
  129. data/gems/e11y-devtools/frontend/src/overlay.css +1080 -0
  130. data/gems/e11y-devtools/frontend/svelte.config.js +2 -0
  131. data/gems/e11y-devtools/frontend/test_puppeteer.js +41 -0
  132. data/gems/e11y-devtools/frontend/test_scale.js +3 -0
  133. data/gems/e11y-devtools/frontend/tsconfig.app.json +21 -0
  134. data/gems/e11y-devtools/frontend/tsconfig.json +7 -0
  135. data/gems/e11y-devtools/frontend/tsconfig.node.json +26 -0
  136. data/gems/e11y-devtools/frontend/vite.config.ts +36 -0
  137. data/gems/e11y-devtools/lib/e11y/devtools/mcp/server.rb +96 -0
  138. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tool_base.rb +25 -0
  139. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/clear.rb +31 -0
  140. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/errors.rb +35 -0
  141. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/event_detail.rb +33 -0
  142. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/events_by_trace.rb +33 -0
  143. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/interactions.rb +40 -0
  144. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/recent_events.rb +34 -0
  145. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/search.rb +34 -0
  146. data/gems/e11y-devtools/lib/e11y/devtools/mcp/tools/stats.rb +30 -0
  147. data/gems/e11y-devtools/lib/e11y/devtools/overlay/assets/overlay.js +20 -0
  148. data/gems/e11y-devtools/lib/e11y/devtools/overlay/controller.rb +94 -0
  149. data/gems/e11y-devtools/lib/e11y/devtools/overlay/engine.rb +26 -0
  150. data/gems/e11y-devtools/lib/e11y/devtools/overlay/middleware.rb +80 -0
  151. data/gems/e11y-devtools/lib/e11y/devtools/overlay/rails_controller.rb +67 -0
  152. data/gems/e11y-devtools/lib/e11y/devtools/tui/app.rb +262 -0
  153. data/gems/e11y-devtools/lib/e11y/devtools/tui/grouping.rb +66 -0
  154. data/gems/e11y-devtools/lib/e11y/devtools/tui/widgets/event_detail.rb +62 -0
  155. data/gems/e11y-devtools/lib/e11y/devtools/tui/widgets/event_list.rb +70 -0
  156. data/gems/e11y-devtools/lib/e11y/devtools/tui/widgets/interaction_list.rb +47 -0
  157. data/gems/e11y-devtools/lib/e11y/devtools/version.rb +8 -0
  158. data/gems/e11y-devtools/lib/e11y/devtools.rb +13 -0
  159. data/gems/e11y-devtools/spec/e11y/devtools/mcp/tools_spec.rb +107 -0
  160. data/gems/e11y-devtools/spec/e11y/devtools/overlay/controller_spec.rb +91 -0
  161. data/gems/e11y-devtools/spec/e11y/devtools/overlay/middleware_spec.rb +46 -0
  162. data/gems/e11y-devtools/spec/e11y/devtools/tui/app_spec.rb +85 -0
  163. data/gems/e11y-devtools/spec/e11y/devtools/tui/grouping_spec.rb +64 -0
  164. data/gems/e11y-devtools/spec/spec_helper.rb +5 -0
  165. data/gems/e11y-devtools/spec/tui/widgets/event_list_spec.rb +44 -0
  166. data/gems/e11y-devtools/spec/tui/widgets/interaction_list_spec.rb +62 -0
  167. data/lib/e11y/adapters/audit_encrypted.rb +53 -11
  168. data/lib/e11y/adapters/base.rb +33 -34
  169. data/lib/e11y/adapters/dev_log/file_store.rb +143 -0
  170. data/lib/e11y/adapters/dev_log/query.rb +219 -0
  171. data/lib/e11y/adapters/dev_log.rb +118 -0
  172. data/lib/e11y/adapters/file.rb +3 -6
  173. data/lib/e11y/adapters/in_memory.rb +52 -5
  174. data/lib/e11y/adapters/in_memory_test.rb +29 -0
  175. data/lib/e11y/adapters/loki.rb +58 -23
  176. data/lib/e11y/adapters/null.rb +82 -0
  177. data/lib/e11y/adapters/opentelemetry_collector.rb +183 -0
  178. data/lib/e11y/adapters/otel_logs.rb +136 -23
  179. data/lib/e11y/adapters/sentry.rb +4 -7
  180. data/lib/e11y/adapters/stdout.rb +73 -7
  181. data/lib/e11y/adapters/yabeda.rb +153 -29
  182. data/lib/e11y/buffers/adaptive_buffer.rb +3 -17
  183. data/lib/e11y/buffers/{request_scoped_buffer.rb → ephemeral_buffer.rb} +72 -58
  184. data/lib/e11y/buffers/ring_buffer.rb +3 -16
  185. data/lib/e11y/configuration.rb +272 -0
  186. data/lib/e11y/console.rb +10 -17
  187. data/lib/e11y/current.rb +53 -1
  188. data/lib/e11y/debug/pipeline_inspector.rb +96 -0
  189. data/lib/e11y/documentation/generator.rb +48 -0
  190. data/lib/e11y/event/base.rb +176 -82
  191. data/lib/e11y/event/value_sampling_config.rb +1 -5
  192. data/lib/e11y/events/rails/database/query.rb +1 -4
  193. data/lib/e11y/events/rails/job/failed.rb +2 -0
  194. data/lib/e11y/instruments/active_job.rb +44 -12
  195. data/lib/e11y/instruments/rails_instrumentation.rb +49 -24
  196. data/lib/e11y/instruments/sidekiq.rb +135 -31
  197. data/lib/e11y/linters/base.rb +11 -0
  198. data/lib/e11y/linters/pii/pii_declaration_linter.rb +120 -0
  199. data/lib/e11y/linters/slo/config_consistency_linter.rb +76 -0
  200. data/lib/e11y/linters/slo/explicit_declaration_linter.rb +36 -0
  201. data/lib/e11y/linters/slo/slo_status_from_linter.rb +41 -0
  202. data/lib/e11y/logger/bridge.rb +26 -7
  203. data/lib/e11y/metrics/cardinality_protection.rb +10 -15
  204. data/lib/e11y/metrics/cardinality_tracker.rb +16 -6
  205. data/lib/e11y/metrics/registry.rb +3 -5
  206. data/lib/e11y/metrics/test_backend.rb +62 -0
  207. data/lib/e11y/metrics.rb +56 -10
  208. data/lib/e11y/middleware/adapter_resolver.rb +40 -0
  209. data/lib/e11y/middleware/audit_signing.rb +43 -6
  210. data/lib/e11y/middleware/baggage_protection.rb +75 -0
  211. data/lib/e11y/middleware/dev_log_source.rb +24 -0
  212. data/lib/e11y/middleware/event_slo.rb +23 -9
  213. data/lib/e11y/middleware/otel_span.rb +23 -0
  214. data/lib/e11y/middleware/pii_filter.rb +104 -75
  215. data/lib/e11y/middleware/rate_limiting.rb +54 -27
  216. data/lib/e11y/middleware/request.rb +70 -23
  217. data/lib/e11y/middleware/routing.rb +78 -21
  218. data/lib/e11y/middleware/sampling.rb +66 -17
  219. data/lib/e11y/middleware/self_monitoring_emit.rb +39 -0
  220. data/lib/e11y/middleware/trace_context.rb +45 -10
  221. data/lib/e11y/middleware/track_latency.rb +34 -0
  222. data/lib/e11y/middleware/validation.rb +7 -16
  223. data/lib/e11y/middleware/versioning.rb +26 -22
  224. data/lib/e11y/opentelemetry/semantic_conventions.rb +109 -0
  225. data/lib/e11y/opentelemetry/span_creator.rb +142 -0
  226. data/lib/e11y/pii/patterns.rb +12 -1
  227. data/lib/e11y/pipeline/builder.rb +4 -4
  228. data/lib/e11y/presets/audit_event.rb +13 -2
  229. data/lib/e11y/railtie.rb +52 -14
  230. data/lib/e11y/registry.rb +306 -0
  231. data/lib/e11y/reliability/circuit_breaker.rb +19 -21
  232. data/lib/e11y/reliability/dlq/base.rb +71 -0
  233. data/lib/e11y/reliability/dlq/file_adapter.rb +301 -0
  234. data/lib/e11y/reliability/dlq/file_storage.rb +63 -34
  235. data/lib/e11y/reliability/dlq/filter.rb +37 -54
  236. data/lib/e11y/reliability/retry_handler.rb +26 -29
  237. data/lib/e11y/reliability/retry_rate_limiter.rb +3 -11
  238. data/lib/e11y/sampling/error_spike_detector.rb +0 -2
  239. data/lib/e11y/sampling/load_monitor.rb +5 -9
  240. data/lib/e11y/sampling/stratified_tracker.rb +18 -0
  241. data/lib/e11y/self_monitoring/buffer_monitor.rb +2 -0
  242. data/lib/e11y/self_monitoring/performance_monitor.rb +19 -61
  243. data/lib/e11y/self_monitoring/reliability_monitor.rb +4 -74
  244. data/lib/e11y/slo/config_loader.rb +40 -0
  245. data/lib/e11y/slo/config_validator.rb +58 -0
  246. data/lib/e11y/slo/dashboard_generator.rb +122 -0
  247. data/lib/e11y/slo/event_driven.rb +8 -0
  248. data/lib/e11y/slo/tracker.rb +31 -4
  249. data/lib/e11y/testing/have_tracked_event_matcher.rb +190 -0
  250. data/lib/e11y/testing/rspec_matchers.rb +21 -0
  251. data/lib/e11y/testing/snapshot_matcher.rb +86 -0
  252. data/lib/e11y/trace_context/sampler.rb +35 -0
  253. data/lib/e11y/tracing/faraday_middleware.rb +31 -0
  254. data/lib/e11y/tracing/net_http_patch.rb +33 -0
  255. data/lib/e11y/tracing/propagator.rb +144 -0
  256. data/lib/e11y/tracing.rb +47 -0
  257. data/lib/e11y/version.rb +1 -1
  258. data/lib/e11y/versioning/version_extractor.rb +32 -0
  259. data/lib/e11y.rb +123 -266
  260. data/lib/generators/e11y/event/event_generator.rb +22 -0
  261. data/lib/generators/e11y/event/templates/event.rb.tt +16 -0
  262. data/lib/generators/e11y/grafana_dashboard/grafana_dashboard_generator.rb +30 -0
  263. data/lib/generators/e11y/grafana_dashboard/templates/e11y_dashboard.json +81 -0
  264. data/lib/generators/e11y/install/install_generator.rb +34 -0
  265. data/lib/generators/e11y/install/templates/e11y.rb +239 -0
  266. data/lib/generators/e11y/prometheus_alerts/prometheus_alerts_generator.rb +29 -0
  267. data/lib/generators/e11y/prometheus_alerts/templates/e11y_alerts.yml +28 -0
  268. data/lib/tasks/e11y_docs.rake +30 -0
  269. data/lib/tasks/e11y_events.rake +71 -0
  270. data/lib/tasks/e11y_lint.rake +91 -0
  271. data/lib/tasks/e11y_slo.rake +29 -0
  272. metadata +186 -39
  273. data/docs/ADR-003-slo-observability.md +0 -3337
  274. data/docs/ADR-010-developer-experience.md +0 -2166
  275. data/docs/API-REFERENCE-L28.md +0 -914
  276. data/docs/COMPREHENSIVE-CONFIGURATION.md +0 -2366
  277. data/docs/CONTRIBUTING.md +0 -312
  278. data/docs/IMPLEMENTATION_NOTES.md +0 -2804
  279. data/docs/IMPLEMENTATION_PLAN.md +0 -1971
  280. data/docs/IMPLEMENTATION_PLAN_ARCHITECTURE.md +0 -586
  281. data/docs/PLAN.md +0 -148
  282. data/docs/README.md +0 -296
  283. data/docs/design/00-memory-optimization.md +0 -593
  284. data/docs/guides/MIGRATION-L27-L28.md +0 -692
  285. data/docs/guides/PERFORMANCE-BENCHMARKS.md +0 -434
  286. data/docs/guides/README.md +0 -44
  287. data/docs/use_cases/UC-003-pattern-based-metrics.md +0 -1627
  288. data/lib/e11y/adapters/registry.rb +0 -141
@@ -0,0 +1,397 @@
1
+ # frozen_string_literal: true
2
+ # rubocop:disable all
3
+ # Dev-only fixture generator; kept verbose for readability.
4
+
5
+ # Regenerates public/mocks/v1/*.json with a large, realistic event set.
6
+ # Deterministic (Random.new(42)). Run:
7
+ # ruby scripts/generate_mocks.rb
8
+ # E11Y_MOCK_TRACES=52 ruby scripts/generate_mocks.rb # more traces / events
9
+ #
10
+ # Mimics DevLog::Query interaction grouping (500ms window).
11
+
12
+ require "digest"
13
+ require "fileutils"
14
+ require "json"
15
+ require "time"
16
+
17
+ MOCKS = File.expand_path("../public/mocks/v1", __dir__)
18
+ TRACES_DIR = File.join(MOCKS, "traces")
19
+
20
+ PATHS = %w[
21
+ /up /checkout /orders /orders/new /api/v1/me /api/v1/orders /admin/users
22
+ /webhooks/stripe /internal/health /graphql /sidekiq/busy
23
+ ].freeze
24
+
25
+ CONTROLLERS = [
26
+ ["CheckoutController", "show"],
27
+ ["OrdersController", "index"],
28
+ ["OrdersController", "create"],
29
+ ["Orders::PaymentsController", "create"],
30
+ ["Api::V1::MeController", "show"],
31
+ ["Admin::UsersController", "index"],
32
+ ["Webhooks::StripeController", "create"],
33
+ ["GraphqlController", "execute"]
34
+ ].freeze
35
+
36
+ JOB_CLASSES = %w[
37
+ ReportExportJob NotificationDispatcherJob SearchIndexJob
38
+ BillingSyncJob WebhookRetryJob CacheWarmJob
39
+ ].freeze
40
+
41
+ def uuid4(rng)
42
+ format("%08x-4%03x-%04x-%012x",
43
+ rng.rand(0xFFFFFFFF), rng.rand(0x1000),
44
+ rng.rand(0x4000) + 0x8000,
45
+ rng.rand(0x1000000000000))
46
+ end
47
+
48
+ def span16(rng)
49
+ format("%016x", rng.rand(0x1_0000_0000_0000_0000))
50
+ end
51
+
52
+ def trace_id32(i)
53
+ Digest::SHA256.hexdigest("e11y-overlay-mock-tr-#{i}")[0, 32]
54
+ end
55
+
56
+ def snake_case_class(name)
57
+ base = name.split("::").last
58
+ base.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
59
+ .gsub(/([a-z\d])([A-Z])/, '\1_\2')
60
+ .tr("-", "_")
61
+ .downcase
62
+ end
63
+
64
+ def iso(t)
65
+ t.utc.iso8601(3)
66
+ end
67
+
68
+ def retention_iso(ts_str)
69
+ (Time.parse(ts_str) + (365 * 86_400)).iso8601
70
+ end
71
+
72
+ def parse_started_at(event)
73
+ Time.parse(event.dig("metadata", "started_at") || event["timestamp"])
74
+ rescue ArgumentError, TypeError
75
+ nil
76
+ end
77
+
78
+ def build_interaction_rows(all_events, window_ms: 500, limit: 200)
79
+ trace_map = {}
80
+ all_events.each do |e|
81
+ tid = e["trace_id"]
82
+ next unless tid
83
+
84
+ started = parse_started_at(e)
85
+ next unless started
86
+
87
+ source = e.dig("metadata", "source") || "web"
88
+ entry = trace_map[tid] ||= { started_at: started, has_error: false, source: source }
89
+ entry[:has_error] = true if %w[error fatal].include?(e["severity"])
90
+ entry[:started_at] = started if started < entry[:started_at]
91
+ end
92
+
93
+ sorted = trace_map.sort_by { |_, v| v[:started_at] }
94
+ groups = []
95
+ current = nil
96
+
97
+ sorted.each do |trace_id, meta|
98
+ if current.nil? || ((meta[:started_at] - current[:last_started_at]) * 1000 > window_ms)
99
+ current = {
100
+ started_at: meta[:started_at],
101
+ last_started_at: meta[:started_at],
102
+ trace_ids: [],
103
+ has_error: false,
104
+ source: meta[:source]
105
+ }
106
+ groups << current
107
+ end
108
+ current[:trace_ids] << trace_id
109
+ current[:has_error] ||= meta[:has_error]
110
+ current[:last_started_at] = meta[:started_at]
111
+ end
112
+
113
+ groups.last(limit).reverse.map do |grp|
114
+ {
115
+ "started_at" => grp[:started_at].utc.iso8601(3),
116
+ "trace_ids" => grp[:trace_ids],
117
+ "has_error" => grp[:has_error],
118
+ "source" => grp[:source],
119
+ "traces_count" => grp[:trace_ids].size
120
+ }
121
+ end
122
+ end
123
+
124
+ def build_web_trace_events(rng, trace_id:, req_id:, path:, method:, controller:, action:, started:, order_id:)
125
+ base_meta = lambda do |extra = {}|
126
+ {
127
+ "source" => "web",
128
+ "started_at" => iso(started),
129
+ "request_id" => req_id,
130
+ "path" => path,
131
+ "method" => method,
132
+ "controller" => controller,
133
+ "action" => action,
134
+ "duration_ms" => rng.rand(1..120)
135
+ }.merge(extra)
136
+ end
137
+
138
+ offset = 0.0
139
+ bump = -> { offset += (0.010 + (rng.rand * 0.006)); started + offset }
140
+
141
+ evs = []
142
+ t = bump.call
143
+ evs << {
144
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::LogInfo",
145
+ "severity" => "info", "version" => 1, "trace_id" => trace_id,
146
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
147
+ "retention_until" => retention_iso(iso(t)),
148
+ "payload" => {
149
+ "message" => "Started #{method} \"#{path}\" for ::1 at #{t.strftime('%Y-%m-%d %H:%M:%S')} +0000",
150
+ "level" => "info"
151
+ },
152
+ "metadata" => base_meta.call("duration_ms" => rng.rand(0..3))
153
+ }
154
+
155
+ t = bump.call
156
+ ok = rng.rand > 0.08
157
+ evs << {
158
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::ApiRequest",
159
+ "severity" => ok ? "info" : "warn", "version" => 1, "trace_id" => trace_id,
160
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
161
+ "retention_until" => retention_iso(iso(t)),
162
+ "payload" => {
163
+ "endpoint" => "#{method} #{path}",
164
+ "status" => ok ? "ok" : "slow",
165
+ "http_status" => ok ? 200 : 429
166
+ },
167
+ "metadata" => base_meta.call
168
+ }
169
+
170
+ if rng.rand < 0.65
171
+ t = bump.call
172
+ evs << {
173
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::PostDebug",
174
+ "severity" => "debug", "version" => 1, "trace_id" => trace_id,
175
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
176
+ "retention_until" => retention_iso(iso(t)),
177
+ "payload" => {
178
+ "message" => " \u2192 #{['CACHE', 'SQL', 'Render'].sample(random: rng)} #{path} — #{rng.rand(1..48)}.#{rng.rand(0..9)}ms"
179
+ },
180
+ "metadata" => base_meta.call("duration_ms" => rng.rand(1..8))
181
+ }
182
+ end
183
+
184
+ extra = rng.rand(1..3)
185
+ extra.times do
186
+ t = bump.call
187
+ evs << {
188
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::PostDebug",
189
+ "severity" => "debug", "version" => 1, "trace_id" => trace_id,
190
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
191
+ "retention_until" => retention_iso(iso(t)),
192
+ "payload" => {
193
+ "message" => " \u2192 #{['CACHE', 'SQL', 'Render', 'N+1'].sample(random: rng)} — #{path} id=#{rng.rand(1..50_000)}"
194
+ },
195
+ "metadata" => base_meta.call("duration_ms" => rng.rand(1..25))
196
+ }
197
+ end
198
+
199
+ if path != "/up"
200
+ t = bump.call
201
+ evs << {
202
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::OrderCreated",
203
+ "severity" => "success", "version" => 1, "trace_id" => trace_id,
204
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
205
+ "retention_until" => retention_iso(iso(t)),
206
+ "payload" => {
207
+ "order_id" => order_id,
208
+ "status" => %w[pending_payment completed cancelled].sample(random: rng),
209
+ "customer" => { "id" => rng.rand(1..10_000), "email" => "[FILTERED]", "locale" => "en" },
210
+ "items" => [
211
+ { "sku" => "SKU-#{rng.rand(100..999)}", "qty" => 1, "unit_price" => rng.rand(5.0..499.0).round(2) }
212
+ ]
213
+ },
214
+ "metadata" => base_meta.call
215
+ }
216
+ end
217
+
218
+ if rng.rand < 0.14
219
+ t = bump.call
220
+ evs << {
221
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::PaymentFailed",
222
+ "severity" => "error", "version" => 1, "trace_id" => trace_id,
223
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
224
+ "retention_until" => retention_iso(iso(t)),
225
+ "payload" => {
226
+ "order_id" => order_id,
227
+ "amount" => rng.rand(10.0..500.0).round(2),
228
+ "gateway" => "stripe",
229
+ "decline_code" => %w[insufficient_funds expired_card processing_error].sample(random: rng)
230
+ },
231
+ "metadata" => base_meta.call
232
+ }
233
+ elsif rng.rand < 0.22
234
+ t = bump.call
235
+ evs << {
236
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::UserAction",
237
+ "severity" => "warn", "version" => 1, "trace_id" => trace_id,
238
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
239
+ "retention_until" => retention_iso(iso(t)),
240
+ "payload" => { "action" => "checkout_step", "step" => "review", "flags" => ["rate_limit_near"] },
241
+ "metadata" => base_meta.call
242
+ }
243
+ end
244
+
245
+ t = bump.call
246
+ evs << {
247
+ "id" => uuid4(rng), "timestamp" => iso(t), "event_name" => "Events::LogInfo",
248
+ "severity" => "info", "version" => 1, "trace_id" => trace_id,
249
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
250
+ "retention_until" => retention_iso(iso(t)),
251
+ "payload" => { "message" => "Completed #{method} #{path} in #{rng.rand(12..890)}ms", "level" => "info" },
252
+ "metadata" => base_meta.call("duration_ms" => rng.rand(8..200))
253
+ }
254
+
255
+ evs
256
+ end
257
+
258
+ def job_event_bundle(rng, trace_id:, started:, idx:, job_class:, jid:)
259
+ t = started + (idx * 0.55) + (rng.rand * 0.08)
260
+ ts = iso(t)
261
+ base_meta = { "source" => "job", "started_at" => iso(started), "duration_ms" => rng.rand(2..900) }
262
+
263
+ case idx
264
+ when 0
265
+ {
266
+ "id" => uuid4(rng), "timestamp" => ts, "event_name" => "Events::BackgroundJobStarted",
267
+ "severity" => "info", "version" => 1, "trace_id" => trace_id,
268
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
269
+ "retention_until" => retention_iso(ts),
270
+ "payload" => {
271
+ "job_class" => job_class,
272
+ "job_id" => jid,
273
+ "queue" => %w[default critical low].sample(random: rng),
274
+ "arguments" => [{ "batch_id" => rng.rand(1..99_999), "shard" => rng.rand(0..15) }],
275
+ "enqueued_at" => iso(started - rng.rand(0..3))
276
+ },
277
+ "metadata" => base_meta
278
+ }
279
+ when 1
280
+ {
281
+ "id" => uuid4(rng), "timestamp" => ts, "event_name" => "Events::ReportCreated",
282
+ "severity" => "info", "version" => 1, "trace_id" => trace_id,
283
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
284
+ "retention_until" => retention_iso(ts),
285
+ "payload" => {
286
+ "title" => "Export batch #{rng.rand(1000..9999)}",
287
+ "description" => "Queued by #{job_class}",
288
+ "employee_ids" => [rng.rand(1..200), rng.rand(1..200)].uniq,
289
+ "author" => "system"
290
+ },
291
+ "metadata" => base_meta
292
+ }
293
+ else
294
+ fatal = rng.rand < 0.09
295
+ {
296
+ "id" => uuid4(rng), "timestamp" => ts,
297
+ "event_name" => fatal ? "Events::ReportExportCompleted" : "Events::LogInfo",
298
+ "severity" => fatal ? "fatal" : "info",
299
+ "version" => 1, "trace_id" => trace_id,
300
+ "span_id" => span16(rng), "service_name" => "dummy", "environment" => "development",
301
+ "retention_until" => retention_iso(ts),
302
+ "payload" => if fatal
303
+ {
304
+ "report_id" => rng.rand(1000..9999),
305
+ "error" => "No space left on device",
306
+ "exception" => {
307
+ "class" => "Errno::ENOSPC",
308
+ "message" => "No space left on device @ rb_sysopen",
309
+ "backtrace" => [
310
+ "app/jobs/#{snake_case_class(job_class)}.rb:#{rng.rand(20..120)}:in `perform'",
311
+ "activejob (#{rng.rand(6..8)}.#{rng.rand(0..2)}.0) lib/active_job/execution.rb:68:in `perform_now'"
312
+ ]
313
+ }
314
+ }
315
+ else
316
+ { "message" => "Job #{job_class} done shard=#{rng.rand(0..15)}", "level" => "info" }
317
+ end,
318
+ "metadata" => base_meta
319
+ }
320
+ end
321
+ end
322
+
323
+ def generate
324
+ rng = Random.new(42)
325
+ base = Time.utc(2026, 3, 20, 9, 47, 12)
326
+ elapsed_ms = 0
327
+ all = []
328
+ traces = {} # trace_id => [events chrono]
329
+
330
+ # Scale: ~24 traces → ~150 events (~10× the original 15-event fixture). Increase `num_traces` for more.
331
+ num_traces = Integer(ENV.fetch("E11Y_MOCK_TRACES", "24"), 10)
332
+ num_traces.times do |i|
333
+ tid = trace_id32(i)
334
+ # Cluster some starts within 400ms for multi-trace interactions
335
+ burst = (i % 11).zero? ? rng.rand(80..420) : rng.rand(350..2400)
336
+ elapsed_ms += burst
337
+ started = base + (elapsed_ms / 1000.0)
338
+
339
+ if (i % 7).zero?
340
+ job_class = JOB_CLASSES.sample(random: rng)
341
+ jid = uuid4(rng)
342
+ events = []
343
+ n = 3 + rng.rand(0..2)
344
+ n.times do |j|
345
+ ev = job_event_bundle(rng, trace_id: tid, started: started, idx: j, job_class: job_class, jid: jid)
346
+ events << ev if ev
347
+ end
348
+ else
349
+ path = PATHS.sample(random: rng)
350
+ method = if path == "/webhooks/stripe" || path == "/graphql"
351
+ "POST"
352
+ else
353
+ "GET"
354
+ end
355
+ pair = CONTROLLERS.sample(random: rng)
356
+ req_id = "req-#{tid[0, 8]}-#{i}"
357
+ order_id = format("ord_%06d", rng.rand(1..999_999))
358
+ events = build_web_trace_events(
359
+ rng,
360
+ trace_id: tid,
361
+ req_id: req_id,
362
+ path: path,
363
+ method: method,
364
+ controller: pair[0],
365
+ action: pair[1],
366
+ started: started,
367
+ order_id: order_id
368
+ )
369
+ end
370
+
371
+ # Ensure chronological order within trace
372
+ events.compact!
373
+ events.sort_by! { |e| Time.parse(e["timestamp"]) }
374
+ events.each { |e| all << e }
375
+ traces[tid] = events
376
+ end
377
+
378
+ recent = all.sort_by { |e| Time.parse(e["timestamp"]) }.reverse
379
+ interactions = build_interaction_rows(all, window_ms: 500, limit: 120)
380
+
381
+ FileUtils.rm_rf(TRACES_DIR)
382
+ FileUtils.mkdir_p(TRACES_DIR)
383
+ traces.each do |tid, evs|
384
+ dir = File.join(TRACES_DIR, tid)
385
+ FileUtils.mkdir_p(dir)
386
+ File.write(File.join(dir, "events.json"), JSON.pretty_generate(evs))
387
+ end
388
+
389
+ File.write(File.join(MOCKS, "events/recent.json"), JSON.pretty_generate(recent))
390
+ File.write(File.join(MOCKS, "interactions.json"), JSON.pretty_generate(interactions))
391
+
392
+ puts "Wrote #{recent.size} events in #{traces.size} traces, #{interactions.size} interaction rows → #{MOCKS}"
393
+ end
394
+
395
+ generate
396
+
397
+ # rubocop:enable all