Search Templates¶

Adding a Search Template¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

   

   Search Templates¶

2. Click Add.

   

   Adding a Search Template¶

3. Select a Pool, a Machine, and a LogPoint User.

4. Enter a Name and a Description.

5. Enter a basequery name and a query.

   Note

   • Use {{ and }} to enclose placeholders in the queries.

   • Click the Plus icon to add new base queries and the Minus icon to remove a field.

6. In the Fields section, enter a Field which is a placeholder used in a base query, a Display Text for the field, and a default Value.

   Note

   You can provide multiple values for Field, Display Text, and Value.

7. Click Submit.

Pushing Search Templates¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Select the search templates and click Push.

   

   Pushing a Search Template¶

   

   Push Search Templates¶

3. Select the Pool, LogPoint, or User where you want to push the selected search templates.

4. Click Push.

Push History¶

You can click the Push History button to check the push history.

Push History¶

The Push History page lists the Push Summary, Status, Date, and Actions of all push attempts.

Click the Retry () icon from the Actions column to retry the failed push attempt.

Click the Details () icon from the Actions column to open the Push Detail page.

Editing a Search Template¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Click the Edit icon from the Actions column of the search template.

Editing a Search Template¶

3. Update the information.

4. Click Submit.

Sharing Search Templates¶

You can share a search template with all the users in the system and give them the read, edit, or full permissions. Any changes made in the search templates are visible to all the shared users.

Each parameter in a shared search template is categorized into three types:

1. Global parameters can be changed only by the users with the Edit or Full permissions. Changes in the global parameters are reflected for all the users using the shared search template. The following parameters are global:

   • The name, description, queries, and field values of the search template.

   • Title and order of tabs, including creation and deletion of tabs.

   • Title, query, dimensions, and positions of widgets, including addition and deletion of widgets.

2. Personalized parameters can be changed by all the users. However, the changes in the personalized parameters are reflected only for the users making the change. The following parameters are personalized:

   • The updatable parameters

   • Selected repos

   • Time range

3. Hybrid parameters can be changed by all the users. If the user changing the parameters has the Edit or Full permissions, the changes are reflected for all the users. However, if the user has only the Read permission, the changes are reflected only for the user making the change. The following parameters are hybrid:

   • Chart types of widgets

   • Legends and legend labels of widgets

   • Trend state of widgets

To share a search template:

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Click the Share Template icon from the Actions column of the search template.

   

   Search Templates¶

   1. To share multiple search templates, select the search templates. Click the More drop-down and select Share Selected With Other Users.

      

      Share Multiple Search Templates¶

3. Select the users groups for all the users you want to share the search templates.

   

   Providing Permissions for the Shared Search Template¶

4. Select the Read, Edit, or Full permissions for the users.

5. Click Submit.

Cloning Search Templates¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Click the Clone icon from the Actions column of the search template.

   

   Search Templates¶

3. Select a LogPoint user from the drop-down.

   

   Clone Search Template¶

4. Enter a new Name for the cloned template.

5. Select the Replace Existing? checkbox to replace an existing template with the same name.

6. Click Clone.

Deleting Search Templates¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Click the Delete icon from the Actions column of the search template.

   

   Search Templates¶

   1. To delete multiple search templates, select the search templates. Click the More drop-down and select Delete Selected Templates.

      

      Delete Selected Search Templates¶

   2. To delete all the search templates, click the More drop-down and select Delete All.

      

      Delete all Search Templates¶

3. Click Yes.

Viewing a Search Template¶

1. Go to Settings >> LogPoint Configuration >> Search Templates.

2. Click the Name of the template you want to view.

   

   Search Templates¶

   LPSM directs you to the Search Template View where you can access the dashboards of the search template. From the Search Template View, you can perform the following tasks:

Auto Arrange the Widgets¶

Click Auto Arrange to automatically arrange the widgets in a presentable form.

Dashboard¶

Updating Parameters¶

1. Enter the new values for the variables in the Update Parameters section.

Update Parameters Panel¶

2. Select Override widget time range to select a time-range. The time-range you provide takes precedence over the one provided for individual widgets.

3. Select the Repos where you want to perform the search.

4. Click Update.

Stopping widget update¶

After clicking Update, the widgets continuously retrieve their respective logs.

Click the Stop button to stop the widgets from retrieving additional logs. Doing this pauses the visualization of all the widgets. You can only see the already received log results.

Stop Update¶

Note

• The widgets show updated values only after you click the Update button.

• Click Back to redirect to the list view of the search templates.

• The search templates remember the last visualization used on the widgets.

• You can drill-down on the search results from the non-edit mode of the widget of the search templates.