@theotherwillembotha/node-red-plugincore 0.0.50

package/src/core/metrics/node/GaugeMetricConfigNode.html

@@ -0,0 +1,48 @@
+<script type="text/javascript" template-section="onCompose">
+    node
+        .addDefault("name", { value:"Metrics Example", required:true})
+        .addDefault("description", {value:"an example gauge", required:false})
+        .addDefault("reset", {value:false, required:false})
+        .setPaletteLabel("Gauge Metric Config")
+        .setLabel(function() {return this.name })
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditPrepare">
+    // enable the metrics by default and hide the Enable metrics button.
+    let metricsEnabled = $("#node-config-input-metricsEnabled");
+    metricsEnabled.prop('checked', true);
+    metricsEnabled.trigger("change");
+    $("#section_metricsconfig").find(".metricsEnableCheck").hide();
+
+
+</script>
+
+<script type="text/html" template-section="onIncludeEditForm">
+    <div id="MetricsConfig">
+        <div class="form-row">
+            <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-config-input-name">
+        </div>
+
+        <div class="form-row">
+            <label for="node-config-input-description"><i class="fa fa-tag"></i> Description</label>
+            <input type="text" id="node-config-input-description">
+        </div>
+
+        <div class="form-row">
+            <label></label>
+            <input type="checkbox" id="node-config-input-reset" style="width:20px; margin-right:5px;">
+            <label style="width:auto" for="node-config-input-reset"><span>Reset on Deploy</span></label>
+        </div>
+    </div>
+</script>
+
+
+<script type="text/markdown" template-section="onIncludeDocumentation">
+Configuration node for the Gauge Metrics
+
+### Inputs
+: *name*        (string) : The common name for the gauge.
+: *description* (string) : A description for the given gauge.
+
+</script>

package/src/core/metrics/node/GaugeMetricConfigNode.ts

@@ -0,0 +1,62 @@
+
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig, NodeDescriptor, NodeManager } from "../../NodeConstructor"
+import { MetricsContainer, MetricsService, GaugeMetricConfig, GaugeMetric, MetricsReference} from "../service/MetricsService"
+import { SourceUtility } from "../../NodeGenerator";
+import { MetricsConfigNode } from "./MetricsConfigNode";
+import { MetricsTemplate, MetricsTemplateConfig } from "../template/MetricsTemplate";
+import { NodeDescription } from "../../tagging/NodeDescriptionDecorator";
+
+interface GaugeMetricConfigNodeConfig extends ConfigNodeConfig, GaugeMetricConfig, MetricsTemplateConfig {
+    description:string,
+    reset:boolean
+}
+
+@NodeDescription({
+    id:"GaugeMetricConfigNode",
+    name:"Guage Metric Config Node",
+    group:"config",
+    sourceFile:SourceUtility.getSourcePath("/build/", "/src/") + "GaugeMetricConfigNode.html",
+    package: "@theotherwillembotha/node-red-plugincore",
+    templates: [
+        { template: MetricsTemplate, config: {}}
+    ],
+    dependencies:[ MetricsConfigNode, MetricsService ],
+    tags: [ "Core", "Metric" ]
+})
+export class GaugeMetricConfigNode extends ConfigNode<GaugeMetricConfigNodeConfig> {
+    private _metrics: MetricsContainer;
+    private _gauge: GaugeMetric;
+
+    constructor(node: Node, config: GaugeMetricConfigNodeConfig){
+        super(node, config);
+        let _this = this;
+
+        this._metrics = (NodeManager.RED.nodes.getNode(config.metricsReference) as any).node().metrics();
+        
+        let gaugeConfig:GaugeMetricConfig = {
+            metricname:config.name,
+            metricdescription:config.description,
+            node:{
+                id:this.id(),
+                flow:this.flow(),
+                type:this.type(),
+                name:this.name()
+            }
+        };
+        
+        this._gauge = this._metrics.guage(gaugeConfig);
+        
+        if(config.reset){
+            _this._gauge.reset();
+        }
+    }
+
+    public metrics():MetricsContainer {
+        return this._metrics;
+    }
+
+    public gauge():GaugeMetric {
+        return this._gauge;
+    }
+}

