Inheritance diagram for lsst.dax.apdb.monitor.LoggingMonHandler:

Public Member Functions
	__init__ (self, str logger_name, int log_level=logging.INFO)

None	handle (self, str name, float timestamp, _TagsType tags, Mapping[str, Any] values, str agent_name)

Protected Attributes
	_logger

	_level

Detailed Description

Implementation of the monitoring handler which dumps records formatted
as JSON objects to `logging`.

Parameters
----------
logger_name : `str`
    Name of the `logging` logger to use for output.
log_level : `int`, optional
    Logging level to use for output, default is `INFO`

Notes
-----
The attributes of the formatted JSON object correspond to the parameters
of `handle` method, except for `agent_name` which is mapped to `source`.
The `tags` and `values` become JSON sub-objects with corresponding keys.

Definition at line 337 of file monitor.py.

Constructor & Destructor Documentation

◆ init()

lsst.dax.apdb.monitor.LoggingMonHandler.__init__	(		self,
		str	logger_name,
		int	log_level = logging.INFO )

Definition at line 355 of file monitor.py.

    def __init__(self, logger_name: str, log_level: int = logging.INFO):
        self._logger = logging.getLogger(logger_name)
        self._level = log_level
 

Member Function Documentation

◆ handle()

None lsst.dax.apdb.monitor.LoggingMonHandler.handle	(		self,
		str	name,
		float	timestamp,
		_TagsType	tags,
		Mapping[str, Any]	values,
		str	agent_name )

Handle one monitoring record.

Parameters
----------
name : `str`
    Record name, arbitrary string.
timestamp : `str`
    Time in seconds since UNIX epoch when record originated.
tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
    Tags associated with the record, may be empty.
values : `~collections.abc.Mapping` [`str`, `Any`]
    Values associated with the record, usually never empty.
agent_name `str`
    Name of a client agent that produced this record.

Reimplemented from lsst.dax.apdb.monitor.MonHandler.

Definition at line 359 of file monitor.py.

    ) -> None:
        # Docstring is inherited from base class.
        record = {
            "name": name,
            "timestamp": timestamp,
            "tags": tags,
            "values": values,
            "source": agent_name,
        }
        msg = json.dumps(record)
        self._logger.log(self._level, msg)

Member Data Documentation

◆ _level

lsst.dax.apdb.monitor.LoggingMonHandler._level

protected

Definition at line 357 of file monitor.py.

◆ _logger

lsst.dax.apdb.monitor.LoggingMonHandler._logger

protected

Definition at line 356 of file monitor.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g88963caddf+0cb8e002cc/python/lsst/dax/apdb/monitor.py

Public Member Functions

Protected Attributes