chronos-ruby 1.2.0.pre.1 → 1.2.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13c2858edcb41d4b2a0bfc83049349ee13a5a9ecee873798750b4bf9f1da48c
-  data.tar.gz: a21babcc28ce763e7d867f35064735d661214724c1ed9d256e8d174a1a04c5dc
+  metadata.gz: 28ccfc363bc7f73eb18a10d36e0457d8697ffe52dae4f939fa81a4cbe6938609
+  data.tar.gz: ac5d64237250a9d9d1e26da86649698dd09eda1afb7a115fb87eb2edf6d3183b
 SHA512:
-  metadata.gz: 81ab0672785236e1ffaeecf0fbb5ae3187f319be349a06f724eee50dd0d20963afb74a84485267e8ea5e3a7dd37dacef15ab456783fee622bef901110b98344a
-  data.tar.gz: 835ee551ddcec646a44376dcdfc09748e12c0fa360fee62365455e6776503a0597baed504a33276059853e652f5a90458ad7ae43bb582f7647303af9940a5d1f
+  metadata.gz: 58987b0079af3abcd99ee06f6c2739833719d95ae29ef7764997f37c01745f269521453d610a7bfd7b9081c26593590c469d58d52a502ab752668d1d1d2d4e19
+  data.tar.gz: ba3277ee0bbc7fd67186e605505659ae2db7a1add6cad35c08bcf30669b1e7140f5c004ad9ace8154d2a25a72af9d6938aacf2ac04ea0da4dd9924700b0c2df8

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes are documented here. The project follows Semantic Versioning
 
 ## [Unreleased]
 
+## [1.2.0.pre.2] - 2026-08-11
+
+### Changed
+
+- the Rails install generator now writes every public configuration option with explanatory English comments;
+- the official `https://chronosmonitor.com.br` endpoint is now the default host, including when applications omit `config.host`;
+- generated initializers no longer read `CHRONOS_HOST`, while explicit `config.host` assignments remain supported.
+
 ## [1.2.0.pre.1] - 2026-08-11
 
 ### Added

data/README.md

@@ -24,7 +24,7 @@ A gem não varre variáveis de ambiente, sistema de arquivos ou lockfiles e não
 
 ## Versões Ruby e Rails suportadas
 
-A versão candidata 1.2.0.pre.1 inicia a linha transitional para Ruby 2.7–3.4, Rails 7.x e Sidekiq 7. Ela adiciona contexto por Fiber, Rails Error Reporter, Action Cable, Faraday, Trace Context W3C opcional e coexistência com um SDK OpenTelemetry já configurado. Use-a explicitamente em staging enquanto a matriz transitional é validada; as linhas legadas permanecem disponíveis em releases anteriores.
+A versão candidata 1.2.0.pre.2 continua a linha transitional para Ruby 2.7–3.4, Rails 7.x e Sidekiq 7. Ela adiciona contexto por Fiber, Rails Error Reporter, Action Cable, Faraday, Trace Context W3C opcional e coexistência com um SDK OpenTelemetry já configurado. Use-a explicitamente em staging enquanto a matriz transitional é validada; as linhas legadas permanecem disponíveis em releases anteriores.
 
 Rubies e frameworks antigos estão fora do suporte de segurança de seus mantenedores. A Chronos oferece compatibilidade técnica, não manutenção de segurança do runtime. Veja [Compatibilidade](docs/compatibility.md).
 
@@ -67,7 +67,8 @@ A Versão 0.5 introduziu Railtie, middleware e subscribers idempotentes por APIs
 
 ## Configuração mínima
 
