Monitor Group

User needs to follow the below-mentioned steps to manage monitor group:

Open web browser and type the address in the address bar http://hostname:80/netstorm. The product login window is displayed.

Go to Configuration > Monitors. This displays the Monitors Groups window.

4. Select the topology from the list. This displays available monitors groups for the selected topology with the following details:

Monitor Group Name: Name of the monitor group
Description: Description of the monitor group
Owner: User who created the monitor group
Last Updated By: User who last updated the monitor group
Last Modified: Last modified date and time
Actions: There are following actions a user can perform
- Edit Monitor Group: To edit the monitor group details
- Version Commit: To commit a version and provide comments
- Version Log: To view version logs
- Test Monitor: To test monitor group configuration
- Download Monitor Group: To download monitor group in json file format

Add Monitor Group

To add a monitor group, follow the below mentioned steps:

Click the Add Monitor Group icon . This displays the Add Monitor Group window.

2. Enter the monitor group name, its description, and click the Save button. This displays the Configuration window for the added monitor group. The monitor group configuration is described in the subsequent section.

Monitor Group Configuration

This window contains a list of monitor categories from where user can configure monitors (by expanding a monitor category) and add in the monitor group for monitoring an application. User can apply monitors for all tiers or for specific tiers. To configure a monitor group, click the monitor group name within the Available Monitor Group(s) table. This displays a list of monitor categories (at the left) and tiers (at the right) where these monitors can be applied.

Select a monitor category from the list or expand it for specific monitors and click the configure monitor icon corresponding to a tier at which the monitor is to be applied.

User can configure the monitors at tier level and server level. To test a monitor configuration at server level, click the icon.

User can see monitor is configured or not via color codes. When a category is expanded, it shows the monitors with configuration status.

Color Codes:

Green – Configured and Active
Gray – Configured but Inactive
Red – Mark Active but not configured

Health Check Monitor Configurations

Health check Monitor (Agent less monitor) is used to configure the servers to check health. To enable and configure health check monitor, click the Health Check Monitor button.

This displays the configuration window for Health Check Monitor. This window is categorized into two sections:

Health Check Settings
Health Check Monitor

Health Check Settings

A user can configure these global settings for all monitors. To enable Health Check Settings, user first needs to select the Enable Health Check Monitor check box. In this section, user can configure the settings for Ping, HTTP (URL based), and Socket (Telnet based). There are sub-sections for each settings:

Ping Health Check Settings

Packet Count: Number of packets that are to be transmitted from source to destination.
Wait Interval in sec(s): Wait time between transmissions of packets.
Thread Pool Size: A managed collection of threads that are available to perform tasks.

HTTP Health Check Settings

Use Proxy: When enabled, user needs to provide the proxy host:port, username, and password.
Connection Timeout: Sets or returns the number of seconds to wait for a connection to open, before canceling the attempt and generate an error.
Response Timeout: Number of seconds to wait for a response to begin arriving back from the remote system after sending a request.
Thread Pool Size: A managed collection of threads that are available to perform tasks.
Status code for successful health check: The status code that classifies the successful health check.

Socket Health Check Settings

Connection Timeout: Sets or returns the number of seconds to wait for a connection to open, before canceling the attempt and generate an error.

Maintenance Settings

Here, the user needs to specify the Maintenance URL. By default, host and port arguments are added in the ‘options’ in health check monitor JSON for maintenance. Earlier, for a server, there were only two states for monitor, such as ‘available’ and ‘unavailable’. Now, all the unavailable servers are further categorized in two states, such as server which are in ‘maintenance’ and ‘unavailable’.

Health Check Monitor

This section enables a user to specify the Health Check type (either, ping, HTTP, or socket) and the tier, server, host at which it is to be applied.

Select the Health Check Type. Further inputs are based on the selection of Health Check type.

Health Check Type – Ping

Provide the following details:

Tier Name: Select the tier from the list. Upon selecting ‘Others’, specify the tier name in the text box. The user can provide special character (-)in tier name if using a pattern on tier level. A user can now create a tier with ‘-‘ in Server Health Monitor window. For example, Cavisson-QA*.
Server Name: Provide the display name of the server.
Host: Provide the host name.

User can override the health check settings by providing packet count and wait interval within the Advanced Settings section.

Health Check Type – HTTP

This is URL based monitoring.

Provide the following details:

Tier: Select the tier from the list. Upon selecting ‘Others’, specify the tier name in the text box.
Server Display Name: Provide the display name of the server.
Instance: Provide the instance that is to be monitored.
URL: The URL that contains the instance to be monitored.
Username: User name if required for URL access.
Password: Password to access the URL.

User can override the global health check settings by providing proxy settings, such as connection timeout, response timeout, and status code for successful health checkup.

Health Check Type – Socket

This is Telnet based monitoring.

Provide the following details:

Tier: Select the tier from the list. Upon selecting ‘Others’, specify the tier name in the text box.
Server Display Name: Provide the display name of the server.
Host: Provide the host name.
Port: Provide the corresponding port for the host.
Instance: Provide the instance that is to be monitored.

A user can override the global health check settings by providing the connection timeout.

Edit Health Check Monitor

A user can edit health check monitor configurations by clicking the Edit button ().

Testing Health Check Monitor

A user can test a health check monitor to check if the monitor will work as expected or not (after monitor configuration) by using the ‘Test’ button in ‘Health Check Monitor’ window.

Custom Monitor(s)

Log Metric Monitor

This monitor is used to configure NetForest monitors. ND agent calls NF REST APIs to get the data and this data is stored in RTG. This monitor is always applied on ND appliance, that is, even if you enable this monitor for any tier, CMON of ND appliance is used to get data from NF. This is done as CMON of different tiers might not have connectivity with NF.

To access this monitor, select Log Metric Monitor from the ‘Custom Monitor(s)’ drop-down.

The ‘Available Log Metric Monitor(s)’ window is displayed.

Here, you can view the list of available NF monitor(s). You can view the details such as Monitor Name, Technology, Metric Group Name, Metric Group Hierarchy, and Query.

You can perform the following functions:

Add: This routes to monitor configuration screen for adding new configuration.
Edit: This opens monitor configuration in edit mode to edit the configured monitor.
Delete: You can delete all/selected configured monitors.

Note: You need to configure ‘Log Metric Global Settings’ before adding a ‘Log Metric Monitor’.

Configure Log Metric Global Settings

Click the ‘Log Metric Global Settings’ button at the upper-right corner. The Global Settings window is displayed.

Provide the following parameters, and then click Save:

Host: The default NF host is configured in ND.
Port: NF UI port
Secure: Enable this check box.
Environment: The default environment is prod.
Index Pattern: Provide an index pattern, for example, ‘*’.
Proxy Settings: Host, port, username, and password.

Add New Log Metric Monitor

To add a new Log Metric monitor, click the Add button. This displays the configuration window.

Provide the following details, and then click Save:

Specify the metric group name and group description. This is needed for creation of GDF.
Enter the Monitor name and NF query. If you want to apply any grouping or bucket or metric aggregation, specify that in the query. Based on this grouping, metadata is sent by NF query output and same is used to create the GDF metadata.
You can select a saved NF query. On selecting this, the NF saved query is displayed in the query text box where you can edit this query.
Clicking the ‘Execute’ button opens a dialog box where you need to select a tier for which the query must be executed. Based on the output of the query, the hierarchy (from metadata) and list of metrics are derived. These are used to create the GDF. Do not specify ‘Tier’ in the NF query.

In the ‘Metric Configuration’ section, you can edit the metric name and description. By default, metric name and graph description are same as field name.
In the ‘Advanced Settings’ section, specify the following parameters:
- Delay time (in ms)
- Delete vector
- Sample interval
The NF Settings are same as Global Settings.

Command Monitor

This monitor is used to configure and execute command or shell/batch script that run on different OS (Windows/Linux). Output can be in different formats, such as String, Key-Value, JSON, XML, and others.

From the ‘Custom Monitor(s)’ drop-down, select Command Monitor to access this monitor.

The ‘Available Command Based Monitor(s)’ window is displayed.

Here, you can view the list of configured command monitor(s). You can view the following details regarding the configured command-based monitors:

Monitor Name: Group name is considered as monitor name.
Metric Group Name: Group name as defined in GDF.
Metric Group Hierarchy: Hierarchy in GDF.
Command/Script: Command/Script executed to be monitored.

You can perform the following functions:

Add: This routes to command-based monitor configuration screen for adding new configuration.
Edit: This opens monitor configuration in edit mode to edit configured monitor.
Delete: You can delete all/selected configured monitors.

Add New Command Monitor

To add a new command monitor, click the Add button. This displays the ‘Command based configuration’ window.

Provide the following details:

Provide ‘Group Name’ and ‘Group Description’. Group name is considered as monitor name. This is needed for creation of GDF.
‘Category’ is a drop-down list of all the monitor categories from standard-monitor.dat file. By default, it is ‘System’. On configuring one command monitor, this is displayed in the monitor tree-table under ‘System’ monitors category.
You can also give custom category by selecting ‘Others’ from the list.
You need to give ‘Command/Script’ to be monitored in the text-field.
If you want a script for execution, click the ‘Use Script’ button that displays the following dialog box:

You can create and execute your own script in the text-area provided.
You can also browse a file from desktop to upload the script.

Click ‘OK’ to autofill the script in the textbox.
Click the ‘Run’ button to execute the command/script. The dialog box is displayed to fetch the output of the command/script.

Execute on server – You can execute command on server by selecting the ‘Tier’ and ‘Server’ available.
Execute remotely – You can execute command/script by making remote connection with the following remote options:
- Provide remote server IP (‘Host’) and ‘Port’. By default, port is 22. Both are mandatory.
- Username is mandatory.
- Drop-down labelled ‘Authentication’ contains a list having ‘Password’ and ‘Public Key’ options. When you select ‘Password’, the text-field for ‘Password’ is enabled. It is in encrypted format. When you select ‘Public Key’, the ‘Password’ text-field is disabled and only ‘Public Key’, ‘Private Key’, and ‘Passphrase’ are enabled.
- ‘Public Key’ and ‘Private Key’ are used for providing absolute file path (not in encoded form).
- You can provide proxy settings having Proxy Host, Proxy Port, Proxy Username, and Proxy Password (encrypted).
When you click ‘Run’, the command is executed, and the output is filled in the text area labelled as ‘Output’. The following inputs are present in the UI based on the output of the command/script executed.

- Delimiter – Delimiter between values. It can be space, comma, tab, pipe, or custom.
- ‘Use column name as metric name’ – You can use this checkbox for providing ‘Key’ or ‘Index’. When checked, it represents the key of the vector.
- Header Line represents a numeric value after which data is present in the command output.
- The ‘Auto Fill’ option is used for pre-filling metric-hierarchy and metric-configuration based on header line provided. You can autofill only when the checkbox is checked and the header line is provided.
- Skipline is used to skip header/non-valued lines.
  - top – Skip line from top. If you configured it 4, then 4 lines from top will not be evaluated to fetch data.
  - topActionStr – Command to fetch skip-line number from top.
  - bottom – Skip line from bottom. If you configured it 4, then 4 lines from bottom will not be evaluated to fetch data.
  - bottomActionStr – Command to fetch skip-line number from bottom.
- You can add vectors to the metric hierarchy table.
- Provide the following details:
  - ‘Metadata’: Metadata is used for GDF (Vector hierarchy).
  - ‘Default Value’: Default value of configured vector. If monitor does not get value from key or unable to convert value (conversion, pattern).
  - ‘Field Number/Column Key’: Index/key of vector.
  - ‘Filter’: It is used to configure positive (Include) / negative (Exclude) filter on each vector attribute.

