kafkaopmon.OpMonSubscriber.OpMonFunction Class Reference

Public Member Functions
None	__init__ (self, Callable function, re.Pattern opmon_id, re.Pattern measurement)
bool	match (self, str key)
None	execute (self, entry.OpMonEntry e)

Public Attributes
	function = function
	opmon_id = opmon_id
	measurement = measurement

Detailed Description

Define callback function properties to store and validate function execution.

Definition at line 16 of file OpMonSubscriber.py.

Constructor & Destructor Documentation

__init__()

None kafkaopmon.OpMonSubscriber.OpMonFunction.__init__	(		self,
		Callable	function,
		re.Pattern	opmon_id,
		re.Pattern	measurement )

Construct the OpMonFunction.

Definition at line 19 of file OpMonSubscriber.py.

    ) -> None:
        """Construct the OpMonFunction."""
        self.function = function
        self.opmon_id = opmon_id
        self.measurement = measurement
        return
 

Member Function Documentation

execute()

None kafkaopmon.OpMonSubscriber.OpMonFunction.execute	(		self,
		entry.OpMonEntry	e )

Execute the function.

Definition at line 37 of file OpMonSubscriber.py.

    def execute(self, e: entry.OpMonEntry) -> None:
        """Execute the function."""
        self.function(e)
        return
 
 

match()

bool kafkaopmon.OpMonSubscriber.OpMonFunction.match	(		self,
		str	key )

Validate the key follows the standard structure.

Definition at line 28 of file OpMonSubscriber.py.

    def match(self, key: str) -> bool:
        """Validate the key follows the standard structure."""
        opmon_id, measure = key.split("/", 1)
        if not self.opmon_id.match(opmon_id):
            return False
        if not self.measurement.match(measure):
            return False
        return True
 

Member Data Documentation

function

kafkaopmon.OpMonSubscriber.OpMonFunction.function = function

Definition at line 23 of file OpMonSubscriber.py.

measurement

kafkaopmon.OpMonSubscriber.OpMonFunction.measurement = measurement

Definition at line 25 of file OpMonSubscriber.py.

opmon_id

kafkaopmon.OpMonSubscriber.OpMonFunction.opmon_id = opmon_id

Definition at line 24 of file OpMonSubscriber.py.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/kafkaopmon/python/kafkaopmon/OpMonSubscriber.py