View source for Metric Range Query Node in Pathways

== '''Overview''' ==
The '''Metric Range Query''' node in FojiSoft Pathways is used to execute a metric query over a defined range of time. This is particularly useful for analyzing trends, generating reports, and monitoring performance over a specific duration.
----

== '''Node Properties''' ==

=== '''1. Name''' ===

* '''Description''': A unique identifier for the metric query operation.
* '''Usage''': Assign a descriptive name (e.g., "Retrieve Network Latency Data" or "Query CPU Usage Over Time").

----

=== '''2. Query''' ===

* '''Description''': Defines the metric query that will be executed.
* '''Options for Expression Type''':
*# '''JavaScript Statement''': A direct JavaScript expression for simple queries.
*# '''JavaScript Function''': A function for dynamic queries.
*# '''Handlebars Template''': A dynamic template for injecting real-time query values.
* '''Example Expressions''':
** '''JavaScript Statement''': "network_latency"
** '''JavaScript Function''': function getQuery() {   return "network_latency";  }
** '''Handlebars Template''': metric_query_variable
* '''Status''': '''Required''' (A valid query must be provided for execution).

----

=== '''3. Start Time''' ===

* '''Description''': Defines the '''earliest''' timestamp for querying data.
* '''Options''': Same as '''Query Type''' (JavaScript Statement, JavaScript Function, Handlebars Template).
* '''Example Expressions''':
** '''JavaScript Statement''': Date.now() - 900000  // Fetch data from 15 minutes ago
** '''JavaScript Function''': function getStartTime() {   return Date.now() - (60 * 60 * 1000); // Fetch data from 1 hour ago  }
** '''Handlebars Template''': start_time_variable

----

=== '''4. End Time''' ===

* '''Description''': Defines the '''latest''' timestamp for querying data.
* '''Options''': Same as '''Start Time'''.
* '''Example Expressions''':
** '''JavaScript Statement''': Date.now()  // Fetch data up to the current time
** '''JavaScript Function''': function getEndTime() {   return Date.now();  }
** '''Handlebars Template''': end_time_variable

----

=== '''5. Query Step''' ===

* '''Description''': Determines the granularity of the data points retrieved (e.g., per second, per minute).
* '''Default Value''': <code>1 Minute</code>
* '''Customization''': Adjust based on workflow needs (e.g., seconds, minutes, hours).
* '''Example Use Cases''':
** '''High-resolution data''': Set <code>Step = 1 Second</code>
** '''Hourly summaries''': Set <code>Step = 1 Hour</code>
** '''Daily reports''': Set <code>Step = 1 Day</code>

----

=== '''6. Variable Name''' ===

* '''Description''': The name of the output variable where the retrieved metric data will be stored.
* '''Status''': '''Required''' (Must be defined for further use in the workflow).
* '''Usage''': Choose a meaningful variable name (e.g., <code>latency_trend</code>, <code>cpu_usage_history</code>).

----

== '''How It Works''' ==

# '''Define the Query''': Specify the metric query to retrieve relevant data.
# '''Set Start and End Times''': Choose a time range for data retrieval.
# '''Define Query Step''': Controls how frequently data points are sampled.
# '''Store Output in a Variable''': The retrieved metric data is saved under the specified variable name.

----

== '''Example Use Cases''' ==

=== '''1. Analyzing Network Latency Trends''' ===

* '''Query''': <code>"network_latency"</code>
* '''Start Time''': <code>Date.now() - 3600000</code> (1 hour ago)
* '''End Time''': <code>Date.now()</code>
* '''Query Step''': <code>1 Minute</code>
* '''Variable Name''': <code>latency_trend</code>
* '''Outcome''': Retrieves network latency values over the past hour at 1-minute intervals.

=== '''2. Tracking CPU Utilization Over 24 Hours''' ===

* '''Query''': <code>"cpu_usage"</code>
* '''Start Time''': <code>Date.now() - 86400000</code> (24 hours ago)
* '''End Time''': <code>Date.now()</code>
* '''Query Step''': <code>5 Minutes</code>
* '''Variable Name''': <code>cpu_usage_history</code>
* '''Outcome''': Retrieves CPU utilization data for the past 24 hours in 5-minute increments.

----

== '''Best Practices''' ==

* '''Optimize Query Frequency''': Avoid excessive data retrieval by setting appropriate step values.
* '''Use Meaningful Variable Names''': Helps with workflow clarity and debugging.
* '''Leverage JavaScript Functions''': For dynamic query adjustments based on system state.

The '''Metric Range Query''' node is essential for analyzing performance trends over time, providing valuable insights for monitoring and decision-making.
[[Category:ForgeAI]]
[[Category:Pathways]]