Skip to content

Commit

Permalink
Merge pull request #108 from GridProtectionAlliance/MakeGrafanaMaxLim…
Browse files Browse the repository at this point in the history
…itConfigurable

Added configurable Grafana query limits
  • Loading branch information
clackner-gpa authored Dec 10, 2024
2 parents bc65a4b + b391970 commit 59ef0d2
Showing 1 changed file with 41 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,16 @@ public void Reset()
}

// Represents a historian 2.0 data source for the Grafana adapter.
internal class OH2DataSource : GrafanaDataSourceBase
internal sealed class OH2DataSource : GrafanaDataSourceBase
{
private readonly ulong m_baseTicks = (ulong)UnixTimeTag.BaseTicks.Value;

public OH2DataSource()
{
MaximumSearchTargetsPerRequest = s_maximumSearchTargetsPerRequest;
MaximumAnnotationsPerRequest = s_maximumAnnotationsPerRequest;
}

/// <summary>
/// Starts a query that will read data source values, given a set of point IDs and targets, over a time range.
/// </summary>
Expand Down Expand Up @@ -267,6 +273,9 @@ public OH1DataSource(string instanceName)
m_baseTicks = UnixTimeTag.BaseTicks.Value;

InstanceName = instanceName;

MaximumSearchTargetsPerRequest = s_maximumSearchTargetsPerRequest;
MaximumAnnotationsPerRequest = s_maximumAnnotationsPerRequest;
}

protected override async IAsyncEnumerable<DataSourceValue> QueryDataSourceValues(QueryParameters queryParameters, OrderedDictionary<ulong, (string, string)> targetMap, [EnumeratorCancellation] CancellationToken cancellationToken)
Expand Down Expand Up @@ -587,7 +596,38 @@ public virtual Task<List<AnnotationResponse>> Annotations(AnnotationRequest requ

#region [ Static ]

// Static Fields
private static readonly Regex s_intervalExpression = new(@"(?<Value>\d+\.?\d*)(?<Unit>\w+)", RegexOptions.Compiled);
private static readonly int s_maximumSearchTargetsPerRequest;
private static readonly int s_maximumAnnotationsPerRequest;

// Static Constructor
static GrafanaController()
{
const int DefaultMaximumSearchTargetsPerRequest = 200;
const int DefaultMaximumAnnotationsPerRequest = 100;

try
{
// Make sure Grafana specific default threshold settings exist
CategorizedSettingsElementCollection thresholdSettings = ConfigurationFile.Current.Settings["thresholdSettings"];

// Make sure needed settings exist
thresholdSettings.Add("GrafanaMaximumSearchTargets", DefaultMaximumSearchTargetsPerRequest, "Defines maximum number of search targets to return during a Grafana search query.");
thresholdSettings.Add("GrafanaMaximumAnnotations", DefaultMaximumAnnotationsPerRequest, "Defines maximum number of annotations to return during a Grafana annotation query.");

// Get settings as currently defined in configuration file
s_maximumSearchTargetsPerRequest = thresholdSettings["GrafanaMaximumSearchTargets"].ValueAs(DefaultMaximumSearchTargetsPerRequest);
s_maximumAnnotationsPerRequest = thresholdSettings["GrafanaMaximumAnnotations"].ValueAs(DefaultMaximumAnnotationsPerRequest);
}
catch (Exception ex)
{
Logger.SwallowException(ex);

s_maximumSearchTargetsPerRequest = DefaultMaximumSearchTargetsPerRequest;
s_maximumAnnotationsPerRequest = DefaultMaximumAnnotationsPerRequest;
}
}

// Static Methods
private static bool TryParseInterval(string interval, out TimeSpan timeSpan)
Expand Down

0 comments on commit 59ef0d2

Please sign in to comment.