Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix client signal level bug, add client signal-to-noise ratio #88

Merged
merged 8 commits into from
Dec 18, 2023

Conversation

jfieber
Copy link
Contributor

@jfieber jfieber commented Dec 18, 2023

  • The client signal was being reported as dBm when it is, in fact a derived "connection quality" expressed as a percentage. This changes the metric name to be clear and not cause confusion over the same metric showing different semantics over time.
  • Add the client signal-to-noise ratio
  • Address what may be the issue in no hostname showing for some LAN clients #22. I'm not convinced falling back on Name in the absence of HostName is quite correct though. Maybe we should always use Name, and add the sometimes-there-sometimes-not HostName as a separate label? That would be more consistent with Omada's data model.
  • Add a different taken on generating the metrics description table in the Readme.

The HostName client field seems somewhat unreliable in practice. Fall back on the Name field if it is absent.

Maybe a fix for charlie-haley#22
@jfieber jfieber changed the title fix client signal level bug, add client signal-to-noise ration fix client signal level bug, add client signal-to-noise ratio Dec 18, 2023
This should guarantee docs matching the code, and replace the defunct metric-markdown-table.sh script.
@@ -48,6 +48,12 @@ func Run() {
os.Exit(0)
return nil
}},
{Name: "mdocs", Aliases: []string{"md"}, Usage: "prints the metric docs.",
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you update the Makefile to use this command instead of the script?

Remaining buglet: the version and mdocs commands shouldn’t require host, username and password arguments.
Formerly the client metrics `client` label was populated with the hostname provided by the controller. The hostname parameter is not reliably present.

This change populates the `client` label with the name value from the controller, and moves the hostname to a separate `hostname` label.

It is not 100% clear how Omada sets the name. A best guess is:

- If the name explicitly set a name in the Omada UI, that.
- If no name is explicitly set, and a hostname has been determined, use the hostname.
- If no name is explicitly set, and no hostname has been determined, us the mac address.
Copy link
Owner

@charlie-haley charlie-haley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@charlie-haley charlie-haley merged commit 681af44 into charlie-haley:main Dec 18, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants