Monitoring & forecasts¶
In this section, you can access monitoring and forecasting tools to analyze and predict network behavior. These tools provide real-time data and insights to help you make informed decisions and optimize network performance.
Interactions¶
Adds one traffic sample manually¶
Adds one traffic sample manually
Click to see more details
Form to complete:
- Adds one traffic sample manually: Adds one traffic sample manually.
- Date: Date of the sample.
- Element ID: ID of the element to which the sample is added.
- Traffic (Gbps): Traffic in Gbps.
- Is received traffic: If true, the traffic is received. If false, the traffic is transmitted.
-
User tag: Optional tag to be associated with the sample.
-
Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Adds batch traffic samples from JSON¶
Adds a set traffic samples from JSON. JSON expected structure: an array of entries, each entry a JSON object with the following fields: entryTimestamp, elementId, trafficTxGbps, trafficRxGbps. Each of the last two elements of the object are optional
Click to see more details
Form to complete:
- Adds batch traffic samples from JSON: Adds a set traffic samples from JSON. JSON expected structure: an array of entries, each entry a JSON object with the following fields: entryTimestamp, elementId, trafficTxGbps, trafficRxGbps. Each of the last two elements of the object are optional.
-
User tag: Optional tag to be associated with all the samples.
-
Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
- Entries JSON: JSON array with the entries to be added. See the JSON expected structure in the description of this interaction..
Save current state as traffic samples¶
Saves the current network state as traffic samples
Click to see more details
Form to complete:
- Save current state as traffic samples: Saves the current network state as traffic samples.
- Assigned GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the date in the indicated format.
-
User tag: Optional tag to be associated with all the samples.
-
Elements to save: Indicate the elements in the design for which its current traffic will be saved as traffic samples.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Add synthetic traces of samples from current traffic¶
For each selected element, a new traffic trace is generated using its initial traffic as the current traffic
Click to see more details
Form to complete:
- Add synthetic traces of samples from current traffic: For each selected element, a new traffic trace is generated using its initial traffic as the current traffic.
- Initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Custom interval: Indicate if a custom interval between samples is used.
- Synthetic data interval: Indicate a fixed interval between samples. Options:
- 5 minutes: 5 minutes interval between samples.
- 30 minutes: 30 minutes interval between samples.
- 1 hour: 1 hour interval between samples.
- 1 day: 1 day interval between samples.
- 1 week: 1 week interval between samples.
- 1 month: 1 month interval between samples.
- Synthetic total period: Indicate a fixed total period for the synthetic traffic samples creation.. Options:
- Three months: Three months of samples.
- Six months: Six months of samples.
- One year: One year of samples.
- Two years: Two years of samples.
- Three years: Three years of samples.
- Synthetic data interval (minutes): Introduce interval (in minutes) between consecutive samples.
- Synthetic total period (samples): Indicate the total number of samples to be created, starting from the initial date. The total period is the interval between the first and last sample.
-
User tag: Optional tag to be associated with all the samples.
-
Random number generator seed: Introduce the seed of the random number generator to be used in the random traffic samples creation.
- Long-term growth type: The growth traffic type, in the long term. Options:
- Exponential growth: Exponential traffic growth means that traffic at year T+1 is GF times the traffic at year T, where GF is the growth factor..
- Linear growth: Linear traffic growth means that the traffic at year T+1 is the traffic at T plus GF, where GF is the growth factor..
- Long-term growth factor (per year): If exponential growth, this is the compound annual growth rate (CAGR) (adimensional value), if linear growth, this is the traffic growth per year in Gbps.
- Daily variation: busy-hour-to-valley factor (>= 1): In daily variations, the traffic outside the busy hours is shaped down. This is the ratio between the average traffic in the busy hour vs. the rest of the day. If < 1, no daily variation is applied.
- Daily variation: hour of the start of busy-hour period (0..24): In daily variations, the hour (as a double in [0 , 24) when peak traffic interval (busy hours) start. If not in [0,24), no daily variation is applied.
- Daily variation: duration in hours of the busy-hours period (0..24): In daily variations, the duration in hours (as a double in [0 , 24) of peak traffic interval (busy hours) start. If start time plus duration exceeds the hour 24, an error is raised.
- Noise coefficient of variation: A normal traffic noise centered in 0 and typical deviation given by this value multiplied by the current traffic, is added to the estimation. Note that negative traffics are later truncated to zero.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Forecast traffic samples given stored traffic¶
For the selected elements and based on stored traffic samples, this action creates a trace of traffic forecasts.
Click to see more details
Form to complete:
- Forecast traffic samples given stored traffic: For the selected elements and based on stored traffic samples, this action creates a trace of traffic forecasts..
- Forecast initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Custom interval: Indicate if a custom interval between samples is used.
- Interval between forecasted samples: Indicate a fixed interval between forecasted samples. Options:
- 5 minutes: 5 minutes interval between samples.
- 30 minutes: 30 minutes interval between samples.
- 1 hour: 1 hour interval between samples.
- 1 day: 1 day interval between samples.
- 1 week: 1 week interval between samples.
- 1 month: 1 month interval between samples.
- Time to forecast: Indicate a fixed time to forecast. Options:
- Three months: Three months of samples.
- Six months: Six months of samples.
- One year: One year of samples.
- Two years: Two years of samples.
- Three years: Three years of samples.
- Forecast interval between samples (minutes): Introduce interval (in minutes) between consecutive samples.
- Forecast number of samples: Introduce the number of monitoring samples to create.
-
Apply tag to forecasted samples: Optional tag to add to the created forecasts.
-
Input traffic samples initial date (format yyyy-MM-dd HH:mm:ss): Introduce the date in the indicated format.
- Input traffic samples end date (format yyyy-MM-dd HH:mm:ss): Introduce the date in the indicated format.
- Is RX traffic: If true, only the rx traffic is considered. If false, only the tx traffic is considered. By default, only IP interfaces has RX traffic, the other monitorable resources are considered as TX traffic..
-
Input traffic samples tag: Optional tag, if present the input traffic samples are taken only from those with this tag.
-
Input traffic aggregation window: One sample is produced for each interval (if at least one sample exists for it). Options:
- Minute: One sample per minute is created, with a traffic such that %p of the samples in that period is below that quantity.
- Hour: One sample per hour is created, with a traffic such that %p of the samples in that period is below that quantity.
- Day: One sample per day is created, with a traffic such that %p of the samples in that period is below that quantity.
- Week: One sample per week is created, with a traffic such that %p of the samples in that period is below that quantity.
- Month: One sample per month is created, with a traffic such that %p of the samples in that period is below that quantity.
- Year: One sample per year is created, with a traffic such that %p of the samples in that period is below that quantity.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
- Confidence interval: The confidence (probability between 0 and one) to compute the confidence intervals for the forecasts.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Add synthetic traces in links from demands¶
For each selected element, a new traffic trace will be created by simulating the traffic in the IP demands and the resulting traffic in the selected elements. The traffic in the IP demands will be interpolated from the existing samples, and the traffic in the selected elements will be obtained by simulating the network.
Click to see more details
Form to complete:
- Add synthetic traces in links from demands: For each selected element, a new traffic trace will be created by simulating the traffic in the IP demands and the resulting traffic in the selected elements. The traffic in the IP demands will be interpolated from the existing samples, and the traffic in the selected elements will be obtained by simulating the network..
- Initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Interval between samples (minutes): Introduce interval (in minutes) between consecutive smaples.
- Number of samples: Introduce the number of monitoring samples to create.
-
(Read) Demand traffic samples tag: Optional tag of the samples of the IP demands that will be used..
-
Max offset in minutes to consider a demand sample: The demand traffic at a particular time will be considered as the linear interpolation of the traffic between the closest existing traffic samples, filtering out those samples that are further than this value in time from the target time..
-
(Write) Tag to set in new traffic samples: Optional tag to be associated with all the samples created.
-
Output elements: Indicate the elements in the design for which traffic samples will be created.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Form response:
- Dates without samples: List of dates for which no samples will be created.
Remove monitoring/forecast samples¶
Permits removing samples of the monitoring or forecast type to a design
Click to see more details
Form to complete:
- Remove monitoring/forecast samples: Permits removing samples of the monitoring or forecast type to a design.
- Initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- End GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Remove traffic samples: If true, the traffic samples will be removed.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
- Remove general algorithm run samples: If true, the general algorithm run entries will be removed.
-
Sample tag: Optional tag, if present, only the samples with this tag are removed.
-
Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Get monitoring metadata¶
Get monitoring metadata for the selected elements
Click to see more details
Form to complete:
- Get monitoring metadata: Get monitoring metadata for the selected elements.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Form response:
- Traces Metadata: List of metadata for the traces available.
Get traffic samples¶
Retrieves traffic samples of the design, potentally passing through a percentile filtering
Click to see more details
Form to complete:
- Get traffic samples: Retrieves traffic samples of the design, potentally passing through a percentile filtering.
- Initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- End GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
-
Sample tag: Optional tag, if present, only the samples with this tag are affected.
-
Is RX traffic: If true, only the rx traffic is considered. If false, only the tx traffic is considered. By default, only IP interfaces has RX traffic, the other monitorable resources are considered as TX traffic..
- Include forecast confidence inverval: If true, the forecasted confidence interval is included in the output if available.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
- Aggregation Window: One sample is produced for each interval (if at least one sample exists for it). Options:
- Minute: One sample per minute is created, with a traffic such that %p of the samples in that period is below that quantity.
- Hour: One sample per hour is created, with a traffic such that %p of the samples in that period is below that quantity.
- Day: One sample per day is created, with a traffic such that %p of the samples in that period is below that quantity.
- Week: One sample per week is created, with a traffic such that %p of the samples in that period is below that quantity.
- Month: One sample per month is created, with a traffic such that %p of the samples in that period is below that quantity.
- Year: One sample per year is created, with a traffic such that %p of the samples in that period is below that quantity.
- Fill missing values: If true, the missing values are filled with zero. If false, the missing values are not filled and the output is only the samples.
- Apply percentile filtering: If true, the percentile filtering is applied.
- Percentile: Introduce the percentile. 1 means peaking the maximum value in the interval.
- Output format: The output format of the samples. Options:
- JSON: Using a JSON file structure.
- CSV: Using a CSV file structure.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Form response:
- Output JSON: The output JSON.
- Output CSV: The output CSV.
Get algorithm samples¶
Retrieves algorithm samples of the design
Click to see more details
Form to complete:
- Get algorithm samples: Retrieves algorithm samples of the design.
- Initial GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- End GMT date (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
-
Sample tag: Optional tag, if present, only the samples with this tag are affected.
-
Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Form response:
- Output JSON: The output JSON.
Add percentile samples¶
Computes percentile samples from the traffic samples of a design, and stores them
Click to see more details
Form to complete:
- Add percentile samples: Computes percentile samples from the traffic samples of a design, and stores them.
- Initial GMT date: Introduce the initial date in the indicated format.
- End GMT date: Introduce the initial date in the indicated format.
-
Input trace tag: Optional tag, if present, only the samples with this tag are used as input samples.
-
Input aggregation window: Group samples in the aggregation window. Options:
- Minute: One sample per minute is created, with a traffic such that %p of the samples in that period is below that quantity.
- Hour: One sample per hour is created, with a traffic such that %p of the samples in that period is below that quantity.
- Day: One sample per day is created, with a traffic such that %p of the samples in that period is below that quantity.
- Week: One sample per week is created, with a traffic such that %p of the samples in that period is below that quantity.
- Month: One sample per month is created, with a traffic such that %p of the samples in that period is below that quantity.
- Year: One sample per year is created, with a traffic such that %p of the samples in that period is below that quantity.
- Is RX traffic: If true, only the rx traffic is considered. If false, only the tx traffic is considered. By default, only IP interfaces has RX traffic, the other monitor able resources are considered as TX traffic..
- Include forecast confidence interval: If true, the forecasted confidence interval is included in the output if available.
- Percentile interval: One sample is produced for each interval (if at least one sample exists for it). Options:
- Minute: One sample per minute is created, with a traffic such that %p of the samples in that period is below that quantity.
- Hour: One sample per hour is created, with a traffic such that %p of the samples in that period is below that quantity.
- Day: One sample per day is created, with a traffic such that %p of the samples in that period is below that quantity.
- Week: One sample per week is created, with a traffic such that %p of the samples in that period is below that quantity.
- Month: One sample per month is created, with a traffic such that %p of the samples in that period is below that quantity.
- Year: One sample per year is created, with a traffic such that %p of the samples in that period is below that quantity.
- Percentile: Introduce the percentile. 1 means peaking the maximum value in the interval.
- Output percentile samples tag: The samples created with percentile values are tagged with this.
- Affected elements: Indicate the elements in the design for which this operation will be applied.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Traffic matrix derivation¶
Computes the traffic matrix derivation for a given design and a given set of monitoring samples
Click to see more details
Form to complete:
- Traffic matrix derivation: Computes the traffic matrix derivation for a given design and a given set of monitoring samples.
- Initial date for traffic estimation (format yyyy-MM-dd HH:mm:ss): Introduce the initial date in the indicated format.
- Custom interval: Indicate if a custom interval between samples is used.
- Sample interval: Indicate a interval between samples. Options:
- 5 minutes: 5 minutes interval between samples.
- 30 minutes: 30 minutes interval between samples.
- 1 hour: 1 hour interval between samples.
- 1 day: 1 day interval between samples.
- 1 week: 1 week interval between samples.
- 1 month: 1 month interval between samples.
- Total period: Indicate a total period for the traffic samples matrix derivation.. Options:
- Three months: Three months of samples.
- Six months: Six months of samples.
- One year: One year of samples.
- Two years: Two years of samples.
- Three years: Three years of samples.
- Interval between samples (minutes): Introduce interval (in minutes) between consecutive smaples.
- Number of samples: Introduce the number of monitoring samples to estimate. First sample is at the initial date, and the rest are separated by the interval between samples.
-
Output IP demand samples tag: The tag to use for the output IP demand samples.
-
Input measurement samples tag: Optional tag, if present, only the samples with this tag are used as input samples.
-
Is RX traffic: If true, only the rx traffic is considered. If false, only the tx traffic is considered. By default, only IP interfaces has RX traffic, the other monitorable resources are considered as TX traffic..
- Max offset in minutes to consider for link traffic sample: The IP link/interdce traffic at a particular time will be considered as the linear interpolation of the traffic between the closest existing traffic samples, filtering out those samples that are further than this value in time from the target time..
- Traffic estimation model: Indicate the traffic demand estimation model to apply. Options:
- Proprietary model: Full-fledged proprietary regression model.
- Adapted gravity model: Adapted version of the general gravity model method.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.
Form response:
- Number of dates with IP demand estimation performed: Number of dates with estimation performed.
- Number of dates with IP demand estimation not performed: Number of dates with estimation not performed.
Set demands to given time and simulate¶
Sets the current network IP traffic of the demands, to the one estimated for a given date. Then, simulate the network for that traffic, and set the traffic in the links etc accordingly. If there is no estimation for all demands, an error is raised.
Click to see more details
Form to complete:
- Set demands to given time and simulate: Sets the current network IP traffic of the demands, to the one estimated for a given date. Then, simulate the network for that traffic, and set the traffic in the links etc accordingly. If there is no estimation for all demands, an error is raised..
-
IP demand samples tag: The tag to use for reading the demand samples and interpolate the traffic at the given time.
-
Find last date: If true, the last date with samples will be used as target date.
- Date for traffic estimation: Introduce the date for the traffic estimation.
- Max offset in minutes to consider for demand traffic sample: The IP traffic at a particular time will be considered as the linear interpolation of the traffic between the closest existing traffic samples, filtering out those samples that are further than this value in time from the target time..
- Compute ground-truth values for comparison: If true, the ground-truth values are computed from the database values in the same date, for comparison purposes.
-
Ground-truth comparing tag: The tag to use for reading the traffic in links, demands etc. for comparison. The traffic measurements will be considered for those elements (interfaces, links...) with samples at the target date, or close enough according to the same time margin as the one indicated for the IP demands.
-
Create new design: If true, the new design will be created, and the simulation will be done on it. If false, the simulation will be done on the current design.
- Log this interaction: If checked, the call to this interaction is logged at the time of 'now', as a new entry in the database of generic type, with the input parameters as the ones used for this process run.