The User-defined Collections view in the Databases Administration dashboard allows adding user-defined collections to all of the currently selected agents, to provide for queries not included in Foglight for SQL Server.
After collections are added, this view displays all of the user-defined collections for all of the agents; for example, if a collection was added to 12 agents during its addition, the view will display 12 rows, showing the collection for each agent.
This view can also be used for configuring the sampling frequency for each collection. The available sampling frequencies are as follows:
• Real-Time - When a user is currently focusing on a screen, the sampling frequency for all of the collections associated with this screen switches to Real-Time.
• Online - When at least one user is connected, the sampling frequency for all of the collections that are not currently running at Real-Time frequency switches to Online.
• Offline - when no user is currently connected to the application
To add user-defined collections:
1 Click Add.
The User-defined Collections screen appears.
2 Type a name in the Collection Name field.
3 Enter a brief description of the collection in the Collection description field (optional). 4 Paste the query’s SQL text in the Query Text field. This field can hold up to 4096 characters. 5 Type a value, in seconds, in the Query Timeout field.
6 Click Verify.
The collection is verified by running the query on each of the currently selected agents.
After the verification process is complete, the Verification Results pop-up appears, indicating whether the collection was verified successfully. In case the collection verification failed, the error message is displayed.
IMPORTANT: Agents must be enabled for user-defined collections. If one or more of the selected agents is not enabled for such collections, this view allows enabling them. To disable or modify the credentials of a currently enabled agent, go to the Connection Details view and click the agent to edit it. For details, see Step 9 on page 140.
IMPORTANT: If one or more of the selected agents is not enabled for user-defined collections, a dialog box appears to notify this issue, displaying a table of the currently disabled collections. Use this dialog box to enable all agents for user-defined collections. To enable only part of these agents, exit the Databases Administration dashboard and select only these agents that are currently enabled or need to be enabled for user-defined collections before entering again the Databases Administration dashboard.
Table 70. If the verification succeeded on at least one agent, the collection details are displayed as below.
Section Field Description
Database
ID The collections’ ID
Column Name The name of the column
Column Type The field type, as retrieved by the query (String, Integer and so on) Data Storage Display Name The column’s display name
Except for the Column Name and Column Type fields, whose values are retrieved by the query and cannot be changed, all other fields can be edited by clicking any of them.
The Edit Collection Properties dialog box appears, allowing you to edit the values of the following parameters: • Display name • Type • Unit of Measurement/Indicator • Aggregation Type
The topology type for storage purposes. This type can be one of the following:
• String • Integer • Double • Boolean • Date
NOTE: When the Frequently modified check box is selected (the default state), the field’s change history is kept, including use of optional functionality such as use of the IntelliProfile mechanism and aggregation type selection. Clearing this check box is recommended only for fields whose values change infrequently, such as IP address of a specific host, as storing the change history of such fields is highly CPU- intensive and may degrade the FMS
performance. Unit of
Measurement/Indic ator
The metric’s Unit of Measurement/Indicator. The possible measurement unit values are: Percent, Count, Millisecond, Second, Minute, Hour, Day, Byte, Kilobyte, Megabyte and Gigabyte.
Aggregation
Allows defining the value that is displayed in this metric, out of several values that were returned in the relevant time range. The available aggregation values are:
• As is — value of the last sample taken during the selected time range
• Sum — summarized value of all samples taken during the selected time range • Average — average value of all samples
taken during the selected time range
Is Key
Indicates whether the field is the query’s key for retrieval.
NOTE: Fields that are indicated as keys should correspond with the database result set unique values. Selecting a field which has frequently changing and repeating results as key is allowed, but may result in unexpected behavior from the defined collection.
Table 70. If the verification succeeded on at least one agent, the collection details are displayed as below.
In addition, the collection’s sampling frequencies are displayed on the table at the bottom of the view, and can be edited by clicking any of them.
7 Ensure that all settings are appropriate, and click OK to finish the collection creation process. The newly created collection now appears on the table.