-Obrigatório quando o agente está habilitado: `project_id`, `project_key` e `host` HTTPS. Recomendado: definir ambiente e serviço explicitamente.
+Obrigatório quando o agente está habilitado: `project_id` e `project_key`. O `host` usa
+`https://chronosmonitor.com.br` por padrão. Recomendado: definir ambiente e serviço explicitamente.
 
 ```ruby
 require "chronos"
@@ -75,7 +76,7 @@ require "chronos"
 Chronos.configure do |config|
   config.project_id = ENV["CHRONOS_PROJECT_ID"]
   config.project_key = ENV["CHRONOS_PROJECT_KEY"]
-  config.host = "https://chronos.example.com"
+  config.host = "https://chronosmonitor.com.br"
   config.environment = ENV["APP_ENV"] || "production"
   config.service_name = "billing"
   config.app_version = ENV["APP_VERSION"]

data/docs/compatibility.md

@@ -1,6 +1,6 @@
 # Compatibility
 
-Chronos Ruby 1.2.0.pre.1 is the first candidate of the transitional line for Rails 7 and Sidekiq 7. Combinations remain `Best effort` until their dedicated CI and real-application gates pass. Technical compatibility does not make an end-of-life Ruby, Rails, Rack, or Sidekiq release secure. Versions 1.0 and 1.1 remain the frozen legacy line.
+Chronos Ruby 1.2.0.pre.2 is the current candidate of the transitional line for Rails 7 and Sidekiq 7. Combinations remain `Best effort` until their dedicated CI and real-application gates pass. Technical compatibility does not make an end-of-life Ruby, Rails, Rack, or Sidekiq release secure. Versions 1.0 and 1.1 remain the frozen legacy line.
 
 ## Core and Rack
 

data/docs/configuration.md

@@ -6,7 +6,7 @@
 |---|---:|---|---|
 | `project_id` | Yes when enabled | `nil` | Public project identifier included in the envelope |
 | `project_key` | Yes when enabled | `nil` | Secret authentication key sent only as an HTTP header |
-| `host` | Yes when enabled | `nil` | Absolute Chronos HTTP endpoint; HTTPS is required by default |
+| `host` | Optional | `https://chronosmonitor.com.br` | Absolute Chronos HTTP endpoint; HTTPS is required by default |
 | `environment` | Recommended | `production` | Application environment |
 | `app_version` | Optional | `nil` | Application release/version identifier |
 | `service_name` | Recommended | `nil` | Logical service name |

data/lib/chronos/configuration.rb

@@ -23,6 +23,7 @@ module Chronos
   class Configuration
     include Internal::ConfigurationValidation
     include Internal::ApmConfigurationValidation