package/src/core/metrics/node/MetricsConfigNode.html

@@ -0,0 +1,21 @@
+<script type="text/javascript" template-section="onCompose">
+    node
+        .addDefault("name", { value:"Metrics Example", required:true})
+        .setPaletteLabel("Metrics Config")
+        .setLabel(function() {return this.name })
+</script>
+
+<script type="text/html" template-section="onIncludeEditForm">
+    <div id="MetricsConfig">
+        <div class="form-row">
+            <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-config-input-name" />
+        </div>
+    </div>
+</script>
+
+
+<script type="text/markdown" template-section="onIncludeDocumentation">
+### Inputs
+: *name*        (string) : The common name for the metrics integration.
+</script>

package/src/core/metrics/node/MetricsConfigNode.ts

@@ -0,0 +1,55 @@
+
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig, NodeDescriptor } from "../../NodeConstructor"
+import { MetricsContainer, MetricsService} from "../service/MetricsService"
+import { SourceUtility } from "../../NodeGenerator";
+import { WebhookTemplate, WebhookTemplateConfig } from "../../webhook/template/WebhookTemplate";
+import { Webhook } from "../../webhook/WebhookDecorator";
+import { EndpointMethodType } from "../../webhook/service/WebhookServerService";
+import  {register as PrometheusRegistry, } from "prom-client";
+import express, { Request, Response, Express } from 'express';
+import { NodeDescription } from "../../tagging/NodeDescriptionDecorator";
+
+/*
+Note: the MetricsConfigNode does not actually do the deployment of the metrics / repositories.
+The metrics / repositories are menanaged by the plugin and triggered when the flows are deployed.
+
+The reasoning for this is that the Metrics exist outside of the flow, but is configured using the flow.
+Basically, if the metrics arent changed, we dont have to redeploy the metrics, which means that
+stuff like coutners, guages and timers are not reset.
+*/
+interface MetricsConfigNodeConfig extends ConfigNodeConfig, WebhookTemplateConfig {
+}
+
+@NodeDescription({
+    id:"MetricsConfigNode",
+    name:"Metrics Config Node",
+    group:"config",
+    sourceFile:SourceUtility.getSourcePath("/build/", "/src/") + "MetricsConfigNode.html",
+    package: "@theotherwillembotha/node-red-plugincore",
+    templates:[
+        { template:WebhookTemplate, config: {} }
+    ],
+    dependencies:[ MetricsService ],
+    tags: [ ]
+})
+export class MetricsConfigNode extends ConfigNode<MetricsConfigNodeConfig> {
+    private _metrics!: MetricsContainer;
+
+    constructor(node: Node, config: MetricsConfigNodeConfig){
+        super(node, config);
+        let _this = this;
+
+        this._metrics = MetricsService.get({metricsEnabled:false, metricsReference:this.id()});
+    }
+
+    public metrics():MetricsContainer {
+        return this._metrics;
+    }
+
+    @Webhook({name:"MetricsConfigNode", methods:[EndpointMethodType.GET]})
+    private onWebhookRequest(request:Request, response:Response):void {
+        response.set('Content-Type', PrometheusRegistry.contentType);
+        this._metrics.registry().metrics().then((data:any) => response.status(200).send(data))
+    }
+}

package/src/core/metrics/node/TimerMetricConfigNode.html