- In this table, you can perform ‘Add’, ‘Edit’, ‘Delete’ actions.
- The ‘Link’ icon is present in the Actions If there is more than one row in the table, only one link icon is present.
- When you click the link icon, that row is linked with the row immediately above (that is, Filesystem_mounted is vector hierarchy, otherwise it is Filesystem>Mounted).
- There is a Metric Hierarchy Tree that displays Metric type at first node, Metric group name, tier, server, and then the vectors and metrics with data information.
- Refresh icon is present to refresh the tree if there is any change in tree structure.
- You can add/edit/delete metric configuration.
- Provide the following information, and then click OK:
  - Metric Name: This is the graph name.
  - Unit: You can give unit for the graph name.
  - Field Number/Column key: Field number is the index.
  - Data Type: This drop-down list contains “Sample”, “Rate”, “Cumulative”, and “Sum”.
  - Metric Formula
  - Metric Description
- In the Advance Metric Configuration dialog box, you can provide derived formula and values and mapped values.
- Value Mappings table can be used to configure metric value replacement. Suppose some metric value has come as true or false, you can configure it as true – 1 / false – 0.

Note: For all unmapped values, NaN will be shown in the dashboard.

You can give Derived For applying any formula on the metric value, provide formula as: <FORMULA>(Metric,<VALUE>) where FORMULA can be DIV, SUM, MUL, SUB.

Example: To divide the metric value by 60, provide formula as: DIV(Metric,60). You can also use nested formula. Example: To add 100 to the metric value and multiply the result by 60, provide formula as: MUL(SUM(Metric,100),60).

The following Advance Settings options are also present.

After configuring command-based monitor, deploy it as shown below.

The configured command monitor comes under the category that you had selected in the Command UI configuration window.
For deployment of command-based monitor, select tier and server, and then click the advance setting icon in the tree-table.

Here, remote connection fields are pre-filled from the data you had configured in the command UI.
You can override this option from this UI and save changes to run test and apply monitor.
‘Remote Connection Settings’ is optional. You can simply select the server on which you want to configure the monitor, and then save and run the test.

StatsD Monitor

You can configure a new monitor for any application sending metrics to StatsD. From the ‘Custom Monitor(s)’ drop-down, select StatsD Monitor to access this monitor.

The ‘Available StatsD Monitor(s)’ window is displayed.

Here, you can view the list of configured StatsD monitor(s). You can view the following details regarding the configured StatsD monitors:

Monitor Name: Group name is considered as monitor name.
Metric Group Name: Group name as defined in GDF.
Metric Group Hierarchy: Hierarchy in GDF.
Application Name: This is the application name of StatsD. For example, vault, airflow, android, and others.

You can perform the following functions:

Add: This routes to StatsD monitor configuration screen for adding new configuration.
Edit: This opens monitor configuration in edit mode to edit configured monitor.
Delete: You can delete all/selected configured monitors.

Add New StatsD Monitor

To add a new StatsD monitor, click the Add button. This displays the ‘StatsD configuration’ window.

Provide the following details:

Provide ‘Group Name’ and ‘Group Description’. Group name is considered as monitor name. This is needed for creation of GDF.
‘Category’ is a drop-down list of all the monitor categories from standard-monitor.dat file. By default, it is ‘System’. On configuring one StatsD monitor, this is displayed in the monitor tree-table under ‘System’ monitors category.
You can also give custom category by selecting ‘Others’ from the list.
You need to provide ‘Identifier’ which is the name of the application, for example, vault, airflow, android, and others.
You can add vectors to metric hierarchy table.

Provide the following inputs:
- ‘Metadata’: Metadata is used for GDF (Vector hierarchy).
- ‘Column key’: Index/key of vector. It is an editable drop-down.
- ‘Pattern’: It is used for pattern-matching on each vector attribute.

Metric Syntax: In Metric Syntax you can fill data to add in the metric hierarchy data table. Data between percentile (%) symbol is added to vector table. For example, %store99%.bluebird.%IMEI%

In above example, store99 and IMEI are added to Metric Hierarchy data table for Vector hierarchy as displayed below.

In this table, you can perform ‘Add’, ‘Edit’, ‘Delete’ actions.

The ‘Link’ icon is present in the Actions If there is more than one row in the table, only one link icon is present.
When you click the link icon, that row is linked with the row immediately above (that is, Metadata is vector hierarchy).
There is a Metric Hierarchy Tree that displays Metric type at first node, Metric group name, tier, server, and then the vectors and metrics with data information.
Refresh icon is present to refresh the tree if there is any change in tree structure.

You can add/edit/delete metric configuration.

Provide the following information, and then click OK:
- Metric Name: This is the graph name.
- Metric Pattern: You can give pattern for the graph name.
- Data Type: It is a drop-down containing list of ‘Timers’, ‘Count’, and ‘Gauge’.
- Metric Description
The following Advance Settings options are also present.

After configuring StatsD monitor, deploy it as shown below.

The configured StatsD monitor comes under the category that you had selected in the StatsD UI configuration window.
For deployment of StatsD monitor, select tier and server, and then click the advance setting icon in the tree-table.

Here, you can edit server name from this UI and save changes to run test and apply monitor.

DB Monitor

To apply generic DB monitor, select DB Monitor from the ‘Custom Monitor(s)’ drop-down.

The ‘Available DB Monitor(s)’ window is displayed.

Here, you can view the list of configured DB monitor(s). You can view the following details regarding the configured DB monitors:

Monitor Name: Group name is considered as monitor name.
Metric Group Name: Group name as defined in GDF.
Metric Group Hierarchy: Hierarchy in GDF.
Query: Query executed to be monitored.

You can perform the following functions:

Add: This routes to DB monitor configuration screen for adding new configuration.
Edit: This opens monitor configuration in edit mode to edit configured monitor.
Delete: You can delete all/selected configured monitors.

