ZabbixProto 2.0.0__py3-none-any.whl

zabbixproto/__init__.py

@@ -0,0 +1,4 @@
+from .config import PROXY_VERSION, ResponseException
+from .client import Client
+from .proxypackets import Proxy, ProxyHeartbeatPacket, ProxyConfigPacket, ProxyDataPacket
+from .senderpackets import Sender, SenderDataPacket

zabbixproto/client.py

@@ -0,0 +1,88 @@
+import json
+import socket
+import time
+import struct
+import zlib
+
+
+class Response:
+    def __init__(self, json_str):
+        self.json = json_str
+        self.data = {}
+        self.__parse()
+
+    def __str__(self):
+        return self.json
+
+    def __getitem__(self, item):
+        return self.data[item]
+
+    def __parse(self):
+        try:
+            self.data = json.loads(self.json)
+        except:
+            self.data = {}
+            pass
+
+
+class Client:
+    def __init__(self, server='127.0.0.1', port='10051'):
+        self.server = server
+        self.port = port
+
+    def __str__(self):
+        return json.dumps({'server': self.server,
+                           'port': self.port},
+                          indent=4)
+
+    def send(self, data):
+        packetData = str(data).encode('utf-8')
+        socket.setdefaulttimeout(60)
+        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+
+        s.connect((self.server, int(self.port)))
+
+        data_length = len(packetData)
+        data_header = struct.pack('<Q', data_length)
+        packet = b'ZBXD\x01' + data_header + packetData
+
+        s.sendall(packet)
+        time.sleep(0.5)
+
+        # Read header (13 bytes minimum: ZBXD + flags + 8 byte length)
+        header = b''
+        while len(header) < 13:
+            chunk = s.recv(13 - len(header))
+            if not chunk:
+                break
+            header += chunk
+
+        if len(header) < 13 or header[0:4] != b'ZBXD':
+            s.close()
+            return Response('')
+
+        flags = header[4]
+        compressed = (flags & 0x02) != 0
+
+        if compressed:
+            # Compressed: first 4 bytes of length = compressed size, next 4 = original size
+            compressed_len = struct.unpack('<I', header[5:9])[0]
+            original_len = struct.unpack('<I', header[9:13])[0]
+            datalen = compressed_len
+        else:
+            datalen = struct.unpack('<Q', header[5:13])[0]
+
+        # Read body
+        body = b''
+        while len(body) < datalen:
+            chunk = s.recv(min(4096, datalen - len(body)))
+            if not chunk:
+                break
+            body += chunk
+
+        s.close()
+
+        if compressed:
+            body = zlib.decompress(body)
+
+        return Response(body.decode('utf-8'))

zabbixproto/config.py

@@ -0,0 +1,5 @@
+PROXY_VERSION = "7.0.0"
+
+
+class ResponseException(Exception):
+    pass

zabbixproto/proxypackets.py

