feat: updated README

Author: DmytryS

README.md

@@ -69,10 +69,10 @@ require 'opentelemetry/exporter/otlp'
 # see: Multiplayer::SessionRecorder::Exporters::SessionRecorderGrpcTraceExporter 
 # and Multiplayer::SessionRecorder::Exporters::SessionRecorderGrpcLogsExporter
 multiplayer_trace_exporter = Multiplayer::SessionRecorder::Exporters::SessionRecorderHttpTraceExporter.new(
-  api_key: "MULTIPLAYER_OTLP_KEY" # note: replace with your Multiplayer OTLP key
+  api_key: "MULTIPLAYER_API_KEY" # note: replace with your Multiplayer API key
 )
 multiplayer_log_exporter = Multiplayer::SessionRecorder::Exporters::SessionRecorderHttpLogsExporter.new(
-  api_key: "MULTIPLAYER_OTLP_KEY" # note: replace with your Multiplayer OTLP key
+  api_key: "MULTIPLAYER_API_KEY" # note: replace with your Multiplayer API key
 )
 
 # Multiplayer exporter wrappers filter out session recording attributes before passing to provided exporter
@@ -193,6 +193,8 @@ Use the following code below to initialize and run the session recorder.
 
 Example for Session Recorder initialization relies on [opentelemetry.rb](./examples/cli/opentelemetry.rb) file. Copy that file and put next to quick start code.
 
+### Initialize
+
 ```ruby
 # IMPORTANT: set up OpenTelemetry
 # for an example see ./examples/cli/opentelemetry.rb
@@ -206,21 +208,27 @@ opentelemetry_components = OpenTelemetryConfig.setup
 # Initialize SessionRecorder
 session_recorder = Multiplayer::SessionRecorder::SessionRecorder.new
 session_recorder.init({
-  api_key: "MULTIPLAYER_OTLP_KEY", # note: replace with your Multiplayer OTLP key
+  api_key: "MULTIPLAYER_API_KEY", # note: replace with your Multiplayer API key
   trace_id_generator: opentelemetry_components[:id_generator],
   resource_attributes: {
     component_name: "{YOUR_APPLICATION_NAME}",
     component_version: "{YOUR_APPLICATION_VERSION}",
     environment: "{YOUR_APPLICATION_ENVIRONMENT}"
   }
 })
+```
+
+### Manual session recording
 
+Below is an example showing how to create a session recording in `MANUAL` mode. Manual session recordings stream and save all the data between calling `start` and `stop`.
+
+```ruby
 session_recorder.start(
-  Multiplayer::SessionRecorder::Type::SessionType::PLAIN,
+  Multiplayer::SessionRecorder::Type::SessionType::MANUAL,
   {
     name: "This is test session",
     resource_attributes: {
-      account_id: "687e2c0d3ec8ef6053e9dc97",
+      account_id: "1234",
       account_name: "Acme Corporation"
     }
   }
@@ -235,6 +243,65 @@ session_recorder.stop({
 })
 ```
 
+### Continuous session recording
+
+Below is an example showing how to create a session in `CONTINUOUS` mode. Continuous session recordings **stream** all the data received between calling `start` and `stop` - 
+but only **save** a rolling window data (90 seconds by default) when:
+
+- an exception or error occurs;
+- when `save` is called; or
+- programmatically, when the auto-save attribute is attached to a span.
+
+```ruby
+session_recorder.start(
+  Multiplayer::SessionRecorder::Type::SessionType::CONTINUOUS,
+  {
+    name: "This is test session",
+    resource_attributes: {
+      account_id: "1234",
+      account_name: "Acme Corporation"
+    }
+  }
+)
+
+# do something here
+
+session_recorder.save()
+
+# do something here
+
+session_recorder.save()
+
+# do something here
+
+session_recorder.stop({
+  sessionAttributes: {
+    comment: "Session completed successfully"
+  }
+})
+```
+
+Continuous session recordings may also be saved from within any service or component involved in a trace by adding the attributes below to a span:
+
+```ruby
+require 'opentelemetry-api'
+require 'multiplayer-session-recorder'
+
+active_span = OpenTelemetry::Trace.current_span
+
+if active_span.context.valid?
+  active_span.set_attribute(
+    MultiplayerApp::SessionRecorder::ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE,
+    true
+  )
+
+  active_span.set_attribute(
+    MultiplayerApp::SessionRecorder::ATTR_MULTIPLAYER_CONTINUOUS_SESSION_AUTO_SAVE_REASON,
+    "Some reason"
+  )
+end
+```
+
 Replace the placeholders with your application’s version, name, environment, and API key.
 
 ## License