Add New DB Monitor

To add a new DB monitor, click the Add button. This displays the ‘DB configuration’ window.

Provide the following details:

Provide ‘Group Name’ and ‘Group Description’. Group name is considered as monitor name. This is needed for creation of GDF.
‘Category’ is a drop-down list of all the monitor categories from standard-monitor.dat file. By default, it is ‘System’. On configuring one DB monitor, this is displayed in the monitor tree-table under ‘System’ monitors category.
You can also give custom category by selecting ‘Others’ from the list.
Provide ‘Query’ to be monitored in the text-field.
Select ‘driver class’ from the driver class drop-down.
Click the ‘Run’ button to execute the Query.

Select ‘Tier’ and ‘Server’ to run the Query.
You can check ‘Remote DB Host’ and fill the server in the textbox from where you want to use the database to run the Query.
Fill Port, Username, Password to run the Query.
Database Name: In case of Postgress or MySQL, you need to fill Database Name. For other driver classes, this field is disabled.
You can add SSL Configuration if needed.

You can add vectors to metric hierarchy table.

Provide the following inputs:
- ‘Metadata’: Metadata is used for GDF (Vector hierarchy).
- ‘Column key’: Index/key of vector.

In this table, you can perform ‘Add’, ‘Edit’, ‘Delete’ actions.

There is a Metric Hierarchy Tree that displays Metric type at first node, Metric group name, tier, server, and then the vectors and metrics with data information.
Refresh icon is present to refresh the tree if there is any change in tree structure.
You can add/edit/delete metric configuration.

Provide the following information, and then click OK:
- Metric Name: This is the graph name.
- Unit: You can give unit for the graph name.
- Column Key: Key of metric.
- Data Type: This drop-down list contains ‘Sample’, ‘Rate’, ‘Cumulative’, and ‘Sum’.
- Metric Formula
- Metric Description
After configuring DB monitor, deploy it as shown below.

The configured DB monitor comes under that category which you selected in the DB UI configuration window.
To apply the configured DB monitor, select the monitor in monitor configuration screen, and then click the configure icon to open DB deployment window.

Provide the following options:
- Query: User configured query is shown in readable format.
- You can apply monitor remotely if agent server and Database server host are different.
- SSL configuration can be applied, if required.
- Advanced Settings options such as retry count, sample interval, and vector persist count are available. Enable the check box for ‘DB Connection’ to connect to database in every sample.
- Other parameters are auto filled if query is parameterized.
- Add the value in editable textbox in the data-table.
- Once all necessary parameters are added, you can save and apply the monitor.

JMX Monitor

JMX Monitoring is done by querying data from “Managed Beans” (MBeans) that are exposed via a JVM port (JMX console). An MBean represents a resource running inside a JVM and provides data on the configuration and usage of that resource.

JMX Configuration

To apply generic JMX monitor, select JMX Monitor from the ‘Custom Monitor(s)’ drop-down.

2. This displays the Available JMX Monitor(s)

3. To add a new JMX configuration, click the Add button.

Fetching MBeans for Application Instance

A dialog box is displayed where you need to select an application instance and click the Get Mbeans button to get the MBeans.

This displays the Mbeans of the Application instance.

6. There is a left tree to show the ObjectName in tree view. On clicking the leaf node, attributes are displayed in tabular view with following information – Metric Name, Metric Key, Data type, Readable, Writable, Description, and Action.

7. There is an option to provide the Base Path. There will be metric group name. After this path, all nodes will be part of the vector.

If you are not connected with the application or if agents are failed to fetch the Mbeans, a pop up dialog box is displayed.

On clicking Yes, you can configure the Mbean manually.

10. You need to enter the ObjectName. Based on ObjectName, Base path is displayed in drop down. You need to add metrics manually.

- Click the Add button. The Add Metric Configuration window is displayed.
- Enter the metric name, metric key, data type, and metric description.
- Click OK. The metric is added to the table.

Note:

You can add other metrics in the same way by clicking the button.
You can delete all configurations by clicking the button.
To Show / Hide columns, click the button.
To edit / delete the metric configuration, select the metric and click the buttons respectively.

Fetching MBeans for Machine Agent

In case of machine agent, ‘Add New Instance’ option is displayed in the Instance dropdown in the JMX Monitor window.

This displays the JMX Monitor window.

3. Provide the instance name and enter the JMX connection parameters (Host and Port) in the JMX Connection section. Then, click the Get Mbeans This displays the Mbeans of the Machine Agent instance.

There is a left tree to show the ObjectName in the tree view. On clicking the leaf node, attributes are displayed in tabular view with the following information – Metric Name, Metric Key, Data type, Readable, Writable, Description, and Action.
Provide the Metric Group Name, its description, and Topology.
Provide the Base Path within the metric hierarchy text box. After this path, all nodes will be part of the vector.

You can apply filters in the Filter Settings section for a metric. You need to select the metric key, filter, and its value. If the condition satisfied, the graphs are displayed in the Dashboard otherwise not.

Applying JMX Monitors

After configuration, you can apply JMX monitor to run the test. You need to open JMX Deployment UI to configure and apply JMX monitor. Monitor is displayed under the category that you selected in configuration window.

On the Monitor Configuration window, go to that added monitor within the specified technology.

2. Click the Configure Monitor button for a specified tier. The configuration window is displayed.

3. Provide the required details, such as Agent server, Host, and Port. Click Add, the monitor configuration is added in the table. Then, click Save.

4. You can view the configured/added monitors in the Dashboard.

Other Operations

Show / Hide Monitors

User is facilitated to show/ hide monitors based on the requirements. To hide monitor(s), select the monitor(s) check box and click the Hide button.

This hides the selected monitors from the list. To show all or selected hidden monitors, click the Show button.

This displays a dialog box that prompts for showing the hidden monitors. Select the required monitors and click the Show button.

Upon clicking the Show button, a confirmation box is displayed that prompts for the approval of showing selected hidden monitors.

