synapse 2.200.0__py311-none-any.whl → 2.202.0__py311-none-any.whl

synapse/cortex.py

@@ -5874,38 +5874,45 @@ class Cortex(s_oauth.OAuthMixin, s_cell.Cell):  # type: ignore
         if self.stormpool is None:  # pragma: no cover
             return None
 
-        if self.stormpool.size() == 0:
+        size = self.stormpool.size()
+        if size == 0:
             logger.warning('Storm query mirror pool is empty, running query locally.')
             return None
 
-        proxy = None
+        for _ in range(size):
 
-        try:
-            timeout = self.stormpoolopts.get('timeout:connection')
-            proxy = await self.stormpool.proxy(timeout=timeout)
-            proxyname = proxy._ahainfo.get('name')
-            if proxyname is not None and proxyname == self.ahasvcname:
-                # we are part of the pool and were selected. Convert to local use.
-                return None
+            try:
+                timeout = self.stormpoolopts.get('timeout:connection')
+                proxy = await self.stormpool.proxy(timeout=timeout)
+                proxyname = proxy._ahainfo.get('name')
+                if proxyname is not None and proxyname == self.ahasvcname:
+                    # we are part of the pool and were selected. Convert to local use.
+                    return None
+
+            except TimeoutError:
+                logger.warning('Timeout waiting for pool mirror proxy.')
+                continue
+
+            try:
+
+                curoffs = opts.setdefault('nexsoffs', await self.getNexsIndx() - 1)
+                miroffs = await s_common.wait_for(proxy.getNexsIndx(), timeout) - 1
+                if (delta := curoffs - miroffs) <= MAX_NEXUS_DELTA:
+                    return proxy
 
-            curoffs = opts.setdefault('nexsoffs', await self.getNexsIndx() - 1)
-            miroffs = await s_common.wait_for(proxy.getNexsIndx(), timeout) - 1
-            if (delta := curoffs - miroffs) > MAX_NEXUS_DELTA:
-                mesg = (f'Pool mirror [{proxyname}] Nexus offset delta too large '
-                        f'({delta} > {MAX_NEXUS_DELTA}), running query locally.')
+                mesg = f'Pool mirror [{proxyname}] is too far out of sync. Skipping.'
                 logger.warning(mesg, extra=await self.getLogExtra(delta=delta, mirror=proxyname, mirror_offset=miroffs))
-                return None
 
-            return proxy
+            except s_exc.IsFini:
+                mesg = f'Proxy for pool mirror [{proxyname}] was shutdown. Skipping.'
+                logger.warning(mesg, extra=await self.getLogExtra(mirror=proxyname))
 
-        except (TimeoutError, s_exc.IsFini):
-            if proxy is None:
-                logger.warning('Timeout waiting for pool mirror, running query locally.')
-            else:
-                mesg = f'Timeout waiting for pool mirror [{proxyname}] Nexus offset, running query locally.'
+            except TimeoutError:
+                mesg = f'Timeout waiting for pool mirror [{proxyname}] Nexus offset.'
                 logger.warning(mesg, extra=await self.getLogExtra(mirror=proxyname))
-                await proxy.fini()
-            return None
+
+        logger.warning('Pool members exhausted. Running query locally.', extra=await self.getLogExtra())
+        return None
 
     async def storm(self, text, opts=None):
 

synapse/datamodel.py

@@ -1160,10 +1160,9 @@ class Model:
         for propname, typedef, propinfo in iface.get('props', ()):
 
             # allow form props to take precedence
-            if form.prop(propname) is not None:
-                continue
+            if (prop := form.prop(propname)) is None:
+                prop = self._addFormProp(form, propname, typedef, propinfo)
 
-            prop = self._addFormProp(form, propname, typedef, propinfo)
             self.ifaceprops[f'{name}:{propname}'].append(prop.full)
 
             if subifaces is not None:

synapse/lib/agenda.py

@@ -260,6 +260,7 @@ class _Appt:
         'created',
         'enabled',
         'errcount',
+        'loglevel',
         'nexttime',
         'lasterrs',
         'isrunning',
@@ -269,7 +270,7 @@ class _Appt:
         'lastfinishtime',
     }
 
