This repository has been archived by the owner on Apr 2, 2024. It is now read-only.
Fix metric names #17
Merged
Fix metric names #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modified mqttclient's method to separate full metric's name into actual metric name and path, improving logging clarity and metric registration in the writing stage. The changes were made while validating the metric's type and recording them - the name and path are now correctly logged and registered, enhancing the tracking and categoricity of the metrics.
amrc-benmorrow
suggested changes
Aug 1, 2023
There was a problem hiding this comment.
I don't like attaching the type information in a way that conflicts with possible metric names. Even as a quick hack to deal with mistyped data, it would be better to use :i or /Int instead of _i. There might be value in recording the full Sparkplug datatype here, rather than using the InfluxDB type?
I don't understand InfluxDB well enough to understand the consequences of the renaming. I would be concerned that we will end up linking metrics with different sematics together, just because they happen to have the same basename.
In the mqttclient.ts, the manner in which metrics were being named for writing points has been altered. Previously, an underscore was used to separate the core metric name and its associated type annotation (i.e `${metricName}_x`). This has been changed to use a colon instead (`${metricName}:x`.
amrc-benmorrow
approved these changes
Aug 2, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Metrics are now stored in the InfluxDB database as the metric name, not the fully qualified path. Before,
Phases/1/VoltageandPhases/2/Voltagewould be two measurements. Now, they're bothVoltageand have aPathtag ofPhases/1andPhases/2respectively.The datatype has also been added on to the name of the metric. Not best practice (probably), but prevents errors from arising when a metric has the same name and a different type.