@@ -0,0 +1,190 @@
+<script type="text/javascript" template-section="onCompose">
+    node
+        .addDefault("name", { value:"Timer Example", required:true})
+        .addDefault("description", {value:"an example gauge", required:false})
+        .addDefault("metricType", {required:true})
+        .addDefault("buckettype", {value:"Default", required:false})
+        .addDefault("buckettype_manual_intervals", {value:"0.001, 0.01, 0.1, 1, 2, 5", required:false})
+        .addDefault("buckettype_linear_start", {value:"0", required:false})
+        .addDefault("buckettype_linear_interval", {value:"5", required:false})
+        .addDefault("buckettype_linear_count", {value:"10", required:false})
+        .addDefault("buckettype_exponential_start", {value:"1", required:false})
+        .addDefault("buckettype_exponential_factor", {value:"2", required:false})
+        .addDefault("buckettype_exponential_count", {value:"10", required:false})
+        .addDefault("percentiletype", {value:"Default", required:false})
+        .addDefault("percentiletype_manual_intervals", {value:"0.01, 0.1, 0.9, 0.99", required:false})
+
+        .setPaletteLabel("Timer Metric Config")
+        .setLabel(function() {return this.name })
+
+</script>
+
+<script type="text/javascript" template-section="onIncludeEditPrepare">
+{
+    let node = this;
+        
+    // bucket generator selection
+    let selectBucketType = function(value){
+        $("#TimerMetricConfig").find(".metricsconfig_buckets").hide();
+        $("#TimerMetricConfig").find(`.metricsconfig_buckets_${value}`).show();
+    };
+    let bucketTypeSelection = $("#node-config-input-buckettype");
+    bucketTypeSelection.typedInput({type:"buckettype", types:[{
+        value: "buckettype",
+        options: [
+            { value: "default", label: "Default"},
+            { value: "manual", label: "Manual"},
+            { value: "linear", label: "Linear"},
+            { value: "exponential", label: "Exponential"},
+        ]
+    }]});
+    bucketTypeSelection.on("change", () => selectBucketType(bucketTypeSelection.val()));
+    selectBucketType(bucketTypeSelection.val());
+
+    // percentile type selection.
+    let selectPercentileType = function(value){
+        $("#TimerMetricConfig").find(".metricsconfig_percentiles").hide();
+        $("#TimerMetricConfig").find(`.metricsconfig_percentiles_${value}`).show();
+    }
+    let percentileTypeSelection = $("#node-config-input-percentiletype");
+    percentileTypeSelection.typedInput({type:"percentiletype", types:[{
+        value: "percentiletype",
+        options: [
+            { value: "default", label: "Default"},
+            { value: "manual", label: "Manual"},
+        ]
+    }]});
+    percentileTypeSelection.on("change", () => selectPercentileType(percentileTypeSelection.val()));
+    selectPercentileType(percentileTypeSelection.val());
+
+    // metric type selection.
+    let selectMetricType = function(value){
+        // show/hide the relevant metric type section.
+        $("#TimerMetricConfig").find(`.metrictype`).hide();
+        $("#TimerMetricConfig").find(`.metrictype_${value}`).show();
+
+        bucketTypeSelection.trigger("change");
+        percentileTypeSelection.trigger("change");
+    }
+    let metricTypeSelection = $("#node-config-input-metricType");
+    metricTypeSelection.typedInput({type:"metricType", types:[{
+        value: "metricType",
+        options: [
+            { value: "histogram", label: "Histogram"},
+            { value: "summary", label: "Summary"},
+        ]
+    }]});
+    metricTypeSelection.on("change", () => selectMetricType(metricTypeSelection.val()));
+    selectMetricType(metricTypeSelection.val());
+
+    // enable the metrics by default and hide the Enable metrics button.
+    let metricsEnabled = $("#node-config-input-metricsEnabled");
+    metricsEnabled.prop('checked', true);
+    metricsEnabled.trigger("change");
+    $("#section_metricsconfig").find(".metricsEnableCheck").hide();
+}
+</script>
+
+<script type="text/html" template-section="onIncludeEditForm">
+    <div id="TimerMetricConfig">
+        <div class="form-row">
+            <label class="towb_editorlabel" for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+            <input type="text" id="node-config-input-name" />
+        </div>
+
+        <div class="form-row">
+            <label class="towb_editorlabel" for="node-config-input-description"><i class="fa fa-tag"></i> Description</label>
+            <input type="text" id="node-config-input-description" />
+        </div>
+
+        <div class="form-row">
+            <label class="towb_editorlabel" for="node-config-input-metricType"><i class="fa fa-tag"></i> Type</label>
+            <input class="towb_editorfield" type="text" id="node-config-input-metricType" />
+        </div>
+
+        <div class="metrictype metrictype_histogram">
+            <div class="form-row">
+                <label class="towb_editorlabel" for="node-config-input-buckettype"><i class="fa fa-tag"></i> Bucket Type</label>
+                <input class="towb_editorfield" type="text" id="node-config-input-buckettype" />
+            </div>
+
+            <div class="metricsconfig_buckets metricsconfig_buckets_default">
+                <span>Default bucket sizes configured as 0.001, 0.01, 0.1, 1, 2, 5 seconds</span>
+            </div>
+
+            <div class="metricsconfig_buckets metricsconfig_buckets_manual">
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_manual_intervals"><i class="fa fa-tag"></i> Buckets</label>
+                    <input type="text" id="node-config-input-buckettype_manual_intervals" placeholder="0.001, 0.01, 0.1, 1, 2, 5", value="0.001, 0.01, 0.1, 1, 2, 5"/>
+                </div>
+            </div>
+
+            <div class="metricsconfig_buckets metricsconfig_buckets_linear">
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_linear_start"><i class="fa fa-tag"></i> Start</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_linear_start" placeholder="0.000", value="0.000"/>
+                </div>
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_linear_inteval"><i class="fa fa-tag"></i> Interval</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_linear_interval" placeholder="10", value="10"/>
+                </div>
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_linear_count"><i class="fa fa-tag"></i> Count</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_linear_count" placeholder="10", value="10"/>
+                </div>
+            </div>
+
+            <div class="metricsconfig_buckets metricsconfig_buckets_exponential">
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_exponential_start"><i class="fa fa-tag"></i> Start</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_exponential_start" placeholder="1", value="1"/>
+                </div>
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_exponential_factor"><i class="fa fa-tag"></i> Factor</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_exponential_factor" placeholder="2", value="2"/>
+                </div>
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-buckettype_exponential_count"><i class="fa fa-tag"></i> Count</label>
+                    <input class="towb_editorfield_short" type="text" id="node-config-input-buckettype_exponential_count" placeholder="10", value="10"/>
+                </div>
+            </div>
+        </div>
+
+        <div class="metrictype metrictype_summary">
+            <div class="form-row">
+                <label class="towb_editorlabel" for="node-config-input-percentiletype"><i class="fa fa-tag"></i> Percentile Type</label>
+                <input type="text" id="node-config-input-percentiletype" />
+            </div>
+
+            <div class="metricsconfig_percentiles metricsconfig_percentiles_default">
+                <span>Default percentille sizes configured as [0.01, 0.1, 0.9, 0.99]</span>
+            </div>
+
+            <div class="metricsconfig_percentiles metricsconfig_percentiles_manual">
+                <div class="form-row">
+                    <label class="towb_editorlabel" for="node-config-input-percentiletype_manual_intervals"><i class="fa fa-tag"></i> Percentiles</label>
+                    <input class="towb_editorfield" type="text" id="node-config-input-percentiletype_manual_intervals" placeholder="0.01, 0.1, 0.9, 0.99", value="0.01, 0.1, 0.9, 0.99"/>
+                </div>
+            </div>
+        </div>
+    </div>
+</script>
+
+
+<script type="text/markdown" template-section="onIncludeDocumentation">
+Configuration node for the Timer Metrics
+
+### Inputs
+: *name*        (string) : The common name for the timer.
+: *description* (string) : A description for the timer
+: *type* (string) : the type of timer metric ie. Histogram or Summary
+
+#### Histogram
+: *type* (string) : the type of timer metric ie. Histogram or Summary
+
+#### Summary
+: *percentile type* (string) : the type of percentile strategy. currently supported are default and manual
+: *percentiles* (string) : a comma separated list of percentiles to group observations into. note that the scale goes from 0 to 1.
+
+</script>
+

