def connect(self, connect_args=None):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_INITIALIZED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
self.stream_pub = StreamPublisher(process=self,
stream=self.stream_name)
args = dict_merge(
self.agent_config,
connect_args) if connect_args else self.agent_config
res = self.on_connect(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
def connect(self, connect_args=None):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_INITIALIZED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
self.stream_pub = StreamPublisher(process=self, stream=self.stream_name)
res = self.on_connect(connect_args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
class StreamingAgent(BaseStreamingAgent):
# Constants
AGENTSTATE_NEW = "new"
AGENTSTATE_INITIALIZED = "initialized"
AGENTSTATE_CONNECTED = "connected"
AGENTSTATE_STREAMING = "streaming"
AGENTSTATE_ERROR = "error"
# ION process type
name = "streaming_agent"
process_type = "agent"
# Instance defaults (public)
resource_type = "streaming_agent"
resource_id = None
agent_id = None
agent_def_id = None
agent_type = "agent"
# Instance defaults (local)
current_state = AGENTSTATE_NEW
params = {}
agent_plugin = None
stream_name = None
def on_init(self):
log.info("Start agent %s pid=%s resource_id=%s", self.__class__.__name__, self.id, self.resource_id)
self.current_state = self.AGENTSTATE_INITIALIZED
self.agent_config = self.CFG.get_safe("agent_config") or {}
self.params = {}
self.agent_plugin = None
self.stream_name = self.agent_config.get("stream_name", None) or "stream_" + self.resource_id
if "plugin" in self.agent_config:
agent_plugin_cls = named_any(self.agent_config["plugin"])
log.info("Instantiate agent plugin '%s'", self.agent_config["plugin"])
self.agent_plugin = agent_plugin_cls(self, self.agent_config)
if self.agent_config.get("auto_streaming", False) is True:
self.connect()
self.start_streaming()
def on_stop(self):
pass
def on_quit(self):
if self.current_state in (self.AGENTSTATE_STREAMING, self.AGENTSTATE_CONNECTED):
log.info("Terminate agent %s pid=%s resource_id=%s", self.__class__.__name__, self.id, self.resource_id)
self.disconnect()
def connect(self, connect_args=None):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_INITIALIZED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
self.stream_pub = StreamPublisher(process=self, stream=self.stream_name)
args = dict_merge(self.agent_config, connect_args) if connect_args else self.agent_config
res = self.on_connect(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
def on_connect(self, connect_args=None):
pass
def start_streaming(self, streaming_args=None):
if self.current_state == self.AGENTSTATE_STREAMING:
return
if self.current_state == self.AGENTSTATE_INITIALIZED:
self.connect(self.agent_config)
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
log.info("Start streaming")
try:
args = dict_merge(self.agent_config, streaming_args) if streaming_args else self.agent_config
res = self.on_start_streaming(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_STREAMING
def on_start_streaming(self, streaming_args=None):
pass
def stop_streaming(self):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_STREAMING:
raise BadRequest("Illegal agent state: %s" % self.current_state)
log.info("Stop streaming")
try:
res = self.on_stop_streaming()
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
def on_stop_streaming(self):
pass
def acquire_data(self, streaming_args=None):
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
args = dict_merge(self.agent_config, streaming_args) if streaming_args else self.agent_config
res = self.on_acquire_data(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
def on_acquire_data(self, streaming_args=None):
pass
def disconnect(self):
if self.current_state in self.AGENTSTATE_INITIALIZED:
return
if self.current_state == self.AGENTSTATE_STREAMING:
self.stop_streaming()
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
res = self.on_disconnect()
self.stream_pub.close()
self.stream_pub = None
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_INITIALIZED
def on_disconnect(self):
pass
def get_status(self):
agent_status = dict(current_state=self.current_state)
agent_status = self.on_get_status(agent_status)
return agent_status
def on_get_status(self, agent_status):
return agent_status
def get_params(self, param_list=None):
if param_list:
return {k: v for (k, v) in self.params.iteritems() if k in param_list}
else:
return self.params
def set_params(self, params=None):
self.params.update(params)
def on_set_params(self, params=None):
pass
class InstrumentSimulator(ApeComponent):
def __init__(self, component_id, agent, configuration):
ApeComponent.__init__(self, component_id, agent, configuration)
model_id = None
keep_running = True
emit_granules = False
thread = None
def _start(self):
# interact with container
self.resource_registry = ResourceRegistryServiceClient(node=self.agent.container.node)
self.pubsubclient = PubsubManagementServiceClient(node=self.agent.container.node)
self.imsclient = InstrumentManagementServiceClient(node=self.agent.container.node)
self.damsclient = DataAcquisitionManagementServiceClient(node=self.agent.container.node)
self.data_product_client = DataProductManagementServiceClient(node=self.agent.container.node)
# add appropriate entries to the pycc registry
if self.configuration.easy_registration:
self.register()
# begin loop to generate/send data
self.thread = self._DataEmitter(self)
self.thread.start()
def _stop(self):
log.debug("stopping instrument")
self.stop_sending()
self.keep_running = False
def perform_action(self, request):
log.debug('instrument simulator performing action ' + str(request))
if isinstance(request, StartRequest):
self.start_sending()
elif isinstance(request, StopRequest):
self.stop_sending()
elif isinstance(request, RegisterWithContainer):
self.register()
else:
raise ApeException('instrument simulator does not know how to: ' + str(request))
def register(self):
''' create entries in resource registry for this instrument '''
# TODO: handle more than one ID returned from registry
# TODO: fail if request register but already in registry (and not easy_registration)
# TODO: should register device agent
log.debug('registering instrument')
product_ids,_ = self.resource_registry.find_resources(RT.DataProduct, None, self.configuration.data_product, id_only=True)
if len(product_ids) > 0:
log.debug('data product was already in the registry')
self.data_product_id = product_ids[0]
# if self.configuration.easy_registration:
# self.data_product_id = product_ids[0]
# else:
# #raise ApeException('should not find data product in registry until i add it: ' + self.configuration.data_product)
# ## TODO need ID from name: self.data_product_id = self.data_product_client.read_data_product(data_product=self.configuration.data_product)
# pass
else:
log.debug('adding data product to the registry')
# Create InstrumentDevice
device = IonObject(RT.InstrumentDevice, name=self.configuration.data_product, description='instrument simulator', serial_number=self.configuration.data_product )
device_id = self.imsclient.create_instrument_device(instrument_device=device)
self.imsclient.assign_instrument_model_to_instrument_device(instrument_model_id=self._get_model_id(), instrument_device_id=device_id)
#@TODO: Do not use CoverageCraft ever.
craft = CoverageCraft
sdom, tdom = craft.create_domains()
sdom = sdom.dump()
tdom = tdom.dump()
parameter_dictionary = craft.create_parameters()
parameter_dictionary = parameter_dictionary.dump()
data_product = IonObject(RT.DataProduct,name=self.configuration.data_product,description='ape producer', spatial_domain=sdom, temporal_domain=tdom)
stream_def_id = self._get_streamdef_id(parameter_dictionary)
self.data_product_id = self.data_product_client.create_data_product(data_product=data_product, stream_definition_id=stream_def_id)
self.damsclient.assign_data_product(input_resource_id=device_id, data_product_id=self.data_product_id)
if self.configuration.persist_product:
self.data_product_client.activate_data_product_persistence(data_product_id=self.data_product_id, persist_data=True, persist_metadata=True)
# get/create producer id
# producer_ids, _ = self.clients.resource_registry.find_objects(self.data_product_id, PRED.hasDataProducer, RT.DataProducer, id_only=True)
# if len(producer_ids)>0:
# log.debug('data producer already in the registry')
# self.data_producer_id = producer_ids[0]
# else:
self.data_producer_id = 'UNUSED'
self._create_publisher()
def _get_model_id(self):
if self.model_id is None:
try:
self.model_id = self._read_model_id()
self.model_id = self._read_model_id()
except:
model = IonObject(RT.InstrumentModel, name=self.configuration.instrument.model_name) #, description=self.configuration.model_name, model_label=self.data_source_name)
self.model_id = self.imsclient.create_instrument_model(model)
return self.model_id
def _read_model_id(self):
# debug reading instrument model
try_this = self.resource_registry.find_resources(restype=RT.InstrumentModel, id_only=True)
model_ids = self.resource_registry.find_resources(restype=RT.InstrumentModel, id_only=True, name=self.configuration.instrument.model_name)
return model_ids[0][0]
def _get_streamdef_id(self, pdict=None):
#TODO: figure out how to read existing RAW definition instead of just creating
#try:
#stream_type = self.pubsubclient.read_stream_definition()
stream_def_id = self.pubsubclient.create_stream_definition(name='RAW stream',parameter_dictionary=pdict)
return stream_def_id
def _create_publisher(self):
stream_ids, _ = self.resource_registry.find_objects(self.data_product_id, PRED.hasStream, None, True)
stream_id = stream_ids[0]
self.publisher = StreamPublisher(process=self.agent, stream_id=stream_id)
class _DataEmitter(Thread):
''' do not make outer class a Thread b/c start() is already meaningful to a pyon process '''
def __init__(self, instrument):
Thread.__init__(self)
self.instrument = instrument
self.daemon = True
def run(self):
self.instrument.run()
def start_sending(self):
self.emit_granules = True
def stop_sending(self):
self.emit_granules = False
def _get_parameter_dictionary(self):
pdict = ParameterDictionary()
cond_ctxt = ParameterContext('salinity', param_type=QuantityType(value_encoding=np.float64))
cond_ctxt.uom = 'unknown'
cond_ctxt.fill_value = 0e0
pdict.add_context(cond_ctxt)
pres_ctxt = ParameterContext('lat', param_type=QuantityType(value_encoding=np.float64))
pres_ctxt.uom = 'unknown'
pres_ctxt.fill_value = 0x0
pdict.add_context(pres_ctxt)
temp_ctxt = ParameterContext('lon', param_type=QuantityType(value_encoding=np.float64))
temp_ctxt.uom = 'unknown'
temp_ctxt.fill_value = 0x0
pdict.add_context(temp_ctxt)
oxy_ctxt = ParameterContext('oxygen', param_type=QuantityType(value_encoding=np.float64))
oxy_ctxt.uom = 'unknown'
oxy_ctxt.fill_value = 0x0
pdict.add_context(oxy_ctxt)
internal_ts_ctxt = ParameterContext(name='internal_timestamp', param_type=QuantityType(value_encoding=np.float64))
internal_ts_ctxt._derived_from_name = 'time'
internal_ts_ctxt.uom = 'seconds'
internal_ts_ctxt.fill_value = -1
pdict.add_context(internal_ts_ctxt, is_temporal=True)
driver_ts_ctxt = ParameterContext(name='driver_timestamp', param_type=QuantityType(value_encoding=np.float64))
driver_ts_ctxt._derived_from_name = 'time'
driver_ts_ctxt.uom = 'seconds'
driver_ts_ctxt.fill_value = -1
pdict.add_context(driver_ts_ctxt)
return pdict
def run(self):
try:
self.do_run()
except:
log.exception('instrument simulator thread shutting down')
def do_run(self):
''' main loop: essentially create granule, publish granule, then pause to remain at target rate.
three lines of the useful code marked with ###, everything else is timing/reporting.
'''
target_iteration_time = sleep_time = self.configuration.interval
first_batch = True
granule_count = iteration_count = granule_sum_size = 0
granule_elapsed_seconds = publish_elapsed_seconds = sleep_elapsed_seconds = iteration_elapsed_seconds = 0.
do_timing = self.configuration.report_timing or self.configuration.log_timing
parameter_dictionary = self._get_parameter_dictionary() #DatasetManagementServiceClient(node=self.agent.container.node).read_parameter_dictionary_by_name('ctd_parsed_param_dict')
if not parameter_dictionary:
log.error('failed to find parameter dictionary: ctd_parsed_param_dict (producer thread aborting)')
return
if type(parameter_dictionary) == dict:
log.debug('pdict is dict')
elif isinstance(parameter_dictionary,ParameterDictionary):
log.debug('pdict is ParameterDictionary')
else:
log.warn('invalid pdict: %r', parameter_dictionary)
parameter_dictionary = parameter_dictionary.__dict__
while self.keep_running:
if self.emit_granules:
adjust_timing = True
iteration_start = granule_start = time()
if do_timing:
granule_count+=1
### step 1: create granule
granule = self.configuration.instrument.get_granule(time=time(), pd=parameter_dictionary)
if do_timing:
granule_end = publish_start = time()
try:
### step 2: publish granule
log.debug(self.component_id + ' publishing granule')
self.publisher.publish(granule)
except Exception as e:
if self.keep_running:
raise e
else:
# while blocking on publish(), async call may have closed connection
# so eat exception and return cleanly
return
if do_timing:
publish_end = time()
granule_elapsed_seconds += (granule_end - granule_start)
publish_elapsed_seconds += (publish_end - publish_start)
pickled_granule = pickle.dumps(granule)
granule_size = len(pickled_granule)
granule_sum_size += granule_size
sleep_start = time()
### step 3: sleep to maintain configured rate
if sleep_time>0 or self.configuration.sleep_even_zero:
sleep(sleep_time)
if do_timing:
sleep_end = time()
sleep_elapsed_seconds += (sleep_end-sleep_start)
if granule_count%self.configuration.timing_rate==0:
# skip initial batch of timing -- can be skewed b/c one instrument start before the other,
# so first instrument works against a more idle system
if first_batch:
granule_count = granule_elapsed_seconds = publish_elapsed_seconds = sleep_elapsed_seconds = 0.
first_batch = False
run_start_time = time()
else:
adjust_timing = False
if self.configuration.log_timing:
log.info('%s: granule: %f, publish: %f, sleep: %f, size %f' %
(self.configuration.data_product, granule_elapsed_seconds/granule_count,
publish_elapsed_seconds/granule_count, sleep_elapsed_seconds/granule_count,
granule_sum_size/granule_count))
if self.configuration.report_timing:
report = { 'count': granule_count,
'time': time() - run_start_time,
'publish':publish_elapsed_seconds/granule_count,
'granule':granule_elapsed_seconds/granule_count,
'sleep': sleep_elapsed_seconds/granule_count,
'iteration': iteration_elapsed_seconds/iteration_count }
if self.configuration.include_size:
report['size'] = granule_sum_size
message = PerformanceResult(report)
self.report(message)
if adjust_timing:
iteration_count+=1
iteration_end = time()
actual_iteration_time = iteration_end - iteration_start
iteration_elapsed_seconds += actual_iteration_time
adjustment = target_iteration_time - actual_iteration_time
sleep_time = max(sleep_time + adjustment, 0)
else:
# if not emitting granules, don't do timing either
# and don't allow to sleep for too short a time and hog CPU
sleep(max(10,self.configuration.interval))
log.debug('not emitting')
def _create_publisher(self):
stream_ids, _ = self.resource_registry.find_objects(self.data_product_id, PRED.hasStream, None, True)
stream_id = stream_ids[0]
self.publisher = StreamPublisher(process=self.agent, stream_id=stream_id)
class StreamingAgent(BaseStreamingAgent):
# Constants
AGENTSTATE_NEW = "new"
AGENTSTATE_INITIALIZED = "initialized"
AGENTSTATE_CONNECTED = "connected"
AGENTSTATE_STREAMING = "streaming"
AGENTSTATE_ERROR = "error"
# ION process type
name = "streaming_agent"
process_type = "agent"
# Instance defaults (public)
resource_type = "streaming_agent"
resource_id = None
agent_id = None
agent_def_id = None
agent_type = "agent"
# Instance defaults (local)
current_state = AGENTSTATE_NEW
params = {}
agent_plugin = None
stream_name = None
def on_init(self):
log.info("Start agent %s pid=%s resource_id=%s",
self.__class__.__name__, self.id, self.resource_id)
self.current_state = self.AGENTSTATE_INITIALIZED
self.agent_config = self.CFG.get_safe("agent_config") or {}
self.params = {}
self.agent_plugin = None
self.stream_name = self.agent_config.get(
"stream_name", None) or "stream_" + self.resource_id
if "plugin" in self.agent_config:
agent_plugin_cls = named_any(self.agent_config["plugin"])
log.info("Instantiate agent plugin '%s'",
self.agent_config["plugin"])
self.agent_plugin = agent_plugin_cls(self, self.agent_config)
if self.agent_config.get("auto_streaming", False) is True:
self.connect()
self.start_streaming()
def on_stop(self):
pass
def on_quit(self):
if self.current_state in (self.AGENTSTATE_STREAMING,
self.AGENTSTATE_CONNECTED):
log.info("Terminate agent %s pid=%s resource_id=%s",
self.__class__.__name__, self.id, self.resource_id)
self.disconnect()
def connect(self, connect_args=None):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_INITIALIZED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
self.stream_pub = StreamPublisher(process=self,
stream=self.stream_name)
args = dict_merge(
self.agent_config,
connect_args) if connect_args else self.agent_config
res = self.on_connect(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
def on_connect(self, connect_args=None):
pass
def start_streaming(self, streaming_args=None):
if self.current_state == self.AGENTSTATE_STREAMING:
return
if self.current_state == self.AGENTSTATE_INITIALIZED:
self.connect(self.agent_config)
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
log.info("Start streaming")
try:
args = dict_merge(
self.agent_config,
streaming_args) if streaming_args else self.agent_config
res = self.on_start_streaming(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_STREAMING
def on_start_streaming(self, streaming_args=None):
pass
def stop_streaming(self):
if self.current_state == self.AGENTSTATE_CONNECTED:
return
elif self.current_state != self.AGENTSTATE_STREAMING:
raise BadRequest("Illegal agent state: %s" % self.current_state)
log.info("Stop streaming")
try:
res = self.on_stop_streaming()
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_CONNECTED
def on_stop_streaming(self):
pass
def acquire_data(self, streaming_args=None):
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
args = dict_merge(
self.agent_config,
streaming_args) if streaming_args else self.agent_config
res = self.on_acquire_data(args)
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
def on_acquire_data(self, streaming_args=None):
pass
def disconnect(self):
if self.current_state in self.AGENTSTATE_INITIALIZED:
return
if self.current_state == self.AGENTSTATE_STREAMING:
self.stop_streaming()
if self.current_state != self.AGENTSTATE_CONNECTED:
raise BadRequest("Illegal agent state: %s" % self.current_state)
try:
res = self.on_disconnect()
self.stream_pub.close()
self.stream_pub = None
except Exception:
self.current_state = self.AGENTSTATE_ERROR
raise
self.current_state = self.AGENTSTATE_INITIALIZED
def on_disconnect(self):
pass
def get_status(self):
agent_status = dict(current_state=self.current_state)
agent_status = self.on_get_status(agent_status)
return agent_status
def on_get_status(self, agent_status):
return agent_status
def get_params(self, param_list=None):
if param_list:
return {
k: v
for (k, v) in self.params.iteritems() if k in param_list
}
else:
return self.params
def set_params(self, params=None):
self.params.update(params)
def on_set_params(self, params=None):
pass