-    def __init__(self, stor, iden, recur, indx, query, creator, recs, nexttime=None, view=None, created=None, pool=False):
+    def __init__(self, stor, iden, recur, indx, query, creator, recs, nexttime=None, view=None, created=None, pool=False, loglevel=None):
         self.doc = ''
         self.name = ''
         self.task = None
@@ -284,6 +285,7 @@ class _Appt:
         self._recidxnexttime = None  # index of rec who is up next
         self.view = view
         self.created = created
+        self.loglevel = loglevel
 
         if self.recur and not self.recs:
             raise s_exc.BadTime(mesg='A recurrent appointment with no records')
@@ -364,7 +366,10 @@ class _Appt:
         if val['ver'] != 1:
             raise s_exc.BadStorageVersion(mesg=f"Found version {val['ver']}")  # pragma: no cover
         recs = [ApptRec.unpack(tupl) for tupl in val['recs']]
-        appt = cls(stor, val['iden'], val['recur'], val['indx'], val['query'], val['creator'], recs, nexttime=val['nexttime'], view=val.get('view'))
+        # TODO: MOAR INSANITY
+        loglevel = val.get('loglevel', 'WARNING')
+        appt = cls(stor, val['iden'], val['recur'], val['indx'], val['query'], val['creator'], recs,
+                   nexttime=val['nexttime'], view=val.get('view'), loglevel=loglevel)
         appt.doc = val.get('doc', '')
         appt.name = val.get('name', '')
         appt.pool = val.get('pool', False)
@@ -373,6 +378,7 @@ class _Appt:
         appt.lastfinishtime = val['lastfinishtime']
         appt.lastresult = val['lastresult']
         appt.enabled = val['enabled']
+        appt.lasterrs = list(val.get('lasterrs', []))
 
         return appt
 
@@ -422,8 +428,10 @@ class _Appt:
                 logger.warning('_Appt.edits() Invalid attribute received: %s = %r', name, valu, extra=extra)
                 continue
 
-            else:
-                setattr(self, name, valu)
+            if name == 'lasterrs' and not isinstance(valu, list):
+                valu = list(valu)
+
+            setattr(self, name, valu)
 
         await self.save()
 
@@ -559,6 +567,7 @@ class Agenda(s_base.Base):
         creator = cdef.get('creator')
         view = cdef.get('view')
         created = cdef.get('created')
+        loglevel = cdef.get('loglevel', 'WARNING')
 
         pool = cdef.get('pool', False)
 
@@ -603,7 +612,9 @@ class Agenda(s_base.Base):
                 incvals = (incvals, )
             recs.extend(ApptRec(rd, incunit, v) for (rd, v) in itertools.product(reqdicts, incvals))
 
-        appt = _Appt(self, iden, recur, indx, query, creator, recs, nexttime=nexttime, view=view, created=created, pool=pool)
+        # TODO: this is insane. Make _Appt take the cdef directly...
+        appt = _Appt(self, iden, recur, indx, query, creator, recs, nexttime=nexttime, view=view,
+                           created=created, pool=pool, loglevel=loglevel)
         self._addappt(iden, appt)
 
         appt.doc = cdef.get('doc', '')
@@ -841,7 +852,10 @@ class Agenda(s_base.Base):
                     extra={'synapse': {'iden': appt.iden, 'name': appt.name, 'user': user.iden, 'text': appt.query,
                                        'username': user.name, 'view': appt.view}})
         starttime = self._getNowTick()
+
         success = False