example_opentelemetry.rb

@@ -10,11 +10,11 @@
 SERVICE_NAME = "<service_name>"
 SERVICE_VERSION = "<service_version>"
 PLATFORM_ENV = "<environment_name>"
-MULTIPLAYER_OTLP_KEY = ENV["MULTIPLAYER_OTLP_KEY"]
+MULTIPLAYER_API_KEY = ENV["MULTIPLAYER_API_KEY"]
 HOSTNAME = Socket.gethostname
 
 ## Session Recorder Exporter configuration
-session_exporter = SessionRecorder::Exporters.create_http_trace_exporter(api_key: MULTIPLAYER_OTLP_KEY)
+session_exporter = SessionRecorder::Exporters.create_http_trace_exporter(api_key: MULTIPLAYER_API_KEY)
 
 OpenTelemetry::SDK.configure do |c|
   # Set processor for SessionRecorder::Exporters

examples/cli/README.md

@@ -7,5 +7,5 @@
 
 ### Launch
 ```bash
-MULTIPLAYER_OTLP_KEY="your-key" ENVIRONMENT="staging" bundle exec ruby main.rb
+MULTIPLAYER_API_KEY="your-key" ENVIRONMENT="staging" bundle exec ruby main.rb
 ```

examples/cli/config.rb

@@ -3,7 +3,7 @@
 # Configuration for the CLI example
 module Config
   # OpenTelemetry API configuration
-  MULTIPLAYER_OTLP_KEY = ENV['MULTIPLAYER_OTLP_KEY'] || 'your-api-key-here'
+  MULTIPLAYER_API_KEY = ENV['MULTIPLAYER_API_KEY'] || 'your-api-key-here'
   MULTIPLAYER_TRACES_ENDPOINT = ENV['MULTIPLAYER_TRACES_ENDPOINT'] || 'https://api.multiplayer.com/v1/otlp/traces'
   MULTIPLAYER_LOGS_ENDPOINT = ENV['MULTIPLAYER_LOGS_ENDPOINT'] || 'https://api.multiplayer.com/v1/otlp/logs'
 
@@ -34,16 +34,16 @@ def self.display_config
     puts "   Log Level: #{LOG_LEVEL}"
     puts "   Traces Endpoint: #{MULTIPLAYER_TRACES_ENDPOINT}"
     puts "   Logs Endpoint: #{MULTIPLAYER_LOGS_ENDPOINT}"
-    puts "   API Key: #{MULTIPLAYER_OTLP_KEY[0..8]}..." if MULTIPLAYER_OTLP_KEY != 'your-api-key-here'
+    puts "   API Key: #{MULTIPLAYER_API_KEY[0..8]}..." if MULTIPLAYER_API_KEY != 'your-api-key-here'
     puts ""
   end
 
   # Validate required configuration
   def self.validate
     errors = []
 
-    if MULTIPLAYER_OTLP_KEY == 'your-api-key-here'
-      errors << "MULTIPLAYER_OTLP_KEY must be set to a valid API key"
+    if MULTIPLAYER_API_KEY == 'your-api-key-here'
+      errors << "MULTIPLAYER_API_KEY must be set to a valid API key"
     end
 
     if errors.any?

examples/cli/main.rb

