Improve README.md

README.md

@@ -1,11 +1,13 @@
 # Vodafone Station Exporter
 Prometheus Exporter for the Vodafone Station (`CGA4233DE`)
 
-Exposes various information such as DOCSIS channel status.
-
 ## Usage
 ```
 Usage of ./vodafone-station-exporter:
+  -log.level string
+    	Logging level (default "info")
+  -show-metrics
+    	Show available metrics and exit
   -version
     	Print version and exit
   -vodafone.station-password string
@@ -18,6 +20,104 @@ Usage of ./vodafone-station-exporter:
     	Path under which to expose metrics (default "/metrics")
 ```
 
+## Exported metrics
+* `vodafone_station_login_success_bool`: 1 if the login was successfull
+* `vodafone_station_login_message_info`: Login message returned by the web interface
+  - Labels: `message`
+* `vodafone_station_user_info`: User name as returned by the web interface
+  - Labels: `username`
+* `vodafone_station_uid_info`: User id as returned by the web interface
+  - Labels: `uid`
+* `vodafone_station_default_password_bool`: 1 if the default password is in use
+* `vodafone_station_downstream_central_frequency_hertz`: Central frequency in hertz
+  - Labels: `id`, `channel_id`, `fft`, `channel_type`
+* `vodafone_station_downstream_power_dBmV`: Power in dBmV
+  - Labels: `id`, `channel_id`, `fft`, `channel_type`
+* `vodafone_station_downstream_snr_dB`: SNR in dB
+  - Labels: `id`, `channel_id`, `fft`, `channel_type`
+* `vodafone_station_downstream_snr_dB`: SNR in dB
+  - Labels: `id`, `channel_id`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_start_frequency_hertz`: Start frequency
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_end_frequency_hertz`: End frequency
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_central_frequency_hertz`: Central frequency
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_bandwidth_hertz`: Bandwidth
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_power_dBmV`: Power
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_snr_dB`: SNR
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_ofdm_downstream_locked_bool`: Locking status
+  - Labels: `id`, `channel_id_ofdm`, `fft`, `channel_type`
+* `vodafone_station_upstream_central_frequency_hertz`: Central frequency
+  - Labels: `id`, `channel_id_up`, `fft`, `channel_type`
+* `vodafone_station_upstream_power_dBmV`: Power
+  - Labels: `id`, `channel_id_up`, `fft`, `channel_type`
+* `vodafone_station_upstream_ranging_status_info`: Ranging status
+  - Labels: `id`, `channel_id_up`, `fft`, `channel_type`, `status`
+* `vodafone_station_firewall_status_info`: Firewall status
+  - Labels: `firewall_status`
+* `vodafone_station_lan_ip4_info`: LAN IPv4 info
+  - Labels: `lan_ip4`
+* `vodafone_station_lan_mode_info`: LAN mode info
+  - Labels: `mode`
+* `vodafone_station_lan_gateway_info`: LAN gateway info
+  - Labels: `lan_gateway`
+* `vodafone_station_lan_dhcp_enabled_bool`: LAN DHCP enabled info
+* `vodafone_station_lan_mac_address_info`: LAN MAC address
+  - Labels: `mac_address`
+* `vodafone_station_lan_port_up_bool`: LAN port status
+  - Labels: `port`
+* `vodafone_station_lan_port_speed_bits_per_second`: LAN port speed in bits/second
+  - Labels: `port`
+* `vodafone_station_wlan_enabled_bool`: WLAN enabled info
+  - Labels: `frequency`
+* `vodafone_station_wlan_channel`: WLAN channel
+  - Labels: `frequency`
+* `vodafone_station_wlan_bandwidth_hertz`: WLAN bandwidth in Hertz
+  - Labels: `frequency`
+* `vodafone_station_wlan_max_speed_bits_per_second`: Max WLAN speed in bits/seconds
+  - Labels: `frequency`
+* `vodafone_station_wlan_ssid_info`: SSID information
+  - Labels: `frequency`, `ssid`
+* `vodafone_station_wlan_mac_address_info`: WLAN MAC address
+  - Labels: `frequency`, `mac_address`
+* `vodafone_station_wlan_security_info`: WLAN security
+  - Labels: `frequency`, `security_info`
+* `vodafone_station_dns_entries_count`: DNS Entries count
+* `vodafone_station_aftr_info`: AFTR gateway information
+  - Labels: `aftr`
+* `vodafone_station_serialnumber_info`: Serial number information
+  - Labels: `serial_number`
+* `vodafone_station_firmwareversion_info`: Firmware vresion information
+  - Labels: `firmware_version`
+* `vodafone_station_hardware_type_info`: Hardware type information
+  - Labels: `hardware_type`
+* `vodafone_station_uptime_seconds`: Uptime in seconds
+* `vodafone_station_internet_ip4_info`: Internet IPv4
+  - Labels: `ip4`
+* `vodafone_station_delegated_prefix_info`: Delegated prefix information
+  - Labels: `prefix`
+* `vodafone_station_ip_address_rt_info`: IP address RT
+  - Labels: `ip`
+* `vodafone_station_ip_prefix_class_info`: IP prefix class info
+  - Labels: `prefix_class`
+* `vodafone_station_call_end_time_epoch`: Call endtime as unix epoch
+  - Labels: `port`, `id`, `external_number`, `direction`, `type`
+* `vodafone_station_call_start_time_epoch`: Call starttime as unix epoch
+  - Labels: `port`, `id`, `external_number`, `direction`, `type`
+* `vodafone_station_status_led_enabled_bool`: Status LEDs
+* `vodafone_station_software_component_info`: Information about software components
+  - Labels: `name`, `version`, `licsense`
+* `vodafone_station_sip_line_status_info`: Information about SIP registration status
+  - Labels: `port`, `status`
+* `vodafone_station_sip_line_numbers_info`: Information about phone numbers associated with SIP registration
+  - Labels: `port`, `number`
+* `vodafone_station_logout_success_bool`: 1 if the logout was successfull
+* `vodafone_station_logout_message_info`: Logout message returned by the web interface
+  - Labels: `message`
 
 ## Reverse Engineering the login mechanism
 > I am not a Javascript engineer, but it works :man_shrugging:
@@ -99,3 +199,5 @@ func DoPbkdf2NotCoded(key, salt string) string {
     return hex.EncodeToString(temp[:16])
 }
 ```
+
+Oh BTW, Vodafone: Performing `pbkdf2` twice won't secure an HTTP (non TLS) login.