Difference between revisions of "Adding a computed measurement"
From Senfi Docs
| Line 1: | Line 1: | ||
=== Pre-requisites === | === Pre-requisites === | ||
| − | A computed measurement requires design and | + | A computed measurement requires design and scripting in order for it to work correctly. If this is your first time creating a computed measurement, please read [[Computed_measurement|this guide]] first. |
You should also be similar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher. | You should also be similar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher. | ||
You should | You should | ||
| − | * Note down the source | + | * Note down the source measurements. |
* Note down the metrics you want to output. | * Note down the metrics you want to output. | ||
* Decide on a set of tags to use or re-use. Make sure that there is a combination of tags that will uniquely identify the unit/device/equipment that outputs those metrics. | * Decide on a set of tags to use or re-use. Make sure that there is a combination of tags that will uniquely identify the unit/device/equipment that outputs those metrics. | ||
| Line 20: | Line 20: | ||
# Select your Source Measurements | # Select your Source Measurements | ||
# Add tags. | # Add tags. | ||
| − | # Add metrics and specify the type of each metric. | + | # Add metrics and specify the type of each metric. |
| − | # Write the computed measurement script | + | # Write the computed measurement script. See [[Adding_a_computed_measurement#|Writing the Computed Measurement Script]] for more details. |
| − | # (Optional) Test the computed measurement | + | # (Optional) Test the computed measurement. See [[Adding_a_computed_measurement#|Testing the Computed Measurement]] for more details. |
# Save when done. | # Save when done. | ||
=== Writing the Computed Measurement Script === | === Writing the Computed Measurement Script === | ||
| + | |||
| + | |||
=== Testing the Computed Measurement === | === Testing the Computed Measurement === | ||
Revision as of 08:56, 17 September 2019
Contents
Pre-requisites
A computed measurement requires design and scripting in order for it to work correctly. If this is your first time creating a computed measurement, please read this guide first.
You should also be similar with the basic measurements and its concepts. Please read this section if you require a refresher.
You should
- Note down the source measurements.
- Note down the metrics you want to output.
- Decide on a set of tags to use or re-use. Make sure that there is a combination of tags that will uniquely identify the unit/device/equipment that outputs those metrics.
- Have the computed measurement script ready.
- (Optional) Have a set of test data for your computed measurement
Adding a New Computed Measurement
- Login to the CMS
- Go to the Computed Measurement tab
- Click the + button to add a new computed measurement.
- Give the measurement a descriptive name. This will be shown to users of the dashboard.
- Specify a measurement code.
- Select your Source Measurements
- Add tags.
- Add metrics and specify the type of each metric.
- Write the computed measurement script. See Writing the Computed Measurement Script for more details.
- (Optional) Test the computed measurement. See Testing the Computed Measurement for more details.
- Save when done.