+        loglevel = s_common.normLogLevel(appt.loglevel)
+
         try:
             opts = {
                 'user': user.iden,
@@ -861,6 +875,11 @@ class Agenda(s_base.Base):
                 if mesg[0] == 'node':
                     count += 1
 
+                elif mesg[0] == 'warn' and loglevel <= logging.WARNING:
+                    text = mesg[1].get('mesg', '<missing message>')
+                    extra = await self.core.getLogExtra(cron=appt.iden, **mesg[1])
+                    logger.warning(f'Cron job {appt.iden} issued warning: {text}', extra=extra)
+
                 elif mesg[0] == 'err':
                     excname, errinfo = mesg[1]
                     errinfo.pop('eline', None)

synapse/lib/ast.py

@@ -217,13 +217,10 @@ class Query(AstNode):
                 genr = await stack.enter_async_context(contextlib.aclosing(oper.run(runt, genr)))
 
             async for node, path in genr:
-                runt.tick()
                 yield node, path
 
     async def iterNodePaths(self, runt, genr=None):
 
-        count = 0
-
         self.optimize()
         self.validate(runt)
 
@@ -231,18 +228,18 @@ class Query(AstNode):
         if genr is None:
             genr = runt.getInput()
 
+        count = 0
+        limit = runt.getOpt('limit')
+
         async with contextlib.aclosing(self.run(runt, genr)) as agen:
             async for node, path in agen:
 
-                runt.tick()
-
                 yield node, path
 
-                count += 1
-
-                limit = runt.getOpt('limit')
-                if limit is not None and count >= limit:
-                    break
+                if limit is not None:
+                    count += 1
+                    if count >= limit:
+                        break
 
 class Lookup(Query):
     '''

synapse/lib/base.py

@@ -128,7 +128,7 @@ class Base:
 
         self.isfini = False
         self.anitted = True  # For assertion purposes
-        self.finievt = None
+        self.finievt = asyncio.Event()
         self.entered = False
 
         # hold a weak ref to other bases we should fini if they
@@ -431,10 +431,7 @@ class Base:
         self._syn_funcs.clear()
         self._fini_funcs.clear()
 
-        fevt = self.finievt
-
-        if fevt is not None:
-            fevt.set()
+        self.finievt.set()
 
         return 0
 
@@ -468,13 +465,6 @@ class Base:
             base.waitfini(timeout=30)
 
         '''
-
-        if self.isfini:
-            return True
-
-        if self.finievt is None:
-            self.finievt = asyncio.Event()
-
         return await s_coro.event_wait(self.finievt, timeout)
 
     def schedCoro(self, coro):

synapse/lib/cell.py

@@ -2711,6 +2711,12 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
             raise s_exc.BadArg(mesg=mesg, arg='path', valu=path)
         await self._streamBackupArchive(path, user, name)
 
+    async def _removeStreamingBackup(self, path):
+        logger.debug(f'Removing {path}')
+        await s_coro.executor(shutil.rmtree, path, ignore_errors=True)
+        logger.debug(f'Removed {path}')
+        self.backupstreaming = False
+
     async def iterNewBackupArchive(self, user, name=None, remove=False):
 
         if self.backupstreaming:
@@ -2728,23 +2734,13 @@ class Cell(s_nexus.Pusher, s_telepath.Aware):
                 mesg = 'Backup with name already exists'
                 raise s_exc.BadArg(mesg=mesg)
 
-            try:
-                await self.runBackup(name)
-            except Exception:
-                if remove:
-                    logger.debug(f'Removing {path}')
-                    await s_coro.executor(shutil.rmtree, path, ignore_errors=True)
-                    logger.debug(f'Removed {path}')
-                raise
-
+            await self.runBackup(name)
             await self._streamBackupArchive(path, user, name)
 
         finally:
             if remove:
-                logger.debug(f'Removing {path}')
-                await s_coro.executor(shutil.rmtree, path, ignore_errors=True)
-                logger.debug(f'Removed {path}')
-                self.backupstreaming = False
+                self.removetask = asyncio.create_task(self._removeStreamingBackup(path))
+                await asyncio.shield(self.removetask)
 
     async def isUserAllowed(self, iden, perm, gateiden=None, default=False):
         user = self.auth.user(iden)  # type: s_auth.User

synapse/lib/parser.py

@@ -75,7 +75,7 @@ terminalEnglishMap = {
     'MODSET': '+= or -=',
     'MODSETMULTI': '++= or --=',
     'NONQUOTEWORD': 'unquoted value',
-    'NOT': 'not',
+    'NOTOP': 'not',
     'NULL': 'null',
     'NUMBER': 'number',
     'OCTNUMBER': 'number',
@@ -134,6 +134,7 @@ terminalEnglishMap = {
     '_LPARNOSPACE': '(',
     '_MATCHHASH': '#',
     '_MATCHHASHWILD': '#',
+    '_NOT': 'not',
     '_RETURN': 'return',
     '_REVERSE': 'reverse',
     '_RIGHTJOIN': '-+>',

synapse/lib/schemas.py

@@ -97,6 +97,7 @@ _CronJobSchema = {
         'name': {'type': 'string'},
         'pool': {'type': 'boolean'},
         'doc': {'type': 'string'},
+        'loglevel': {'type': 'string', 'enum': list(s_const.LOG_LEVEL_CHOICES.keys())},
         'incunit': {
             'oneOf': [
                 {'type': 'null'},

synapse/lib/storm.lark

@@ -437,7 +437,8 @@ _cond: notcond | "(" _condexpr ")"
     | condsubq | arraycond
     | _varvalu | _reqdollarexprs
 
-notcond: "not" _cond
+_NOT: "not"
+notcond: _NOT _cond
 
 hasrelpropcond: relprop | univprop
 relpropcond: relpropvalue _cmpr _valu
@@ -627,15 +628,15 @@ OCTNUMBER.1: /
 /x
 
 BOOL.2: /(true|false)(?=$|[\s\),\]}\|\=])/
-NULL.2: "null"
-NOT.2: "not"
+NULL.2: /null(?=$|[\s\),\]}\|\=])/
+NOTOP.2: /not(?=$|[\s\),\]}\|\=])/
 OR.2: "or"
 AND.2: "and"
 
 // $ expression rules in increasing order of precedence (modeled on Python's order)
 ?expror: exprand | expror OR exprand
 ?exprand: exprnot | exprand AND exprnot
