fix metrics documentation typo (#89)

charlie-haley · Dec 19, 2023 · 028a2f7 · 028a2f7
1 parent 681af44
commit 028a2f7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -114,7 +114,7 @@ omada:
 |--|--|--|
 | omada_client_download_activity_bytes | The current download activity for the client in bytes. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid switch_port vlan_id |
 | omada_client_signal_pct | The signal quality for the wireless client in percent. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |
-| omada_client_snr_dbm | The signal to noise ration for the wireless client in dBm. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |
+| omada_client_snr_dbm | The signal to noise ratio for the wireless client in dBm. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |
 | omada_client_rssi_dbm | The RSSI for the wireless client in dBm. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |
 | omada_client_traffic_down_bytes | Total bytes received by wireless client. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |
 | omada_client_traffic_up_bytes | Total bytes sent by wireless client. | client vendor ip mac host_name site site_id connection_mode wifi_mode ap_name ssid |

diff --git a/pkg/collector/client.go b/pkg/collector/client.go
@@ -123,7 +123,7 @@ func NewClientCollector(c *api.Client) *clientCollector {
 		),
 
 		omadaClientSignalNoiseDbm: prometheus.NewDesc("omada_client_snr_dbm",
-			"The signal to noise ration for the wireless client in dBm.",
+			"The signal to noise ratio for the wireless client in dBm.",
 			client_labels,
 			nil,
 		),