GrafanaAdapters: Added meta-data substitution parameters for Label function when series values map directly to point tags.

J. Ritchie Carroll committed 9 years ago

Commit da0dc1b1 parent 0063ff64 files · +54 −4Browse files

Unified · Split

4 files

Source/Documentation/GrafanaFunctions.md +1 −1
Source/Libraries/Adapters/GrafanaAdapters/AnnotationExtensions.cs +17 −1
Source/Libraries/Adapters/GrafanaAdapters/DataSourceValueGroup.cs +5 −0
Source/Libraries/Adapters/GrafanaAdapters/GrafanaDataSourceBase.cs +31 −2

Source/Documentation/GrafanaFunctions.md+1−1

@@ -417,7 +417,7 @@ Returns a series of values that represent an adjusted set of angles that are wra · 416 unmodified lines
417		417
418	## Label	418	## Label
419		419
420	Renames a series with the specified label value. If multiple series are targeted, labels will be indexed starting at one, e.g., if there are three series in the target expression with a label value of "Max", series would be labeled as "Max 1", "Max 2" and "Max 3". Group operations on this function will be ignored.	420	Renames a series with the specified label value. If multiple series are targeted, labels will be indexed starting at one, e.g., if there are three series in the target expression with a label value of "Max", series would be labeled as "Max 1", "Max 2" and "Max 3". Group operations on this function will be ignored. The label parameter also supports substitutions when root target metadata can be resolved. For series values that directly map to a point tag, one of the following metadata value substitutions can be used in the label value: {ID}, {SignalID}, {PointTag}, {AlternateTag}, {SignalReference}, {Device} or {SignalType} - where applicable, these substitutions can be used in any combination.
421		421
422	* Signature: `Label(value, expression)`	422	* Signature: `Label(value, expression)`
423	* Returns: Series of values	423	* Returns: Series of values

Source/Libraries/Adapters/GrafanaAdapters/AnnotationExtensions.cs+17−1

@@ -340,7 +340,7 @@ namespace GrafanaAdapters · 339 unmodified lines
340	/// </remarks>	340	/// </remarks>
341	internal static MeasurementKey KeyFromTag(this string pointTag, DataSet source)	341	internal static MeasurementKey KeyFromTag(this string pointTag, DataSet source)
342	{	342	{
343	DataRow record = GetMetaData(source, "ActiveMeasurements", $"PointTag = '{pointTag}'");	343	DataRow record = pointTag.MetadataRecordFromTag(source);
344		344
345	if ((object)record == null)	345	if ((object)record == null)
346	return MeasurementKey.Undefined;	346	return MeasurementKey.Undefined;
@@ -355,6 +355,22 @@ namespace GrafanaAdapters · 8 unmodified lines
355	}	355	}
356	}	356	}
357		357
		358	/// <summary>
		359	/// Looks up metadata record from point tag.
		360	/// </summary>
		361	/// <param name="pointTag">Point tag to lookup.</param>
		362	/// <param name="source">Source metadata.</param>
		363	/// <returns>Metadata record from source metadata for provided point tag.</returns>
		364	/// <remarks>
		365	/// This function uses the <see cref="DataTable.Select(string)"/> function which uses a linear
		366	/// search algorithm that can be slow for large data sets, it is recommended that any results
		367	/// for calls to this function be cached to improve performance.
		368	/// </remarks>
		369	internal static DataRow MetadataRecordFromTag(this string pointTag, DataSet source)
		370	{
		371	return GetMetaData(source, "ActiveMeasurements", $"PointTag = '{pointTag}'");
		372	}
		373
