Metadata-Version: 2.1
Name: prosafe-exporter
Version: 0.4.0
Summary: Prometheus metrics exporter for NETGEAR switches of the Smart Managed Plus series.
Home-page: https://github.com/tillsteinbach/prosafe_exporter_python
Author: Till Steinbach
License: MIT
Description: # prosafe_exporter_python
        [Prometheus](https://prometheus.io) metrics exporter for NETGEAR switches of the Smart Managed Plus series.
        
        ## Exported Metrics
        
        | metric                       | description                                    | labels                                   |
        | ---------------------------- | ---------------------------------------------- | ---------------------------------------- |
        | prosafe_switch_info          | Information about the switch exposed as labels | hostname, product_name, switch_name, serial_number, mac_adresse, bootloader_version, firmware_version, dhcp_mode, ip_adresse, subnetmask, gateway_adresse |
        | prosafe_receive_bytes_total  | Incoming transfer in bytes                     | hostname, port                           |
        | prosafe_transmit_bytes_total | Outgoing transfer in bytes                     | hostname, port                           |
        | prosafe_error_packets_total  | Transfer error in packets                      | hostname, port                           |
        | prosafe_link_speed           | Link speed in Mbps                             | hostname, port                           |
        | prosafe_max_mtu*             | Maximum MTU                                    | hostname, port                           |
        
        \* not available in all firmware versions
        
        ## Usage
        Setup a config.yml
        ```yml
        global: 
          retrieve_interval: 20.0
          retries: 10
          host: "0.0.0.0"
          port: 9493
        switches: 
          - hostname: "192.168.0.100"
            password: "password123"
          - hostname: "192.168.0.200"
            password: "password123"
        ```
        Run with:
        ```bash
        prosafe_exporter path/to/your/config.yml
        ```
        In prometheus configure a scrape job, e.g. like this:
        ```yml
        scrape_configs:
         - job_name: 'prosafe_switches'
            static_configs:
              - targets:
                - "prosafe_exporter:9493"
            metrics_path: /probe
            scrape_interval: 60s
        ```
        ## Query Example
        Outgoing data rate of port `1` on `192.168.0.123` is below.
        ```
        rate(prosafe_transmit_bytes_total{instance="192.168.0.123", port="1"}[1m])
        ```
        
        ## Tested Switches
        - GS108Ev3
        - GS108PEv3
        
        ## Tested Firmware
        - V2.06.14GR
        - V2.06.14EN
        -	V2.06.03EN
        
        ## Known Issues
        - May not work with older firmware, not all firmware versions are tested
        - Does not work with Japanese firmware
        
        ## Credits
        Inspired by [dalance/prosafe_exporter](https://github.com/dalance/prosafe_exporter/) that is providing the same functionality using the ProSAFE Plus utility instead of the switches webinterface
        
Keywords: prometheus,netgear,metrics-exporter,prosafe,prosafe-exporter
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: System :: Networking :: Monitoring 
Requires-Python: >=3.6
Description-Content-Type: text/markdown