@@ -0,0 +1,161 @@
+from datetime import datetime
+import json
+import uuid
+
+from zabbixproto import PROXY_VERSION, ResponseException, Client
+
+
+class Proxy:
+    def __init__(self, proxy_name, server_ip, server_port):
+        self.proxy_name = proxy_name
+        self.server_ip = server_ip
+        self.server_port = server_port
+        self.client = Client(self.server_ip, self.server_port)
+        self.session = uuid.uuid4().hex
+        self.config_revision = 0
+
+    def send_heartbeat(self):
+        packet = ProxyHeartbeatPacket(self.proxy_name)
+        self.sendWithResponse(packet)
+
+    def sendWithResponse(self, packet):
+        resp = self.client.send(packet)
+        if 'response' not in resp.data:
+            raise ResponseException('no response')
+        elif resp.data['response'] != 'success':
+            if 'info' in resp.data:
+                raise ResponseException("[{}]".format(resp.data['info']))
+            else:
+                raise ResponseException('unknown failure: {}'.format(resp))
+        return (resp.data['info'] if 'info' in resp.data else '')
+
+    def get_config(self):
+        packet = ProxyConfigPacket(self.proxy_name, self.session, self.config_revision)
+        resp = self.client.send(packet)
+
+        if 'response' in resp.data and resp.data['response'] == 'failed':
+            raise ResponseException(resp.data['info'])
+
+        if 'config_revision' in resp.data:
+            self.config_revision = resp.data['config_revision']
+
+        return resp
+
+
+class ProxyHeartbeatPacket:
+    def __init__(self, proxy_name):
+        self.proxy_name = proxy_name
+        self.__reset()
+
+    def __str__(self):
+        return json.dumps(self.packet)
+
+    def __reset(self):
+        self.packet = {'request': 'proxy heartbeat',
+                       'host': self.proxy_name,
+                       'version': PROXY_VERSION}
+
+
+class ProxyConfigPacket:
+    def __init__(self, proxy_name, session, config_revision=0):
+        self.proxy_name = proxy_name
+        self.session = session
+        self.config_revision = config_revision
+        self.__reset()
+
+    def __str__(self):
+        return json.dumps(self.packet)
+
+    def __reset(self):
+        self.packet = {'request': 'proxy config',
+                       'host': self.proxy_name,
+                       'version': PROXY_VERSION,
+                       'session': self.session,
+                       'config_revision': self.config_revision}
+
+
+class ProxyDataPacket:
+    def __init__(self, proxy_name, session=None):
+        self.proxy_name = proxy_name
+        self.session = session or uuid.uuid4().hex
+        self.__reset()
+
+    def __str__(self):
+        return json.dumps(self.packet)
+
+    def add_interface_availability(self, interfaceid, available, error=''):
+        if not (isinstance(available, int)) or available not in [0, 1, 2]:
+            raise TypeError('available must be int 0,1,2')
+
+        metric = {'interfaceid': int(interfaceid),
+                  'available': int(available),
+                  'error': error}
+
+        if 'interface availability' not in self.packet:
+            self.packet['interface availability'] = []
+
+        self.packet['interface availability'].append(metric)
+
+    # Backward-compatible alias
+    def add_host_availability(self, hostid=None, interfaceid=None, available=0, error='',
+                              snmp_available=None, snmp_error='',
+                              ipmi_available=None, ipmi_error='',
+                              jmx_available=None, jmx_error=''):
+        iid = interfaceid if interfaceid is not None else hostid
+        self.add_interface_availability(iid, available, error)
+
+    def add_history_data(self, itemid, value="", state=0, clock=datetime.now().timestamp(), ns=0):
+        if not (isinstance(clock, int)) and not (isinstance(clock, float)):
+            raise TypeError('Clock must be unixtime')
+
+        if not (isinstance(state, int)) and state not in [0, 1]:
+            raise TypeError('state must be int 0,1')
+
+        metric = {
+            'itemid': str(itemid),
+            'clock': int(clock),
+            'ns': int(ns),
+            'value': value,
+            'id': len(self.packet['history data']) + 1 if 'history data' in self.packet else 1,
+            'state': str(state),
+        }
+        if 'history data' not in self.packet:
+            self.packet['history data'] = []
+
+        self.packet['history data'].append(metric)
+
+    def add_autoregistration(self, host, ip="127.0.0.1", dns=None, port=None, host_metadata=None, clock=datetime.now().timestamp()):
+        if (isinstance(clock, int)) or (isinstance(clock, float)):
+            metric = {'host': str(host),
+                      'clock': int(clock),
+                      'ip': str(ip)}
+
+            if dns is not None:
+                metric['dns'] = str(dns)
+            if port is not None:
+                metric['port'] = str(port)
+            if host_metadata is not None:
+                metric['host_metadata'] = str(host_metadata)
+        else:
+            raise TypeError('Clock must be unixtime')
+
+        if 'auto registration' not in self.packet:
+            self.packet['auto registration'] = []
+        self.packet['auto registration'].append(metric)
+
+    def data_size(self):
+        size = 0
+        for l in ['interface availability', 'history data', 'discovery data', 'auto registration', 'tasks']:
+            if l in self.packet:
+                try:
+                    size += len(self.packet[l])
+                except Exception:
+                    pass
+        return size
+
+    def __reset(self):
+        self.packet = {'request': 'proxy data',
+                       'host': self.proxy_name,
+                       'session': self.session,
+                       'clock': int(datetime.now().timestamp()),
+                       'version': PROXY_VERSION}