358	private static DataRow GetMetaData(DataSet source, string table, string expression)	374	private static DataRow GetMetaData(DataSet source, string table, string expression)
359	{	375	{
360	try	376	try

Source/Libraries/Adapters/GrafanaAdapters/DataSourceValueGroup.cs+5−0

         /// </summary>
         public string Target;
+        /// <summary>
+        /// Defines the root target expression, without any referenced series functions.
+        /// </summary>
+        public string RootTarget;
         /// <summary>
         /// Data source values enumerable.
         /// </summary>

Source/Libraries/Adapters/GrafanaAdapters/GrafanaDataSourceBase.cs+31−2

         /// <summary>
         /// Renames a series with the specified label value. If multiple series are targeted, labels will be indexed starting at one, e.g., if there are three
         /// series in the target expression with a label value of "Max", series would be labeled as "Max 1", "Max 2" and "Max 3". Group operations on this
-        /// function will be ignored.
+        /// function will be ignored. The label parameter also supports substitutions when root target metadata can be resolved. For series values that directly
+        /// map to a point tag, one of the following metadata value substitutions can be used in the label value: {ID}, {SignalID}, {PointTag}, {AlternateTag},
+        /// {SignalReference}, {Device} or {SignalType} - where applicable, these substitutions can be used in any combination.
         /// </summary>
         /// <remarks>
         /// Signature: <c>Label(value, expression)</c><br/>
                     yield return new DataSourceValueGroup
                     {
                         Target = target.Value,
+                        RootTarget = target.Value,
                         Source = dataValues.Where(dataValue => dataValue.Target.Equals(target.Value))
                     };
             }
                 for (int i = 0; i < groups.Length; i++)
                 {
+                    string target = groups[i].RootTarget;
+                    string seriesLabel = TargetCache<string>.GetOrAdd($"{label}@{target}", () =>
+                    {
+                        string derivedLabel = label;
+                        DataRow record = target.MetadataRecordFromTag(Metadata);
+                        if ((object)record != null)
+                        {
+                            foreach (string fieldName in s_metadataRecordFields)
+                                derivedLabel = derivedLabel.ReplaceCaseInsensitive($"{{{fieldName}}}", record[fieldName].ToString());
+                        }
+                        if (derivedLabel.Equals(label, StringComparison.Ordinal))
+                            derivedLabel = $"{label}{(groups.Length > 1 ? $" {i + 1}" : "")}";
+                        return derivedLabel;
+                    });
                     yield return new DataSourceValueGroup
                     {
-                        Target = $"{label}{(groups.Length > 1 ? $" {i + 1}" : "")}",
+                        Target = seriesLabel,
+                        RootTarget = target,
                         Source = groups[i].Source
                     };
                 }
                         DataSourceValueGroup result = new DataSourceValueGroup
                         {
                             Target = $"Set{seriesFunction}({string.Join(", ", parameters)}{(parameters.Length > 0 ? ", " : "")}{targetExpression})",
+                            RootTarget = targetExpression,
                             Source = ExecuteSeriesFunctionOverSource(dataset.AsParallel().WithCancellation(cancellationToken).SelectMany(source => source.Source), seriesFunction, parameters)
                         };
                         {
                             DataSourceValue dataValue = result.Source.First();
                             result.Target = $"Set{seriesFunction} = {dataValue.Target}";
+                            result.RootTarget = dataValue.Target;
                         }
                         yield return result;
                         yield return new DataSourceValueGroup
                         {
                             Target = $"Slice{seriesFunction}({string.Join(", ", parameters)}{(parameters.Length > 0 ? ", " : "")}{targetExpression})",
+                            RootTarget = targetExpression,
                             Source = ExecuteSeriesFunctionOverTimeSlices(scanner, seriesFunction, parameters)
                         };
                             yield return new DataSourceValueGroup
                             {
                                 Target = $"{seriesFunction}({string.Join(", ", parameters)}{(parameters.Length > 0 ? ", " : "")}{dataValues.Target})",
+                                RootTarget = dataValues.Target,
                                 Source = ExecuteSeriesFunctionOverSource(dataValues.Source, seriesFunction, parameters)
                             };
         private static readonly Dictionary<SeriesFunction, int> s_requiredParameters;
         private static readonly Dictionary<SeriesFunction, int> s_optionalParameters;
         private static readonly string[] s_groupOperationNames;
+        private static readonly string[] s_metadataRecordFields;
         // Static Constructor
         static GrafanaDataSourceBase()
             // RegEx instance to find all series functions
             s_groupOperationNames = Enum.GetNames(typeof(GroupOperation));
             s_seriesFunctions = new Regex($@"({string.Join("|", s_groupOperationNames)})?\w+\s*(?<!\s+IN\s+)\((([^\(\)]|(?<counter>\()|(?<-counter>\)))*(?(counter)(?!)))\)", RegexOptions.Compiled | RegexOptions.IgnoreCase);
+            s_metadataRecordFields = new[] { "ID", "SignalID", "PointTag", "AlternateTag", "SignalReference", "Device", "SignalType" };
             // RegEx instances to identify specific functions and extract internal expressions
             s_averageExpression = new Regex(string.Format(GetExpression, "(Average|Avg|Mean)"), RegexOptions.Compiled | RegexOptions.IgnoreCase);

GrafanaAdapters: Added meta-data substitution parameters for Label function when series values map directly to point tags.

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code