Upon clicking Yes, the monitors are displayed.

View Monitor Stats

To view the monitor stats (metrics), click the monitor name from the list. This displays a window with monitor details along with its metrics description.

Delete Monitor Group

To delete a monitor group, first select a topology from the list, this displays a list of monitor groups. Select a monitor group(s) to be deleted and click the Delete Monitor Group(s) icon.

Edit Monitor Group

To edit a monitor group, click the Edit Monitor Group icon corresponding to a monitor. This displays the Edit Monitor Group window..

Here, a user can edit the monitor group name and its description.

Upload Monitor Profile

User can upload monitor profile in JSON format. To do this, select the topology from the drop-down list and click the icon at the top-right corner of the window.

Browse the file location and click Open.

This adds the monitor profile to the selected monitor group.

Download Monitor Group

To download a monitor group, click the icon within the Actions section on the Monitor Group window.

Version Commit

In version control systems, a commit adds the latest changes to the repository, making these changes part of the head revision of the repository. To do a version commit, first select a monitor group name and then click the icon.

This displays a comment box where user can specify the comments for this version.

Upon specifying the comment, click the Commit button.

Version Log

Here, user can view the log of the committed versions. To do this, select a monitor group from the list and click the icon.

This displays the details of the version log in the below format.

Filter Records

User can filter records based on the requirements. To do this, select the topology from the drop-down list. This displays a list of monitors group. Click the icon. This enables a row where user can input the values for which the records need to be filtered out.

Specify the values for filtering the records. The results will be displayed accordingly. User can filter records based on values provided for multiple columns.

To hide filter, click icon again.

Download Saved Configurations

User can download the saved configurations of monitors. To do this, click the icon corresponding to the monitor whose configuration needs to be downloaded.

This downloads the monitor group configuration in JSON format. User can open the file to view the configuration.

Settings

In this section, user can perform some additional settings regarding monitors group. To access this, go to the monitor group’s configuration window and click the Settings button.

This navigates the user to the Settings dialog box.

It contains two tabs – Tier Configuration and Metric Priority. The description of these are provided in the subsequent sections:

Tier Configuration

In this section, user can configure which tier(s) of a tier group are to be applied for tier configuration. To do this, expand the tier group, select the tier(s), and click Apply.

The selected tier(s) is added in the monitor configuration window.

Metric Priority

In this section, user can configure graphs of which priority are to be displayed in web dashboard. The available options are – All, Medium and High, and High.

User needs to follow the below mentioned steps:

Select the metric priority from the Metric Priority drop-down list.
Select tier group, server, and priority.
Click the Add The details are added to Configured Metric Priority section.

4. A user can further edit or delete the configured metric priority by using the Edit icon () and Delete icon () respectively.

Monitor Configuration

Log Monitor

Log monitor is used to abstract useful information from log file. It shows data in graphs as per GDF. It parses the information from log file (updating) while test is running.

Log Pattern Monitor

It reads the user defined file (updated regularly) and returns rate of “Number of occurrence” and “Total Number of occurrence” of search pattern.

Provide the following details:

Exclude Tier: The tier(s), which are to be excluded from the monitoring.