+    DEFAULT_HOST = "https://chronosmonitor.com.br".freeze
     DEFAULT_BLOCKLIST_KEYS = %w(
       password password_confirmation passwd secret api_key apikey authorization
       token access_token refresh_token private_key client_secret cookie set-cookie
@@ -106,7 +107,7 @@ module Chronos
     def initialize_core_defaults
       @project_id = nil
       @project_key = nil
-      @host = nil
+      @host = DEFAULT_HOST
       @environment = "production"
       @app_version = nil
       @service_name = nil

data/lib/chronos/version.rb

@@ -1,4 +1,4 @@
 module Chronos
   # Current version of the transitional Chronos Ruby agent.
-  VERSION = "1.2.0.pre.1".freeze
+  VERSION = "1.2.0.pre.2".freeze
 end

data/lib/generators/chronos/install/templates/chronos.rb

@@ -1,20 +1,186 @@
 require "chronos/rails"
 
+# This initializer lists every public Chronos option so the application's
+# monitoring behavior is explicit and can be reviewed in one place.
 Chronos.configure do |config|
-  # Chronos reads only the environment variables explicitly selected here.
+  # Identification and authentication
+
+  # Identifies the project that will receive monitoring events.
   config.project_id = ENV["CHRONOS_PROJECT_ID"]
+  # Authenticates event delivery. Keep this value in a secret manager.
   config.project_key = ENV["CHRONOS_PROJECT_KEY"]
-  config.host = ENV["CHRONOS_HOST"]
+  # Defines the Chronos Monitor endpoint used to deliver events.
+  config.host = "https://chronosmonitor.com.br"
+  # Labels events with the current Rails environment.
   config.environment = Rails.env.to_s
-  config.service_name = ENV["CHRONOS_SERVICE_NAME"]
+  # Identifies the deployed application version in events and releases.
   config.app_version = ENV["CHRONOS_APP_VERSION"]
+  # Distinguishes this application from other monitored services.
+  config.service_name = ENV["CHRONOS_SERVICE_NAME"]
+  # Records the source revision, such as a Git commit SHA.
+  config.revision = ENV["CHRONOS_REVISION"]
+  # Associates events with a specific deployment.
+  config.deploy_id = ENV["CHRONOS_DEPLOY_ID"]
+  # Identifies the infrastructure region where the application is running.
+  config.region = ENV["CHRONOS_REGION"]
+  # Identifies the process, container, or host that produced an event.
+  config.instance_id = ENV["CHRONOS_INSTANCE_ID"]
+  # Removes the application root from file paths reported to Chronos.
+  config.root_directory = Rails.root.to_s
+  # Sends internal Chronos diagnostics through the Rails logger.
   config.logger = Rails.logger if Rails.respond_to?(:logger)
 
-  # Safe legacy defaults: test and console integrations remain disabled.
-  config.rails_capture_in_test = false
+  # Transport and delivery
+
+  # Limits how long an established request may wait for the Chronos server.
+  config.timeout = 5
+  # Limits how long Chronos may wait while opening a network connection.
+  config.open_timeout = 2
+  # Sets the maximum number of events waiting in the in-memory queue.
+  config.queue_size = 100
+  # Sets the number of background workers that deliver queued events.
+  config.workers = 1
+  # Enables or disables all Chronos event collection and delivery.
+  config.enabled = true
+  # Controls whether captured exceptions are sent to Chronos.
+  config.error_notifications = true
+  # Prevents delivery from the listed application environments.
+  config.ignored_environments = []
+  # Routes outbound requests through a proxy URL when one is required.
+  config.proxy = nil
+  # Verifies the TLS certificate presented by the Chronos endpoint.
+  config.ssl_verify = true
+  # Identifies this SDK in outbound HTTP requests.
+  config.user_agent = "chronos-ruby/#{Chronos::VERSION}"
+  # Rejects serialized events larger than this number of bytes.
+  config.max_payload_size = 1_048_576
+  # Compresses request payloads with gzip when enabled.
+  config.gzip = false
+
+  # Privacy and filtering
+
+  # Removes values whose keys commonly contain credentials or private data.
+  config.blocklist_keys = Chronos::Configuration::DEFAULT_BLOCKLIST_KEYS.dup
+  # Keeps only the listed keys when this list is not empty.
+  config.allowlist_keys = []
+  # Applies custom callables that can transform or discard events.
+  config.filters = []
+  # Replaces values for these keys with stable hashes instead of raw data.
+  config.hash_keys = []
+  # Removes the final segment of captured IP addresses.
+  config.anonymize_ip = true
+  # Discards events that match any configured ignore rule.
+  config.ignore_rules = []
+  # Limits the number of ignore rules evaluated for each event.
+  config.max_ignore_rules = 20
+
+  # Reliability and remote configuration
+
+  # Sets the number of delivery retries after a recoverable failure.
+  config.max_retries = 3
+  # Sets the initial delay, in seconds, for exponential retry backoff.
+  config.retry_base_interval = 0.5
+  # Caps the retry delay, in seconds.
+  config.retry_max_interval = 30
+  # Randomizes retry delays to prevent synchronized retry traffic.
+  config.retry_jitter = 0.25
+  # Keeps this many failed events in memory for later delivery attempts.
+  config.backlog_size = 100
+  # Opens the circuit breaker after this many consecutive failures.
+  config.circuit_failure_threshold = 5
+  # Waits this many seconds before testing an open circuit again.
+  config.circuit_reset_timeout = 30
+  # Allows the server to supply bounded runtime configuration updates.
+  config.remote_configuration = true
+  # Limits the size of an accepted remote configuration response, in bytes.
+  config.remote_config_max_bytes = 4_096
+  # Captures this fraction of eligible events, from 0.0 to 1.0.
+  config.sampling_rate = 1.0
+  # Restricts remote collection to these event categories.
+  config.enabled_event_types = %w(
+    exception request query job cache external_http dependencies deploy metric_batch
+  )
+  # Caps the server-requested interval between deliveries, in seconds.
+  config.max_remote_send_interval = 60
+
+  # Execution context and breadcrumbs
+
+  # Isolates trace and request context between concurrent fibers.
+  config.context_store = :fiber_local
+  # Keeps this many recent breadcrumbs per execution context.
+  config.breadcrumb_capacity = 20
+  # Limits the serialized size of each breadcrumb, in bytes.
+  config.breadcrumb_max_bytes = 2_048
+
+  # Rails integration
+
+  # Installs Rails request, job, cache, SQL, and error integrations.
+  config.rails_enabled = true
+  # Captures events from Rails console sessions when enabled.
   config.rails_capture_in_console = false
+  # Captures events while the Rails test environment is running when enabled.
+  config.rails_capture_in_test = false
+  # Includes the request User-Agent in request metadata when enabled.
   config.rails_capture_user_agent = false
+
+  # Application performance monitoring
+
+  # Enables transaction, span, query, and aggregate performance monitoring.
+  config.apm_enabled = true
+  # Limits the number of metric groups retained between flushes.
+  config.apm_max_groups = 200
+  # Flushes APM aggregates after this many observations.
+  config.apm_flush_count = 100
+  # Sends at most this many APM items in one request.
+  config.apm_batch_size = 50
+  # Limits the SQL queries recorded for a single request or transaction.
+  config.apm_max_queries_per_request = 100
+  # Marks SQL queries slower than this duration, in milliseconds.
+  config.apm_slow_query_threshold_ms = 500
+  # Marks transactions longer than this duration, in milliseconds.
+  config.apm_long_transaction_threshold_ms = 1_000
+  # Reports repeated equivalent queries after this count is reached.
+  config.apm_n_plus_one_threshold = 5
+  # Defines the duration buckets, in milliseconds, used by APM histograms.
+  config.apm_histogram_buckets = [5, 10, 25, 50, 100, 250, 500, 1_000, 2_500, 5_000]
+  # Retains active trace state for this many seconds.
+  config.apm_trace_ttl_seconds = 60
+  # Normalizes SQL and records bounded query analysis metadata.
+  config.apm_query_analysis_enabled = true
+  # Limits the number of analyzed queries retained per transaction.
+  config.apm_query_analysis_max_queries = 100
+  # Enables database-specific query inspection for slow queries.
+  config.apm_query_inspection_enabled = false
+  # Collects database query statistics when inspection supports them.
+  config.apm_query_statistics_enabled = false
+  # Collects query execution plans when inspection supports them.
+  config.apm_query_plan_enabled = false
+  # Inspects only queries at least this slow, in milliseconds.
+  config.apm_query_inspection_min_duration_ms = 500
+  # Limits the inspected queries retained per transaction.
+  config.apm_query_inspection_max_queries = 20
+  # Tracks database transaction lifecycles and durations.
+  config.apm_transaction_tracking_enabled = true
+  # Limits the database connections tracked for transaction state.
+  config.apm_transaction_max_connections = 100
+
+  # Distributed tracing and integrations
+
+  # Instruments supported outbound HTTP clients when enabled.
+  config.external_http_enabled = false
+  # Propagates Chronos trace headers on instrumented outbound requests.
+  config.external_http_trace_headers = true
+  # Extracts and injects the standard W3C traceparent header when enabled.
+  config.w3c_trace_context = false
+  # Reuses an active OpenTelemetry span without configuring its SDK.
+  config.opentelemetry_bridge = true
+  # Controls cache key reporting; :none avoids collecting cache key material.
+  config.cache_key_mode = :none
+  # Reports a bounded inventory of application dependencies.
+  config.dependency_reporting = true
+  # Limits the number of dependencies included in an inventory event.
+  config.dependency_max_items = 100
 end
 
-# Safe when the Railtie already ran or will run later; installation is idempotent.
+# Installation is idempotent, regardless of when the Railtie was evaluated.
 Chronos::Rails::Installer.new.install(Rails.application)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronos-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre.1
+  version: 1.2.0.pre.2
 platform: ruby
 authors:
 - Antonio Jefferson