-?exprnot: exprcmp | NOT exprcmp
+?exprnot: exprcmp | NOTOP exprcmp
 ?exprcmp: exprsum | exprcmp (CMPR | EQSPACE | EQNOSPACE) exprsum
 ?exprsum: exprproduct | exprsum (EXPRPLUS | EXPRMINUS) exprproduct
 ?exprproduct: exprunary | exprproduct (EXPRTIMES | EXPRDIVIDE | EXPRMODULO) exprunary

synapse/lib/storm.py

@@ -1,7 +1,6 @@
 import types
 import pprint
 import asyncio
-import hashlib
 import logging
 import argparse
 import contextlib
@@ -22,13 +21,10 @@ import synapse.lib.snap as s_snap
 import synapse.lib.cache as s_cache
 import synapse.lib.layer as s_layer
 import synapse.lib.scope as s_scope
-import synapse.lib.config as s_config
 import synapse.lib.autodoc as s_autodoc
-import synapse.lib.grammar as s_grammar
 import synapse.lib.msgpack as s_msgpack
 import synapse.lib.schemas as s_schemas
 import synapse.lib.spooled as s_spooled
-import synapse.lib.version as s_version
 import synapse.lib.hashitem as s_hashitem
 import synapse.lib.stormctrl as s_stormctrl
 import synapse.lib.stormtypes as s_stormtypes
@@ -1726,9 +1722,6 @@ class Runtime(s_base.Base):
     async def warnonce(self, mesg, **info):
         return await self.snap.warnonce(mesg, **info)
 
-    def tick(self):
-        pass
-
     def cancel(self):
         self.task.cancel()
 
@@ -1964,7 +1957,6 @@ class Runtime(s_base.Base):
                     nodegenr = subgraph.run(self, nodegenr)
 
                 async for item in nodegenr:
-                    self.tick()
                     yield item
 
         except RecursionError:
@@ -2847,7 +2839,8 @@ class BatchCmd(Cmd):
             mesg = f'Specified batch size ({size}) is above the maximum (10000).'
             raise s_exc.StormRuntimeError(mesg=mesg)
 
-        query = await runt.getStormQuery(self.opts.query)
+        _query = await s_stormtypes.tostr(self.opts.query)
+        query = await runt.getStormQuery(_query)
         doyield = await s_stormtypes.tobool(self.opts.cond)
 
         async with runt.getSubRuntime(query, opts={'vars': {'nodes': []}}) as subr:

synapse/lib/storm_format.py