Pattern Name: Allows to exclude tier based on the pattern provided. The user can provide multiple comma separated regular expressions. The following characters are not supported in the regular expressions, such as comma (,), single quote (‘), double quote (“), and backtick(`).

File Name Selection: Select any one option from the below:

Use File Name
Use Command to get the File Name
Use JournalD

Instance Name: Instance name on which monitor should be configured

Run Options

Run Once: To run the monitor only once.
Run Periodically Till Test is Over: To run the monitor till the test is over.

Log monitor Name: Name of the log monitor.

Display monitor group name: Name of the monitor group.

Metric

Application Metrics
System Metrics
Custom Metrics

Graph Definition File Details: Click to add the details. The user can add multiple records.

Search Pattern: The pattern to be searched. The user can search more than one pattern.
Graph Name: Name of the graph for the pattern.
Unit: Unit is in either ‘minutes or in ‘seconds’

Log Data Monitor

Log File Data monitor is used to get average of any numeric field. It can be used in three ways.

Field Number
Pattern
Field Number & Pattern

Provide the following details:

Exclude Tier: The tier(s), which are to be excluded from the monitoring.

File Name Selection: Select any one option from the below and provide the input:

Use File Name
Use Command to get the File Name
Use JournalD

Instance Name: Instance name on which monitor should be configured

Log Monitor Name: Name of the log monitor.

Number of Header Lines: It is used to define the number of header lines after which the monitoring of data logs is started. For example – if the data log is started from line number 4 onwards, the value of this field should be 3.

Display monitor group name: Name of the monitor group.

Metric

Application Metrics
System Metrics
Custom Metrics

Trailing Characters: It is used to define the characters, which needs to be trimmed from right while considering a numerical value. For example – if the response time value is 10secs, the user needs to trim 4 characters from the right to get the exact numerical value. So, define the same (value as 4) in this field.

FieldSet Separators

Double Quotes
Single Quotes
Tab
Space
Comma
Backslash
Semicolon
Dash
Equal
Others

Graph Definition File Details: Click to add the details. The user can add multiple records.

Search Pattern: The pattern to be searched. The user can search more than one pattern.
Graph Name: Name of the graph for the pattern.
Unit: Unit is in either ‘minutes or in ‘seconds’.

Check Monitor

Check monitors are used for running user specified commands or programs on the server itself. Typical uses are to get server logs and to check the status of the servers, which Cavisson appliances are hitting to make sure servers are healthy during the test run.

This monitor is used to get data from server to Cavisson appliances.

Check monitor can be added at the following places:

Before the start of the test
At start of the test
On start of a phase
At end of test

Generally, monitors are used at “Before the start of the test” and “At the end of the test” phases.

Provide the following details to configure the Check monitor.

Exclude Tier: The tier(s), which are to be excluded from the monitoring.

Check Monitor Name: Name of the Check monitor.

Instance Name: It is the user defined name in the Tier > Server hierarchy.

Program Name: Program name and arguments of the Check Monitor.

Example for Program name:

chm_get_server_logs -f /home/netstorm/work/file3.txt -n CheckMonitor

In this,

chm_get_server_logs is the program name.

-f is used to import file we can also import the directory using –d.

/home/netstorm/work/file3.txt is the file argument path.

-n is used for defining the name of the TAR file.

ImportFile is the name of the TAR file that will be created into the $logs/TRxx/server_logs/servername/ImportFile.tar file.

From Event

Before start of test: It captures the data before start of the test. It does not support the frequency value as ‘Run Periodic’.
At start of test: It captures the data at starting of test. It supports the frequency value as ‘Run periodic’ or ‘never’.
On start of a phase: It captures data on starting of phase. It supports both the frequency values.
At end of test: It captures the data after test run is completed. It does not support the frequency value as ‘Run Periodic’.

Phase Name: It is the name of the phase, such as start, ramp up, stabilization, duration, and ramp down as defined in the scenario.

Frequency

Run Periodic: NetStorm starts the monitor periodically to capture the data.
Never: NetStorm starts the monitor once and that only at the start of the test run.

Periodicity (HH:MM:SS): This is the interval for capturing the data. It should be in 24 Hrs format.

End Event: It is enabled only when the frequency is ‘Run Periodic’. There are following options:

Till Test is Over
Continue Specified Number of Executions: Provide the count.
Till Specified Phase is Completed: Provide the End Phase name.

Server Signature

Server Signature is to take the snapshot of the server configuration before test is started. It is very useful to compare server configuration in two different tests.

Provide the following details to configure the Check monitor.

Exclude Tier: The tier(s), which are to be excluded from the monitoring.

Signature Name: Name of the signature.

Signature Type

Command: This type of server signature helps to execute the command on destination side and get the output of that command on the client side.
File: This type of server signature helps to get the content of the specified File that is present on the destination side.

Command/File Name: Provide the command or file name. Below are the examples:

Command: To get the output of the command “ps –lef” from the destination side, put this command in the Command/File Name Add the command-type server signature according to the server’s OS.

Command	Server’s OS
ps –lef	Linux
/usr/ucb/bin/ps –axuwwwww	Sun OS
df –h	Linux and Sun OS both

Enhancement: Auto_server_signature setting is used to enable the auto server signature for the server i.e. this setting automatically enables the server signature according to the server’s OS type.

File: To get the content of any file “abc.log” from the destination side, put this file name in the Command/File Name The created file is present at the location: $logs/TRXXX/server_signatures/signature_name.ssf

Custom Monitor

This section describes the inputs required for the configuration of custom monitor.

General Settings

Exclude Tier: The tier(s), which are to be excluded from the monitoring.
Pattern Name: Allows to exclude tier based on the pattern provided. The user can provide multiple comma separated regular expressions. The following characters are not supported in the regular expressions, such as comma (,), single quote (‘), double quote (“), and backtick(`).
Instance: It is the user defined name in the Tier > Server hierarchy.
SNMP Host: It is the IP of the SNMP host in xx.xx.xx.xx format.
Group Name: Name of the monitor group.
Group Hierarchy: It is the hierarchy of the group, for example – Tier > Server > Instance.
Monitor Name: Name of the monitor for capturing data.

Monitor Settings

OID: It is the SNMP object identifier. It’s an address used to identify devices and their statuses. It is a mandatory field.
Type: Default is cumulative.
Relative: It is only valid for ‘cumulative’ type.
Formulae: Formula to be applied on the data value.
1. Divide By: Divide the data value by Formula Value.
2. Multiply By: Multiply the data value by Formula Value.
3. MSToSec: Divide the data value by 1000 to convert it from milliseconds to seconds.
4. PerSec: Divide the data value by Interval.
Formulae Value: It is the value provided to the formula type for calculation.
Graph Name: Name of the graph.
Graph Description: Description of the graph.

Advance Settings

Community: The ‘Community’ is like a user ID or password that allows access to a router’s or other device’s statistics.
User Name: It is the username.
Interval: Provide the interval in seconds.
Version: Select the version from 1, 2c and 3.

Note: The following fields are displayed only when the user selects the version ‘3’.

Auth Protocol: SMTP Authentication, often abbreviated SMTP AUTH, is an extension of the Simple Mail Transfer Protocol (SMTP) whereby a client may log in using any authentication mechanism supported by the server. Submission servers mainly use it, where authentication is mandatory.
Auth Passphrase: This is the Authentication passphrase.
Privacy Protocol: This is the Privacy Protocol (for example: DES, AES).
Privacy Protocol Passphrase: This is the passphrase for the privacy protocol.
Security Level: Choose the security level from ‘no authentication and no privacy’, ‘authentication and no privacy’, and ‘authentication and privacy’.
Configured Monitor(s): This displays the configured monitors in a tabular format.

Integration

This section guides through the integration process of Cloud Monitors of AWS/Azure/GCP with NetDiagnostics Appliance. Cavisson monitoring agent provides you full-stack visibility into the performance of applications, databases, and micro services within a container environment. There are two agents, one is machine agent (CMON) and another is application agent (ND Agent).

Pre-Requisites

Integration process of Cloud Monitors of AWS/Azure/GCP requires below details:

AWS console with Access Key and Secret key
Azure console with Tenant ID, Client ID, and Client Secret keys
GCP console with service account file
NetDiagnostics appliance

Generating Keys (in case of non-availability)

You can also generate keys (access key and secret keys) in case you do not have them:

AWS: Open Console, search IAM, create user with specific access, generate password. Once you end with all the settings, it generates Access Keys and Secret Keys. Save them at a secure place.
Azure: Open Console, open cloud Shell from top icons, type “az ad sp create-for-rbac –sdk-auth”. This generates all the required keys. Save them at a secure place.