package/src/core/metrics/node/TimerMetricConfigNode.ts

@@ -0,0 +1,118 @@
+
+import { Node } from "node-red";
+import { ConfigNode, ConfigNodeConfig, NodeDescriptor, NodeManager } from "../../NodeConstructor"
+import { MetricsContainer, MetricsService, BucketType, HistogramMetric, HistogramMetricConfig, SummaryMetricConfig, PercentileType, SummaryMetric} from "../service/MetricsService"
+import { SourceUtility } from "../../NodeGenerator";
+import { MetricsConfigNode } from "./MetricsConfigNode";
+import { MetricsTemplate, MetricsTemplateConfig } from "../template/MetricsTemplate";
+import { MetricCollectorType } from "../MetricsDecorator";
+import { NodeDescription } from "../../tagging/NodeDescriptionDecorator";
+
+
+
+interface TimerMetricConfigNodeConfig extends ConfigNodeConfig, MetricsTemplateConfig {
+    description:string,
+    metricType: MetricCollectorType,
+
+    buckettype: BucketType,
+    buckettype_manual_intervals:string,
+    buckettype_linear_start:string,
+    buckettype_linear_interval:string,
+    buckettype_linear_count:string,
+    buckettype_exponential_start:string,
+    buckettype_exponential_factor:string,
+    buckettype_exponential_count:string,
+
+    percentiletype:PercentileType,
+    percentiletype_manual_intervals:string,
+}
+
+@NodeDescription({
+    id:"TimerMetricConfigNode",
+    name:"Timer Metric Config Node",
+    group:"config",
+    sourceFile:SourceUtility.getSourcePath("/build/", "/src/") + "TimerMetricConfigNode.html",
+    package: "@theotherwillembotha/node-red-plugincore",
+    templates: [
+        { template: MetricsTemplate, config: {isConfigNode:true}}
+    ],
+    dependencies:[ MetricsConfigNode, MetricsService ],
+    tags: [ "Core", "Metric" ]
+})
+export class TimerMetricConfigNode extends ConfigNode<TimerMetricConfigNodeConfig> {
+    private _metrics: MetricsContainer;
+    private _timer!: HistogramMetric|SummaryMetric;
+
+    constructor(node: Node, config: TimerMetricConfigNodeConfig){
+        super(node, config);
+        let _this = this;
+
+        this._metrics = (NodeManager.RED.nodes.getNode(config.metricsReference) as any).node().metrics();
+
+        let bucketConfig:any = {}
+
+        switch(config.buckettype){
+            case BucketType.default:{
+                // do nothing
+                break;
+            }
+            case BucketType.manual:{
+                bucketConfig.intervals = config.buckettype_manual_intervals.split(",").map(i => Number.parseFloat(i.trim()));
+                break;
+            }
+            case BucketType.linear:{
+                bucketConfig.start = config.buckettype_linear_start;
+                bucketConfig.interval = config.buckettype_linear_interval;
+                bucketConfig.count = config.buckettype_linear_count;
+                break;
+            }
+            case BucketType.exponential:{
+                bucketConfig.start = config.buckettype_exponential_start;
+                bucketConfig.factor = config.buckettype_exponential_factor;
+                bucketConfig.count = config.buckettype_exponential_count;
+                break;
+            }
+        }
+
+        if(config.metricType === MetricCollectorType.histogram){
+            let timerConfig:HistogramMetricConfig = {
+                node:{
+                    id: this.id(),
+                    name: this.name(),
+                    flow: this.flow(),
+                    type: this.type()
+                },
+                buckettype:config.buckettype,
+                bucketconfig:bucketConfig,
+                metricname:config.name,
+                metricdescription:config.description
+            }
+
+            this._timer = this._metrics.histogram(timerConfig);
+        }
+        if(config.metricType === MetricCollectorType.summary) {
+            let timerConfig:SummaryMetricConfig = {
+                node:{
+                    id: this.id(),
+                    name: this.name(),
+                    flow: this.flow(),
+                    type: this.type()
+                },
+                percentileType:config.percentiletype,
+                percentileConfig:config.percentiletype_manual_intervals,
+                metricname:config.name,
+                metricdescription:config.description,
+            }
+
+            this._timer = this._metrics.summary(timerConfig);
+        }
+    }
+
+    public metrics():MetricsContainer {
+        return this._metrics;
+    }
+
+    public timer():HistogramMetric|SummaryMetric {
+        return this._timer;
+    }
+}