lsst.dax.apdb.monitor.MonAgent Class Reference
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 = name | |
| _service = MonService() | |
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 is also passed to monitoring handler as ``agent_name``.
Definition at line 77 of file monitor.py.
Constructor & Destructor Documentation
◆ __init__()
| lsst.dax.apdb.monitor.MonAgent.__init__ | ( | self, | |
| str | name = "" ) |
Definition at line 88 of file monitor.py.
88 def __init__(self, name: str = ""):
89 self._name = name
90 self._service = MonService()
91
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 92 of file monitor.py.
99 ) -> None:
100 """Send one record to monitoring service.
101
102 Parameters
103 ----------
104 name : `str`
105 Record name, arbitrary string.
106 values : `~collections.abc.Mapping` [`str`, `Any`]
107 Values associated with the record, usually never empty.
108 tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
109 Tags associated with the record, may be empty.
110 timestamp : `str`
111 Time in seconds since UNIX epoch when record originated.
112 """
113 self._service._add_record(
114 agent_name=self._name,
115 record_name=name,
116 tags=tags,
117 values=values,
118 timestamp=timestamp,
119 )
120
◆ 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 121 of file monitor.py.
121 def context_tags(self, tags: _TagsType) -> AbstractContextManager[None]:
122 """Context manager that adds a set of tags to all records created
123 inside the context.
124
125 Parameters
126 ----------
127 tags : `~collections.abc.Mapping` [`str`, `str` or `int`]
128 Tags associated with the records.
129
130 Notes
131 -----
132 All calls to `add_record` that happen inside the corresponding context
133 will add tags specified in this call. Tags specified in `add_record`
134 will override matching tag names that are passed to this method. On
135 exit from context a previous tag context is restored (which may be
136 empty).
137 """
138 return self._service.context_tags(tags)
139
140
Member Data Documentation
◆ _name
|
protected |
Definition at line 89 of file monitor.py.
◆ _service
|
protected |
Definition at line 90 of file monitor.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/dax_apdb/gb88ae4c679+7dec8f19df/python/lsst/dax/apdb/monitor.py
Generated on Thu Nov 27 2025 09:15:10 for LSST Applications by
1.13.2