GCP Setup

Setup GCP Console – Go to the Login panel, click the three lines on the extreme top left, select IAM & Admin, Service Accounts, Create Service Accounts, select any role like Owner. It creates a new account file.
Select your newly created account and create a json file by creating key as shown below.

3. Save the json file at a secure place.

4. Now go to /home/cavisson/$controller/cloud/gcp/ and upload the downloaded file over there. Create the gcp directory if not available.

Note: Project and Service account should be same, else you will not able to get data.

In the subsequent sections, the steps for AWS integration, Azure integration, and GCP integration with NetDiagnostics are provided.

AWS Integration

2. Select AWS from the Integrations tab.

3. Add AWS Account Name, AWS Secret & Access Keys (to generate the keys, refer the Prerequisites section). This is added without region.

4. Go to Advanced Settings and specify the region where your application/services is running.

5. After saving the configuration details, add the monitors by editing the same configuration.

6. Once you are done with all these changes, start your test.

In this example, we have enabled two services which are listing here as AWS Athena & Route 53.

Azure Integration

Select Azure from the Integrations tab.

2. Add Azure Account Name, Tenant ID, Client ID & Client Secret Key (to generate the keys, refer to the Prerequisites section). You can exclude Namespace as per your requirement (optional).

Add the Azure monitors that you want to get displayed on the Dashboard.

4. Once you are done with all the changes, start your test. You can see the added monitors on the Dashboard.

GCP Integration

Select GCP from the Integrations tab.

2. In GCP Monitor UI, you can see the Project ID within the Configuration tab.

Within the Monitor(s) section, select the desired monitor name. For example – PubSub.

4. Run your test from console or backend. You can see the GCP monitors list. Here you can see the GCP PubSub data on NetDiagnostics Dashboard.

Note: You can implement all other monitors in the same way.

New Relic Integration

This section is related to capturing metrics of new relic. New Relic monitors run on ND appliance. New Relic is a Software as a Service offering that focuses on performance and availability monitoring. It uses a standardized Apdex (application performance index) score to set and rate application performance across the environment in a unified manner. New Relic is a web application performance service designed to work in real-time with your live web app. New Relic Infrastructure provides flexible, dynamic server monitoring. It lets you see deep inside your web application with respect to the end user’s experience within the app itself, down to the line of code.

With this integration, you can perform the following operations:

Monitor new relic applications.
Monitor new relic applications host.
Monitor new relic Infra metrics (System, Network, and Storage).
Configure from UI.
Use the Test button to check account detail is correct or not.

Perform the following steps for New Relic Integration with ND:

Select New Relic from the Integrations tab.

2. This displays the New Relic Monitor window with two tabs – Configuration and Monitor(s). The details of both the tabs are described in the subsequent sections.

Configuration Tab

Provide the following details and click Add:

Account Name: Mention the account name that is the part of Monitor hierarchy.
API Key: It is used to fetch application and application host stats.
Query API Key: It is used to collect the infra metrics using NRQL queries.
Account ID: It is used to collect the infra metrics using NRQL queries. If you provide the Query API Key then you need to provide the Account ID as well.

Note: You can edit or delete a record via Actions in the table.

Monitors Tab

A table is displayed where all the available monitors are listed.

When you double-click on any Monitor present in the table, a dialog box is displayed to show the Metric Information of the selected Monitor.

Note:

If no New Relic profile is configured, if you are in View mode, or if you logged in with guest user then Save button is disabled.
Now for applying the Monitor, you need to select the checkbox and click the Save button.

Metrics Captured

NewRelicSystemStats

System stats describe the current overall state of the entire server.

SR.No.	Graph Name	Graph Description
1	Cores Count	Total number of cores on host.
2	Proccessors Count	Total number of processors on host.
3	System Memory (GB)	Total system memory in gigabytes.
4	CPU IO Wait (%)	The portion of the current CPU utilization composed only of I/O wait time usage.
5	CPU Idle (%)	The portion of the current CPU utilization capacity that is idle.
6	CPU (%)	Total CPU utilization as a percentage. This is not an actual recorded value; it is an alias that combines percentage data from cpuSystemPercent, cpuUserPercent, cpuIoWaitPercent and cpuStealPercent.
7	CPU Steal (%)	The portion of time when a virtualized CPU is waiting for the hypervisor to make real CPU time available to it.
8	CPU System (%)	The portion of the current CPU utilization composed only of system time usage.
9	CPU User (%)	The portion of the current CPU utilization composed only of user time usage.
10	Disk Free (GB)	The cumulative disk space that is free across all supported devices in gigabytes.
11	Disk Free (%)	The cumulative disk emptiness percentage.
12	Disk Read Utilization (%)	The portion of disk I/O utilization for read operations.
13	Disk Reads/Sec	The number of read I/O operations per second.
14	Disk Total (GB)	The cumulative total disk space on system in gigabytes.
15	Disk Used (GB)	The cumulative disk space used across all supported devices, in gigabytes.
16	Disk Used (%)	The cumulative disk fullness percentage.
17	Disk Utilization (%)	The percent of time spent waiting for read or write disk I/O operations.
18	Disk Write Utilization (%)	The portion of disk I/O utilization for write operations.
19	Disk Writes/Sec	The number of write I/O operations per second.
20	Load Average Fifteen Min	Over the last fifteen minutes, the average number of system processes, threads, or tasks that are waiting and ready for CPU time.
21	Load Average Five Min	Over the last 5 minutes, the average number of system processes, threads, or tasks that are waiting and ready for CPU time.
22	Load Average One Min	Over the last minute, the average number of system processes, threads, or tasks that are waiting and ready for CPU time.
23	Memory Free (GB)	The portion of free memory available to this server, in gigabytes.
24	Memory Free (%)	The portion of free memory available to the server.
25	Memory Total (GB)	The total amount of memory, in gigabytes, available to this server.
26	Memory Used (GB)	The portion of available memory that is in use on this server, in gigabytes.
27	Memory Used (%)	The portion of available memory that is in use on the server.
28	Swap Free (GB)	The portion of available swap space on this server that is free, in gigabytes.
29	Swap Total (GB)	The total amount of swap space available to the server, in gigabytes.
30	Swap Used (GB)	The portion of available swap space on this server that is in use, in gigabytes.