@@ -57,7 +57,7 @@ TerminalPygMap = {
     'MODSET': p_t.Operator,
     'MODSETMULTI': p_t.Operator,
     'NONQUOTEWORD': p_t.Literal,
-    'NOT': p_t.Keyword,
+    'NOTOP': p_t.Operator,
     'NULL': p_t.Keyword,
     'NUMBER': p_t.Literal.Number,
     'OCTNUMBER': p_t.Literal.Number,
@@ -115,6 +115,7 @@ TerminalPygMap = {
     '_LPARNOSPACE': p_t.Punctuation,
     '_MATCHHASH': p_t.Punctuation,
     '_MATCHHASHWILD': p_t.Punctuation,
+    '_NOT': p_t.Keyword,
     '_RETURN': p_t.Keyword,
     '_REVERSE': p_t.Keyword,
     '_RIGHTJOIN': p_t.Punctuation,

synapse/lib/version.py

@@ -223,6 +223,6 @@ def reqVersion(valu, reqver,
 ##############################################################################
 # The following are touched during the release process by bumpversion.
 # Do not modify these directly.
-version = (2, 200, 0)
+version = (2, 202, 0)
 verstring = '.'.join([str(x) for x in version])
-commit = 'ab9ca513fe33d52df7a3122c0bf4eab6951b53d3'
+commit = '744d404357c48b663bd03528e35c6f0e186edb0e'

synapse/models/dns.py

@@ -147,7 +147,7 @@ class DnsModule(s_module.CoreModule):
 
                 ('inet:dns:txt', ('comp', {'fields': (('fqdn', 'inet:fqdn'), ('txt', 'str'))}), {
                     'ex': '(hehe.vertex.link,"fancy TXT record")',
-                    'doc': 'The result of a DNS MX record lookup.'}),
+                    'doc': 'The result of a DNS TXT record lookup.'}),
 
                 ('inet:dns:type', ('int', {}), {
                     'doc': 'A DNS query/answer type integer.'}),

synapse/models/economic.py

@@ -67,10 +67,10 @@ class EconModule(s_module.CoreModule):
                     'doc': 'A financial security which is typically traded on an exchange.'}),
 
                 ('econ:fin:bar', ('guid', {}), {
-                    'doc': 'A sample of the open, close, high, low prices of a security in a specific time window'}),
+                    'doc': 'A sample of the open, close, high, low prices of a security in a specific time window.'}),
 
                 ('econ:fin:tick', ('guid', {}), {
-                    'doc': 'A sample of the price of a security at a single moment in time'}),
+                    'doc': 'A sample of the price of a security at a single moment in time.'}),
 
                 ('econ:bank:account:type:taxonomy', ('taxonomy', {}), {
                     'doc': 'A bank account type taxonomy.'}),
@@ -192,10 +192,10 @@ class EconModule(s_module.CoreModule):
                         'doc': 'The campaign that the purchase was in support of.'}),
 
                     ('price', ('econ:price', {}), {
-                        'doc': 'The econ:price of the purchase'}),
+                        'doc': 'The econ:price of the purchase.'}),
 
                     ('currency', ('econ:currency', {}), {
-                        'doc': 'The econ:price of the purchase'}),
+                        'doc': 'The econ:price of the purchase.'}),
 
                     ('listing', ('biz:listing', {}), {
                         'doc': 'The purchase was made based on the given listing.'}),
@@ -283,10 +283,10 @@ class EconModule(s_module.CoreModule):
                         'doc': 'The purchase which the payment was paying for.'}),
 
                     ('amount', ('econ:price', {}), {
-                        'doc': 'The amount of money transferred in the payment'}),
+                        'doc': 'The amount of money transferred in the payment.'}),
 
                     ('currency', ('econ:currency', {}), {
-                        'doc': 'The currency of the payment'}),
+                        'doc': 'The currency of the payment.'}),
 
                     ('memo', ('str', {}), {
                         'doc': 'A small note specified by the payer common in financial transactions.'}),
