openc3 5.0.10 → 5.1.0

data/lib/openc3/microservices/interface_microservice.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
 
 require 'openc3/microservices/microservice'
 require 'openc3/models/interface_model'
@@ -55,106 +58,112 @@ module OpenC3
 
     def run
       InterfaceTopic.receive_commands(@interface, scope: @scope) do |topic, msg_hash|
-        # Check for a raw write to the interface
-        if topic =~ /CMD}INTERFACE/
-          if msg_hash['shutdown']
-            Logger.info "#{@interface.name}: Shutdown requested"
-            return
-          end
-          if msg_hash['connect']
-            Logger.info "#{@interface.name}: Connect requested"
-            @tlm.attempting()
-            next 'SUCCESS'
-          end
-          if msg_hash['disconnect']
-            Logger.info "#{@interface.name}: Disconnect requested"
-            @tlm.disconnect(false)
-            next 'SUCCESS'
-          end
-          if msg_hash['raw']
-            Logger.info "#{@interface.name}: Write raw"
-            # A raw interface write results in an UNKNOWN packet
-            command = System.commands.packet('UNKNOWN', 'UNKNOWN')
-            command.received_count += 1
-            command = command.clone
-            command.buffer = msg_hash['raw']
-            command.received_time = Time.now
-            CommandTopic.write_packet(command, scope: @scope)
-            @interface.write_raw(msg_hash['raw'])
-            next 'SUCCESS'
-          end
-          if msg_hash.key?('log_raw')
-            if msg_hash['log_raw'] == 'true'
-              Logger.info "#{@interface.name}: Enable raw logging"
-              @interface.start_raw_logging
-            else
-              Logger.info "#{@interface.name}: Disable raw logging"
-              @interface.stop_raw_logging
+        OpenC3.with_context(msg_hash) do
+          # Check for a raw write to the interface
+          if topic =~ /CMD}INTERFACE/
+            if msg_hash['shutdown']
+              Logger.info "#{@interface.name}: Shutdown requested"
+              return
+            end
+            if msg_hash['connect']
+              Logger.info "#{@interface.name}: Connect requested"
+              params = []
+              if msg_hash['params']
+                params = JSON.parse(msg_hash['params'], :allow_nan => true, :create_additions => true)
+              end
+              @interface = @tlm.attempting(*params)
+              next 'SUCCESS'
+            end
+            if msg_hash['disconnect']
+              Logger.info "#{@interface.name}: Disconnect requested"
+              @tlm.disconnect(false)
+              next 'SUCCESS'
+            end
+            if msg_hash['raw']
+              Logger.info "#{@interface.name}: Write raw"
+              # A raw interface write results in an UNKNOWN packet
+              command = System.commands.packet('UNKNOWN', 'UNKNOWN')
+              command.received_count += 1
+              command = command.clone
+              command.buffer = msg_hash['raw']
+              command.received_time = Time.now
+              CommandTopic.write_packet(command, scope: @scope)
+              @interface.write_raw(msg_hash['raw'])
+              next 'SUCCESS'
+            end
+            if msg_hash.key?('log_raw')
+              if msg_hash['log_raw'] == 'true'
+                Logger.info "#{@interface.name}: Enable raw logging"
+                @interface.start_raw_logging
+              else
+                Logger.info "#{@interface.name}: Disable raw logging"
+                @interface.stop_raw_logging
+              end
+              next 'SUCCESS'
             end
-            next 'SUCCESS'
           end
-        end
 