NewRelicMemoryPoolInstanceStats

Memorypool stats provides memorypool related data for different instances running in new relic applications.

SR.No.	Graph Name	Graph Description
1	Average Value (MB)	Memorypool average value in megabytes.
2	Calls/Min	Memorypool calls per minute.
3	Call Count	Memorypool call count.
4	Standard Deviation	Memorypool standard deviation.

NewRelicStorageStats

Storage stats represents single storage device associated with a server. Each sample gathers descriptive information about the device, the type of file system it uses, and its current usage and capacity.

SR.No.	Graph Name	Graph Description
1	Disk Free (GB)	The cumulative disk space that is free across all supported devices in gigabytes.
2	Disk Free (%)	The cumulative disk emptiness percentage.
3	Disk Total (GB)	The cumulative total disk space on system in gigabytes.
4	Disk Used (GB)	The cumulative disk space used across all supported devices, in gigabytes.
5	Disk Used (%)	The cumulative disk fullness percentage.
6	Inodes Free	The number of free inodes.
7	Inodes Total	The number of total available inodes.
8	Inodes Used	The number of inodes in use.
9	Inodes Used (%)	The number of inodes in use as a fraction of the total.
10	Read Bytes/Sec	The number of bytes read per second from the device during the last sampling period.
11	Read IO/Sec	The average number of read I/O operations per second during the sampling period.
12	Read Utilization (%)	The percent of totalUtilizationPercent dedicated to read I/O operations.
13	Read Write Bytes/Sec	Read write bytes per second.
14	Total Utilization (%)	The percent of time spent waiting for read or write disk I/O operations.
15	Write Bytes/Sec	The number of bytes per second written to the device during the last sampling period.
16	Write IO/Sec	The average number of write I/O operations per second during the sample period.
17	Write Utilization (%)	The percent of totalUtilizationPercent dedicated to write I/O operations.

NewRelicApplicationStats

The applications resource provides general information about applications monitored. The time range for summary data is the last 3-4 minutes.

SR.No.	Graph Name	Graph Description
1	Response Time (ms)	Application response time in milliseconds.
2	Requests/Min	Number of requests served by the application per minute.
3	Error (%)	Ratio of the number of errors reported by the application to the total number of served requests.
4	Apdex Target	Threshold ratio of satisfactory response times to unsatisfactory response times.
5	Apdex Score	Ratio of satisfactory response times to unsatisfactory response times.
6	Host Count	Number of hosts serving the application.
7	Instance Count	Number of instances serving the application.

NewRelicMemoryInstanceStats

Memory stats provides memory related data for different instances running in new relic applications.

SR.No.	Graph Name	Graph Description
1	Used Memory By Host(MB)	Used memory by host in megabytes.
2	Total Used Memory (MB)	Total used memory in megabytes

NewRelicApplicationHostStats

The application hosts resource provides general information about the hosts in which applications monitored. The time range for summary data is the last 3-4 minutes.

SR.No.	Graph Name	Graph Description
1	Response Time (ms)	Application host response time in milliseconds.
2	Requests/Min	Number of requests served by the application host per minute.
3	Error (%)	Ratio of the number of errors reported by the application host to the total number of served requests.
4	Apdex Score	Ratio of satisfactory response times to unsatisfactory response times.
5	Instance Count	Number of concurrent instances serving the application host

NewRelicNetworkStats

Network stats captures the descriptive and state information for each network device associated with a server. It includes the device’s interface and address information, as well as current usage data.

SR.No.	Graph Name	Graph Description
1	Received Bytes/Sec	The number of bytes per second received during the sampling period.
2	Received Packets Dropped/Sec	The number of received packets per second dropped during the sampling period.
3	Received Errors/Sec	The number of receive errors per second on the interface during the sampling period.
4	Received Packets/Sec	The number of packets per second received during the sampling period.
5	Transmit Bytes/Sec	The number of bytes sent per second during the sampling period.
6	Transmit Dropped/Sec	The number of dropped send packets per second during the sampling period.
7	Transmit Errors/Sec	The number of send errors per second on the interface during the sampling period.
8	Transmit Packets/Sec	The number of packets per second sent during this sampling period.

DynaTrace Integration

This section is related to capturing metrics of DynaTrace through rest API. DynaTrace monitoring support is provided in ND.

With this integration, you can monitor DynaTrace Host stats. In DynaTrace, you can generate a token from the UI and this token never expires. Then, you can use this token to generate output or to get the metrics data.

Example:

curl -X GET “https://oza29404.live.dynatrace.com/api/v2/metrics?metricSelector=host.%2A&text=host%2A” -H “accept: application/json; charset=utf-8” -H “Authorization: Api-Token dt0c01.AFRJYCXJ5IXF6QX2UOYFXAJO.662FGO2WYEY2KLDVHX5W3MD6GY47PW2YWENXTGIMUAPU5NDNBJNUIMF7ANJ3SQVN”

Generation of API token via DynaTrace UI

Select Settings in the navigation menu.
Go to Integration > Dynatrace API.
Select Generate token.
Enter a name for your token.
Select the required permissions for the token.
Select Generate.
Copy the generated token to the clipboard. Store the token in a password manager for future use.

Note:

You can assign multiple permissions to a single token, or you can generate several tokens, each with different access levels, and use them accordingly

Integration with Monitors UI

Select Dynatrace from the Integrations tab.

2. This displays the Dynatrace Monitor window with two tabs – Configuration and Monitor(s). The details of both the tabs are described in the subsequent sections.