zabbixproto/senderpackets.py

@@ -0,0 +1,41 @@
+from datetime import datetime
+import json
+
+from zabbixproto import PROXY_VERSION, ResponseException, Client
+
+
+class Sender:
+    def __init__(self, server_ip, server_port):
+        self.server_ip = server_ip
+        self.server_port = server_port
+        self.client = Client(self.server_ip, self.server_port)
+
+    def sendWithResponse(self, packet):
+        resp = self.client.send(packet)
+        if 'response' not in resp.data:
+            raise ResponseException('no response')
+        elif resp.data['response'] != 'success':
+            if 'info' in resp.data:
+                raise ResponseException("[{}]".format(resp.data['info']))
+            else:
+                raise ResponseException('unknown failure: {}'.format(resp))
+        return (resp.data['info'] if 'info' in resp.data else '')
+
+
+class SenderDataPacket:
+    def __init__(self, clock=None):
+        self.packet = {
+            'request': 'sender data',
+            'data': [],
+            'clock': datetime.now().timestamp() if clock == None else clock
+        }
+
+    def __str__(self):
+        return json.dumps(self.packet)
+
+    def add(self, host, key, value):
+        self.packet['data'].append({
+            "host": host,
+            "key": key,
+            "value": value
+        })

zabbixproto-2.0.0.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: ZabbixProto
+Version: 2.0.0
+Summary: Zabbix Communication Protocols
+Home-page: https://github.com/akomic/python-zabbix-proto
+Download-URL: https://github.com/akomic/python-zabbix-proto/archive/v2.0.0.tar.gz
+Author: Alen Komic
+Author-email: akomic@gmail.com
+License: Apache Software License
+Keywords: Zabbix Protocols Sender Proxy Agent
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Networking :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+License-File: LICENSE
+Requires-Dist: datetime
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: summary

zabbixproto-2.0.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+zabbixproto/__init__.py,sha256=wgjUbuJqAEeVnmVXzIm8Q4MbC0LMd_1jpfl42-xqbJM,222
+zabbixproto/client.py,sha256=imelR-qKO63s6iwya4fFShpaFBs0lSsvLgjrfFw_RhE,2273
+zabbixproto/config.py,sha256=_69etPJhKAmL1YTOoLfmRdM7e_HlZRTl4vSDs4X_pz0,71
+zabbixproto/proxypackets.py,sha256=EKG6uWlvkMxsvFYVq2sFQZ9S-sgAKq1BTPdsQDeu2pQ,5814
+zabbixproto/senderpackets.py,sha256=WXSOVjSu1iLX7jvMTa0hQLpfpvNBd9soKARqSpfknCY,1260
+zabbixproto-2.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zabbixproto-2.0.0.dist-info/METADATA,sha256=uyoa5e55B8SeEho-cqoUl8pKgnLCqbFt5lNKfF2CryE,912
+zabbixproto-2.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+zabbixproto-2.0.0.dist-info/top_level.txt,sha256=kN5_aRGrr2F8-Cy1JSuQ7XvV84NCskb0dTrd3Wb0FS4,12
+zabbixproto-2.0.0.dist-info/RECORD,,

zabbixproto-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

zabbixproto-2.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

zabbixproto-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+zabbixproto