-        target_name = msg_hash['target_name']
-        cmd_name = msg_hash['cmd_name']
-        cmd_params = nil
-        cmd_buffer = nil
-        hazardous_check = nil
-        if msg_hash['cmd_params']
-          cmd_params = JSON.parse(msg_hash['cmd_params'], :allow_nan => true, :create_additions => true)
-          range_check = ConfigParser.handle_true_false(msg_hash['range_check'])
-          raw = ConfigParser.handle_true_false(msg_hash['raw'])
-          hazardous_check = ConfigParser.handle_true_false(msg_hash['hazardous_check'])
-        elsif msg_hash['cmd_buffer']
-          cmd_buffer = msg_hash['cmd_buffer']
-        end
+          target_name = msg_hash['target_name']
+          cmd_name = msg_hash['cmd_name']
+          cmd_params = nil
+          cmd_buffer = nil
+          hazardous_check = nil
+          if msg_hash['cmd_params']
+            cmd_params = JSON.parse(msg_hash['cmd_params'], :allow_nan => true, :create_additions => true)
+            range_check = ConfigParser.handle_true_false(msg_hash['range_check'])
+            raw = ConfigParser.handle_true_false(msg_hash['raw'])
+            hazardous_check = ConfigParser.handle_true_false(msg_hash['hazardous_check'])
+          elsif msg_hash['cmd_buffer']
+            cmd_buffer = msg_hash['cmd_buffer']
+          end
 
-        begin
           begin
-            if cmd_params
-              command = System.commands.build_cmd(target_name, cmd_name, cmd_params, range_check, raw)
-            elsif cmd_buffer
-              if target_name
-                command = System.commands.identify(cmd_buffer, [target_name])
+            begin
+              if cmd_params
+                command = System.commands.build_cmd(target_name, cmd_name, cmd_params, range_check, raw)
+              elsif cmd_buffer
+                if target_name
+                  command = System.commands.identify(cmd_buffer, [target_name])
+                else
+                  command = System.commands.identify(cmd_buffer, @target_names)
+                end
+                unless command
+                  command = System.commands.packet('UNKNOWN', 'UNKNOWN')
+                  command.received_count += 1
+                  command = command.clone
+                  command.buffer = cmd_buffer
+                end
               else
-                command = System.commands.identify(cmd_buffer, @target_names)
-              end
-              unless command
-                command = System.commands.packet('UNKNOWN', 'UNKNOWN')
-                command.received_count += 1
-                command = command.clone
-                command.buffer = cmd_buffer
+                raise "Invalid command received:\n #{msg_hash}"
               end
-            else
-              raise "Invalid command received:\n #{msg_hash}"
+              command.received_time = Time.now
+            rescue => e
+              Logger.error "#{@interface.name}: #{msg_hash}"
+              Logger.error "#{@interface.name}: #{e.formatted}"
+              next e.message
             end
-            command.received_time = Time.now
-          rescue => e
-            Logger.error "#{@interface.name}: #{msg_hash}"
-            Logger.error "#{@interface.name}: #{e.formatted}"
-            next e.message
-          end
 
-          if hazardous_check
-            hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
-            # Return back the error, description, and the formatted command
-            # This allows the error handler to simply re-send the command
-            next "HazardousError\n#{hazardous_description}\n#{System.commands.format(command)}" if hazardous
-          end
+            if hazardous_check
+              hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
+              # Return back the error, description, and the formatted command
+              # This allows the error handler to simply re-send the command
+              next "HazardousError\n#{hazardous_description}\n#{System.commands.format(command)}" if hazardous
+            end
 
-          begin
-            @interface.write(command)
-            CommandTopic.write_packet(command, scope: @scope)
-            CommandDecomTopic.write_packet(command, scope: @scope)
-            InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
-            next 'SUCCESS'
+            begin
+              @interface.write(command)
+              CommandTopic.write_packet(command, scope: @scope)
+              CommandDecomTopic.write_packet(command, scope: @scope)
+              InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
+              next 'SUCCESS'
+            rescue => e
+              Logger.error "#{@interface.name}: #{e.formatted}"
+              next e.message
+            end
           rescue => e
             Logger.error "#{@interface.name}: #{e.formatted}"
             next e.message
           end
-        rescue => e
-          Logger.error "#{@interface.name}: #{e.formatted}"
-          next e.message
         end
       end
     end
@@ -194,7 +203,11 @@ module OpenC3
           end
           if msg_hash['connect']
             Logger.info "#{@router.name}: Connect requested"
