Merge pull request #27717 from pass-by-value/proxy_beacon_example

Proxy beacon example

salt/beacons/__init__.py

@@ -73,6 +73,8 @@ class Beacon(object):
                     if 'id' not in data:
                         data['id'] = self.opts['id']
                     ret.append({'tag': tag, 'data': data})
+            else:
+                log.debug('Unable to process beacon {0}'.format(mod))
         return ret
 
     def _process_interval(self, mod, interval):

salt/beacons/proxy_example.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+'''
+Example beacon to use with salt-proxy
+
+.. code-block:: yaml
+
+    beacons:
+      proxy_example:
+        endpoint: beacon
+'''
+
+# Import Python libs
+from __future__ import absolute_import
+import logging
+
+# Import salt libs
+import salt.utils.http
+
+# Important: If used with salt-proxy
+# this is required for the beacon to load!!!
+__proxyenabled__ = ['*']
+
+__virtualname__ = 'proxy_example'
+
+log = logging.getLogger(__name__)
+
+
+def __virtual__():
+    '''
+    Trivially let the beacon load for the test example.
+    For a production beacon we should probably have some expression here.
+    '''
+    return True
+
+
+def validate(config):
+    '''
+    Validate the beacon configuration
+    '''
+    if not isinstance(config, dict):
+        log.info('Configuration for rest_example beacon must be a dictionary.')
+        return False
+    return True
+
+
+def beacon(config):
+    '''
+    Called several times each second
+    https://docs.saltstack.com/en/latest/topics/beacons/#the-beacon-function
+
+    .. code-block:: yaml
+
+        beacons:
+          proxy_example:
+            endpoint: beacon
+    '''
+    # Important!!!
+    # Although this toy example makes an HTTP call
+    # to get beacon information
+    # please be advised that doing CPU or IO intensive
+    # operations in this method will cause the beacon loop
+    # to block.
+    beacon_url = '{0}{1}'.format(__opts__['proxy']['url'],
+                                 config['endpoint'])
+    ret = salt.utils.http.query(beacon_url,
+                                decode_type='json',
+                                decode=True)
+    return [ret['dict']]