@@ -45,7 +45,7 @@ def init
     # Initialize SessionRecorder
     @logger.info("🎯 Initializing SessionRecorder...")
     @session_recorder.init({
-      api_key: Config::MULTIPLAYER_OTLP_KEY,
+      api_key: Config::MULTIPLAYER_API_KEY,
       trace_id_generator: opentelemetry_components[:id_generator],
       resource_attributes: {
         component_name: Config::COMPONENT_NAME,
@@ -57,7 +57,7 @@ def init
     @logger.info("✅ Application initialized successfully")
     @logger.info("   Component: #{Config::COMPONENT_NAME} v#{Config::COMPONENT_VERSION}")
     @logger.info("   Environment: #{Config::ENVIRONMENT}")
-    @logger.info("   API Key: #{Config::MULTIPLAYER_OTLP_KEY[0..8]}...") if Config::MULTIPLAYER_OTLP_KEY != 'your-api-key-here'
+    @logger.info("   API Key: #{Config::MULTIPLAYER_API_KEY[0..8]}...") if Config::MULTIPLAYER_API_KEY != 'your-api-key-here'
   rescue => e
     @logger.error("❌ Failed to initialize application: #{e.message}")
     @logger.error(e.backtrace.join("\n")) if Config::DEBUG
@@ -69,7 +69,7 @@ def start_session
     @logger.info("🎬 Starting debug session...")
 
     @session_recorder.start(
-      Multiplayer::SessionRecorder::Type::SessionType::PLAIN,
+      Multiplayer::SessionRecorder::Type::SessionType::MANUAL,
       {
         name: Config::SESSION_NAME,
         resource_attributes: {

examples/cli/opentelemetry.rb

@@ -17,12 +17,12 @@ def setup
 
       # Create HTTP exporters
       @http_trace_exporter = Multiplayer::SessionRecorder::Exporters.create_http_trace_exporter(
-        api_key: Config::MULTIPLAYER_OTLP_KEY,
+        api_key: Config::MULTIPLAYER_API_KEY,
         endpoint: Config::MULTIPLAYER_TRACES_ENDPOINT
       )
 
       @http_logs_exporter = Multiplayer::SessionRecorder::Exporters.create_http_logs_exporter(
-        api_key: Config::MULTIPLAYER_OTLP_KEY,
+        api_key: Config::MULTIPLAYER_API_KEY,
         endpoint: Config::MULTIPLAYER_LOGS_ENDPOINT
       )
 

examples/http-server/README.md

@@ -7,5 +7,5 @@
 
 ### Launch
 ```bash
-MULTIPLAYER_OTLP_KEY="your-key" ENVIRONMENT="staging" bundle exec ruby main.rb
+MULTIPLAYER_API_KEY="your-key" ENVIRONMENT="staging" bundle exec ruby main.rb
 ```

lib/multiplayer_session_recorder/session_recorder.rb

@@ -16,7 +16,7 @@ def initialize
         @is_initialized = false
         @short_session_id = false
         @trace_id_generator = nil
-        @session_type = Type::SessionType::PLAIN
+        @session_type = Type::SessionType::MANUAL
         @session_state = 'STOPPED'
         @api_service = ApiService.new
         @resource_attributes = {}
@@ -141,7 +141,7 @@ def stop(session_data = {})
           raise RuntimeError, 'Session should be active or paused'
         end
 
-        unless @session_type == Type::SessionType::PLAIN
+        unless @session_type == Type::SessionType::MANUAL
           raise RuntimeError, 'Invalid session type'
         end
 
@@ -165,7 +165,7 @@ def cancel
 
         if @session_type == Type::SessionType::CONTINUOUS
           @api_service.stop_continuous_session(@short_session_id)
-        elsif @session_type == Type::SessionType::PLAIN
+        elsif @session_type == Type::SessionType::MANUAL
           @api_service.cancel_session(@short_session_id)
         end
       ensure

lib/multiplayer_session_recorder/trace/id_generator.rb

@@ -16,7 +16,7 @@ def initialize
         @generate_long_id = self.class.get_id_generator(16)
         @generate_short_id = self.class.get_id_generator(8)
         @session_short_id = ''
-        @session_type = Type::SessionType::PLAIN
+        @session_type = Type::SessionType::MANUAL
       end
 
       def generate_trace_id
@@ -43,7 +43,7 @@ def generate_span_id
         @generate_short_id.call
       end
 
-      def set_session_id(session_short_id, session_type = Type::SessionType::PLAIN)
+      def set_session_id(session_short_id, session_type = Type::SessionType::MANUAL)
         @session_short_id = session_short_id
         @session_type = session_type
       end

lib/multiplayer_session_recorder/type/session_type.rb

@@ -4,7 +4,7 @@ module Multiplayer
   module SessionRecorder
     module Type
       module SessionType
-        PLAIN = 'plain'
+        MANUAL = 'manual'
         CONTINUOUS = 'continuous'
       end
     end