-            @tlm.attempting()
+            params = []
+            if msg_hash['params']
+              params = JSON.parse(msg_hash['params'], :allow_nan => true, :create_additions => true)
+            end
+            @router = @tlm.attempting(*params)
           end
           if msg_hash['disconnect']
             Logger.info "#{@router.name}: Disconnect requested"
@@ -250,9 +263,21 @@ module OpenC3
       end
       @interface.name = interface_name
       # Map the interface to the interface's targets
-      @interface.target_names do |target_name|
+      @interface.target_names.each do |target_name|
         target = System.targets[target_name]
         target.interface = @interface
+
+        # Initialize the target's packet counters based on the Topic stream
+        # Prevents packet count resetting to 0 when interface restarts
+        System.telemetry.packets(target_name).each do |packet_name, packet|
+          topic = "#{@scope}__TELEMETRY__{#{target_name}}__#{packet_name}"
+          msg_id, msg_hash = Topic.get_newest_message(topic)
+          if msg_id
+            packet.received_count = msg_hash['received_count'].to_i
+          else
+            packet.received_count = 0
+          end
+        end
       end
       if @interface.connect_on_startup
         @interface.state = 'ATTEMPTING'
@@ -278,15 +303,35 @@ module OpenC3
       @handler_thread.start
     end
 
-    # External method to be called by the InterfaceCmdHandlerThread to connect
-    # Thus we just set the state and allow the run method to handle the action
-    def attempting
+    # Called to connect the interface/router. It takes optional parameters to
+    # rebuilt the interface/router. Once we set the state to 'ATTEMPTING' the
+    # run method handles the actual connection.
+    def attempting(*params)
+      unless params.empty?
+        @interface.disconnect()
+        # Build New Interface, this can fail if passed bad parameters
+        new_interface = @interface.class.new(*params)
+        @interface.copy_to(new_interface)
+
+        # Replace interface for targets
+        @interface.target_names.each do |target_name|
+          target = System.targets[target_name]
+          target.interface = new_interface
+        end
+        @interface = new_interface
+      end
+
       @interface.state = 'ATTEMPTING'
       if @interface_or_router == 'INTERFACE'
         InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
       else
         RouterStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
       end
+      @interface # Return the interface/router since we may have recreated it
+    # Need to rescue Exception so we cover LoadError
+    rescue Exception => error
+      Logger.error("Attempting connection failed with params #{params} due to #{error.message}")
+      @interface # Return the original interface/router in case of error
     end
 
     def run

data/lib/openc3/microservices/log_microservice.rb

@@ -16,9 +16,14 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
 
 require 'openc3/microservices/microservice'
 require 'openc3/topics/topic'
+require 'openc3/logs/buffered_packet_log_writer'
+require 'openc3/config/config_parser'
 
 module OpenC3
   class LogMicroservice < Microservice
@@ -34,6 +39,8 @@ module OpenC3
           @cycle_time = option[1].to_i
         when 'CYCLE_SIZE' # Maximum size of a log file
           @cycle_size = option[1].to_i
+        when 'BUFFER_DEPTH' # Buffer depth to write in time order
+          @buffer_depth = option[1].to_i
         else
           Logger.error("Unknown option passed to microservice #{@name}: #{option}")
         end
@@ -44,41 +51,41 @@ module OpenC3
       # These settings limit the log file to 10 minutes or 50MB of data, whichever comes first
       @cycle_time = 600 unless @cycle_time # 10 minutes
       @cycle_size = 50_000_000 unless @cycle_size # ~50 MB
+
+      @buffer_depth = 10 unless @buffer_depth
     end
 
     def run
-      plws = setup_plws
+      setup_plws()
       while true
         break if @cancel_thread
 
         Topic.read_topics(@topics) do |topic, msg_id, msg_hash, redis|
           break if @cancel_thread
-
-          log_data(plws, topic, msg_id, msg_hash, redis)
+          log_data(topic, msg_id, msg_hash, redis)
         end
       end
     end
 
     def setup_plws