@@ -339,66 +339,66 @@ class EconModule(s_module.CoreModule):
                 ('econ:fin:exchange', {}, (
 
                     ('name', ('str', {'lower': True, 'strip': True}), {
-                        'doc': 'A simple name for the exchange',
+                        'doc': 'A simple name for the exchange.',
                         'ex': 'nasdaq'}),
 
                     ('org', ('ou:org', {}), {
-                        'doc': 'The organization that operates the exchange'}),
+                        'doc': 'The organization that operates the exchange.'}),
 
                     ('currency', ('econ:currency', {}), {
-                        'doc': 'The currency used for all transactions in the exchange',
+                        'doc': 'The currency used for all transactions in the exchange.',
                         'ex': 'usd'}),
                 )),
 
                 ('econ:fin:security', {}, (
 
                     ('exchange', ('econ:fin:exchange', {}), {
-                        'doc': 'The exchange on which the security is traded'}),
+                        'doc': 'The exchange on which the security is traded.'}),
 
                     ('ticker', ('str', {'lower': True, 'strip': True}), {
-                        'doc': 'The identifier for this security within the exchange'}),
+                        'doc': 'The identifier for this security within the exchange.'}),
 
                     ('type', ('str', {'lower': True, 'strip': True}), {
-                        'doc': 'A user defined type such as stock, bond, option, future, or forex'}),
+                        'doc': 'A user defined type such as stock, bond, option, future, or forex.'}),
 
                     ('price', ('econ:price', {}), {
-                        'doc': 'The last known/available price of the security'}),
+                        'doc': 'The last known/available price of the security.'}),
 
                     ('time', ('time', {}), {
-                        'doc': 'The time of the last know price sample'}),
+                        'doc': 'The time of the last know price sample.'}),
                 )),
 
                 ('econ:fin:tick', {}, (
 
                     ('security', ('econ:fin:security', {}), {
-                        'doc': 'The security measured by the tick'}),
+                        'doc': 'The security measured by the tick.'}),
 
                     ('time', ('time', {}), {
-                        'doc': 'The time the price was sampled'}),
+                        'doc': 'The time the price was sampled.'}),
 
                     ('price', ('econ:price', {}), {
-                        'doc': 'The price of the security at the time'}),
+                        'doc': 'The price of the security at the time.'}),
                 )),
 
                 ('econ:fin:bar', {}, (
 
                     ('security', ('econ:fin:security', {}), {
-                        'doc': 'The security measured by the bar'}),
+                        'doc': 'The security measured by the bar.'}),
 
                     ('ival', ('ival', {}), {
-                        'doc': 'The interval of measurement'}),
+                        'doc': 'The interval of measurement.'}),
 
                     ('price:open', ('econ:price', {}), {
-                        'doc': 'The opening price of the security'}),
+                        'doc': 'The opening price of the security.'}),
 
                     ('price:close', ('econ:price', {}), {
-                        'doc': 'The closing price of the security'}),
+                        'doc': 'The closing price of the security.'}),
 
                     ('price:low', ('econ:price', {}), {
-                        'doc': 'The low price of the security'}),
+                        'doc': 'The low price of the security.'}),
 
                     ('price:high', ('econ:price', {}), {
-                        'doc': 'The high price of the security'}),
+                        'doc': 'The high price of the security.'}),
                 )),
 
                 ('econ:acct:invoice', {}, (

synapse/models/files.py

@@ -270,7 +270,7 @@ class FileModule(s_module.CoreModule):
                         ('file', ('file:bytes', {}), {
                             'doc': 'The Mach-O file containing the load command.'}),
                         ('type', ('int', {'enums': s_l_macho.getLoadCmdTypes()}), {
-                            'doc': 'The type of the load command'}),
+                            'doc': 'The type of the load command.'}),
                         ('size', ('int', {}), {
                             'doc': 'The size of the load command structure in bytes.'}),
                     ),
@@ -724,7 +724,7 @@ class FileModule(s_module.CoreModule):
                     ('sha256', ('hash:sha256', {}), {
                         'doc': 'The sha256 hash of the bytes of the Mach-O section.'}),
                     ('offset', ('int', {}), {
-                        'doc': 'The file offset to the beginning of the section'}),
+                        'doc': 'The file offset to the beginning of the section.'}),
                 )),
 
                 ('file:mime:lnk', {}, (

synapse/models/inet.py

@@ -1332,7 +1332,7 @@ class InetModule(s_module.CoreModule):
 
                     ('inet:ssl:cert', ('comp', {'fields': (('server', 'inet:server'), ('file', 'file:bytes'))}), {
                         'deprecated': True,
-                        'doc': 'Deprecated. Please use inet:tls:servercert or inet:tls:clientcert',
+                        'doc': 'Deprecated. Please use inet:tls:servercert or inet:tls:clientcert.',
                     }),
 
                     ('inet:port', ('int', {'min': 0, 'max': 0xffff}), {
@@ -3802,7 +3802,7 @@ class InetModule(s_module.CoreModule):
 
                         ('client:address', ('inet:client', {}), {
                             'deprecated': True,
-                            'doc': 'Deprecated. Please use :client'}),
+                            'doc': 'Deprecated. Please use :client.'}),
 
                         ('client:software', ('it:prod:softver', {}), {
                             'doc': 'The client software version used to send the message.'}),