Public Member Functions
	__init__ (self, str name="")

None	add_record (self, str name, *Mapping[str, Any] values, Mapping[str, str\|int]\|None tags=None, float\|None timestamp=None)

AbstractContextManager[None]	context_tags (self, _TagsType tags)

Protected Attributes
	_name

	_service

Detailed Description

Client-side interface for adding monitoring records to the monitoring
service.

Parameters
----------
name : `str`
    Client agent name, this is used for filtering of the records by the
    service and ia also passed to monitoring handler as ``agent_name``.

Definition at line 71 of file monitor.py.

Constructor & Destructor Documentation

◆ init()

lsst.dax.apdb.monitor.MonAgent.__init__	(		self,
		str	name = "" )

Definition at line 82 of file monitor.py.

    def __init__(self, name: str = ""):
        self._name = name
        self._service = MonService()
 

Member Function Documentation

◆ add_record()

None lsst.dax.apdb.monitor.MonAgent.add_record	(		self,
		str	name,
		*Mapping[str, Any]	values,
		Mapping[str, str \| int] \| None	tags = None,
		float \| None	timestamp = None )

Send one record to monitoring service.

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

Definition at line 86 of file monitor.py.

    ) -> None:
        """Send one record to monitoring service.
 
        Parameters
        ----------
        name : `str`
            Record name, arbitrary string.
        values : `~collections.abc.Mapping` [`str`, `Any`]
            Values associated with the record, usually never empty.
        tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
            Tags associated with the record, may be empty.
        timestamp : `str`
            Time in seconds since UNIX epoch when record originated.
        """
        self._service._add_record(
            agent_name=self._name,
            record_name=name,
            tags=tags,
            values=values,
            timestamp=timestamp,
        )
 

◆ context_tags()

AbstractContextManager[None] lsst.dax.apdb.monitor.MonAgent.context_tags	(		self,
		_TagsType	tags )

Context manager that adds a set of tags to all records created
inside the context.

Parameters
----------
tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
    Tags associated with the records.

Notes
-----
All calls to `add_record` that happen inside the corresponding context
will add tags specified in this call. Tags specified in `add_record`
will override matching tag names that are passed to this method. On
exit from context a previous tag context is restored (which may be
empty).

Definition at line 115 of file monitor.py.

    def context_tags(self, tags: _TagsType) -> AbstractContextManager[None]:
        """Context manager that adds a set of tags to all records created
        inside the context.
 
        Parameters
        ----------
        tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
            Tags associated with the records.
 
        Notes
        -----
        All calls to `add_record` that happen inside the corresponding context
        will add tags specified in this call. Tags specified in `add_record`
        will override matching tag names that are passed to this method. On
        exit from context a previous tag context is restored (which may be
        empty).
        """
        return self._service.context_tags(tags)
 
 

Member Data Documentation

◆ _name

lsst.dax.apdb.monitor.MonAgent._name

protected

Definition at line 83 of file monitor.py.

◆ _service

lsst.dax.apdb.monitor.MonAgent._service

protected

Definition at line 84 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