-      plws = {}
+      @plws = {}
       @topics.each do |topic|
         topic_split = topic.gsub(/{|}/, '').split("__") # Remove the redis hashtag curly braces
         scope = topic_split[0]
         target_name = topic_split[2]
         packet_name = topic_split[3]
         type = @raw_or_decom.to_s.downcase
-        remote_log_directory = "#{scope}/#{type}_logs/#{@cmd_or_tlm.to_s.downcase}/#{target_name}/#{packet_name}"
-        rt_label = "#{scope}__#{target_name}__#{packet_name}__rt__#{type}"
-        stored_label = "#{scope}__#{target_name}__#{packet_name}__stored__#{type}"
-        plws[topic] = {
-          :RT => PacketLogWriter.new(remote_log_directory, rt_label, true, @cycle_time, @cycle_size, redis_topic: topic),
-          :STORED => PacketLogWriter.new(remote_log_directory, stored_label, true, @cycle_time, @cycle_size, redis_topic: topic)
+        remote_log_directory = "#{scope}/#{type}_logs/#{@cmd_or_tlm.to_s.downcase}/#{target_name}"
+        rt_label = "#{scope}__#{target_name}__ALL__rt__#{type}"
+        stored_label = "#{scope}__#{target_name}__ALL__stored__#{type}"
+        @plws[target_name] ||= {
+          :RT => BufferedPacketLogWriter.new(remote_log_directory, rt_label, true, @cycle_time, @cycle_size, nil, nil, @buffer_depth),
+          :STORED => BufferedPacketLogWriter.new(remote_log_directory, stored_label, true, @cycle_time, @cycle_size, nil, nil, @buffer_depth)
         }
       end
-      return plws
     end
 
-    def log_data(plws, topic, msg_id, msg_hash, redis)
+    def log_data(topic, msg_id, msg_hash, redis)
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       topic_split = topic.gsub(/{|}/, '').split("__") # Remove the redis hashtag curly braces
       target_name = topic_split[2]
@@ -93,7 +100,7 @@ module OpenC3
         packet_type = :JSON_PACKET
         data_key = "json_data"
       end
-      plws[topic][rt_or_stored].write(packet_type, @cmd_or_tlm, target_name, packet_name, msg_hash["time"].to_i, rt_or_stored == :STORED, msg_hash[data_key], nil, msg_id)
+      @plws[target_name][rt_or_stored].buffered_write(packet_type, @cmd_or_tlm, target_name, packet_name, msg_hash["time"].to_i, rt_or_stored == :STORED, msg_hash[data_key], nil, topic, msg_id)
       @count += 1
       diff = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start # seconds as a float
       metric_labels = { "packet" => packet_name, "target" => target_name, "raw_or_decom" => @raw_or_decom.to_s, "cmd_or_tlm" => @cmd_or_tlm.to_s }
@@ -102,6 +109,21 @@ module OpenC3
       @error = err
       Logger.error("#{@name} error: #{err.formatted}")
     end
+
+    def shutdown
+      # Make sure all the existing logs are properly closed down
+      threads = []
+      @plws.each do |target_name, plw_hash|
+        plw_hash.each do |type, plw|
+          threads.concat(plw.shutdown)
+        end
+      end
+      # Wait for all the logging threads to move files to buckets
+      threads.flatten.compact.each do |thread|
+        thread.join
+      end
+      super()
+    end
   end
 end
 

data/lib/openc3/microservices/microservice.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
 
 require 'openc3'
 OpenC3.require_file 'json'
@@ -23,8 +26,9 @@ OpenC3.require_file 'redis'
 OpenC3.require_file 'fileutils'
 OpenC3.require_file 'openc3/utilities/zip'
 OpenC3.require_file 'openc3/utilities/store'
-OpenC3.require_file 'openc3/utilities/s3'
+OpenC3.require_file 'openc3/utilities/bucket'
 OpenC3.require_file 'openc3/utilities/sleeper'
+OpenC3.require_file 'openc3/utilities/open_telemetry'
 OpenC3.require_file 'openc3/models/microservice_model'
 OpenC3.require_file 'openc3/models/microservice_status_model'
 OpenC3.require_file 'tmpdir'
@@ -71,6 +75,7 @@ module OpenC3
     end
 
     def initialize(name, is_plugin: false)
+      Logger.info("Microservice running from: ruby #{$0} #{ARGV.join(" ")}")
       raise "Microservice must be named" unless name
 
       @name = name
@@ -85,6 +90,8 @@ module OpenC3
       Logger.microservice_name = @name
       Logger.tag = @name + "__openc3.log"
 
+      OpenC3.setup_open_telemetry(@name, false)
+
       # Create temp folder for this microservice
       @temp_dir = Dir.mktmpdir
 
@@ -100,7 +107,7 @@ module OpenC3
       Logger.info("Microservice initialized with config:\n#{@config}")
       @topics ||= []
 
-      # Get configuration for any targets from Minio/S3
+      # Get configuration for any targets
       @target_names = @config["target_names"]
       @target_names ||= []
       System.setup_targets(@target_names, @temp_dir, scope: @scope) unless is_plugin
@@ -120,24 +127,17 @@ module OpenC3
         @work_dir = @config["work_dir"]
         cmd_array = @config["cmd"]
 
-        # Get Microservice files from S3
+        # Get Microservice files from bucket storage
         temp_dir = Dir.mktmpdir
-        rubys3_client = Aws::S3::Client.new
-        bucket = "config"
-
-        # Ensure config bucket exists
-        begin
-          rubys3_client.head_bucket(bucket: bucket)
-        rescue Aws::S3::Errors::NotFound
-          rubys3_client.create_bucket(bucket: bucket)
-        end
+        bucket = ENV['OPENC3_CONFIG_BUCKET']
+        client = Bucket.getClient()
 
         prefix = "#{@scope}/microservices/#{@name}/"
         file_count = 0
-        rubys3_client.list_objects(bucket: bucket, prefix: prefix).contents.each do |object|
+        client.list_objects(bucket: bucket, prefix: prefix).each do |object|
           response_target = File.join(temp_dir, object.key.split(prefix)[-1])
           FileUtils.mkdir_p(File.dirname(response_target))
-          rubys3_client.get_object(bucket: bucket, key: object.key, response_target: response_target)
+          client.get_object(bucket: bucket, key: object.key, path: response_target)
           file_count += 1
         end
 
@@ -194,11 +194,13 @@ module OpenC3
     end
 
     def shutdown
+      Logger.info("Shutting down microservice: #{@name}")
       @cancel_thread = true
       @microservice_sleeper.cancel if @microservice_sleeper
       MicroserviceStatusModel.set(as_json(:allow_nan => true), scope: @scope)
       FileUtils.remove_entry(@temp_dir) if File.exist?(@temp_dir)
       @metric.destroy
+      Logger.info("Shutting down microservice complete: #{@name}")
     end
   end
 end

data/lib/openc3/microservices/plugin_microservice.rb

@@ -16,10 +16,12 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license 
+# if purchased from OpenC3, Inc.
 
 require 'openc3/microservices/microservice'
 require 'openc3/topics/topic'
-require 'openc3/utilities/s3'
 
 module OpenC3
   class PluginMicroservice < Microservice

data/lib/openc3/microservices/reaction_microservice.rb

@@ -16,6 +16,9 @@
 # Modified by OpenC3, Inc.
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
+#
+# This file may also be used under the terms of a commercial license 
+# if purchased from OpenC3, Inc.
 
 require 'openc3/microservices/microservice'
 require 'openc3/models/reaction_model'
@@ -324,7 +327,7 @@ module OpenC3
           'reaction' => reaction.name,
           'id' => Time.now.to_i
         })
-        hostname = ENV['OPENC3_SCRIPT_HOSTNAME'] || 'openc3-script-runner-api'
+        hostname = ENV['OPENC3_SCRIPT_HOSTNAME'] || 'openc3-cosmos-script-runner-api'
         response = Net::HTTP.new(hostname, 2902).request(request)
         raise "failed to call #{hostname}, for script: #{action['value']}, response code: #{response.code}" if response.code != '200'