Skip to content

Template Management

The Template Management page allows you to view, search, and import all built-in template projects of Guance.

  1. You can filter templates directly by category or language; in the search box, you can enter keywords directly to search and locate;
  2. Click Batch Operations to delete selected templates in bulk; you can also click the delete button on the right side of a template to perform the operation;

Import Templates

Template Management has two versions: the version used by Deployment Plan users before the update 1.89.169 and the updated version. Based on the different versions, there are some slight differences when importing templates for different template types.

Currently, both versions support importing the following types of templates: Built-in Views, Detection Library, Custom Explorer, Pipeline.

Before Version Update

  • When selecting different template types, you can directly download templates on the import configuration page > to the right of the category drop-down list;
  • After exporting Detection Library and Pipeline templates, you must edit the JSON file according to the official template specifications before use.
Editing Instructions

Detection Library:

  1. checkers: Must be replaced with the exported monitor template;
  2. title: Required; Detection Library name;
  3. summary: Optional; Detection Library description;
  4. iconSet: Optional; Detection Library logo link; if not configured, the official default logo will be displayed;
  5. thumbnail: Not required to configure, but cannot be deleted; otherwise, import will fail.

Pipeline (only supports log Pipeline):

  1. pipeline name; format: xxxx.p;
  2. pipeline: Required; parsing rules (must be Base64-encoded text);
  3. examples: Optional; sample data, supports configuring multiple (must be Base64-encoded text).

After Version Update

All four types of templates can be exported directly from the front-end console and imported from the management backend.

Note: Supports uploading multiple files at once.

Built-in Views: Can be created and exported in the console > Dashboard / Custom Views.

Custom Explorer: Can be created and exported in the console > Scenarios > Explorer.

Detection Library: The Detection Library of Guance contains multiple monitor rule templates. Supports exporting in the monitor list.

You can directly import one or more monitor templates. The Detection Library name must be unique, but there are no restrictions within the monitor.

Pipeline: Supports multiple types, including log, metrics, RUM, etc.

During import, Pipeline names of the same type cannot be duplicated. After successful import, the Pipeline type can be viewed in the description of the template list. If the imported Pipeline template contains test sample data, it will be displayed in the testData of the official library template details.

Export Instructions

  1. category: Data type; supports importing non-log templates;
  2. name: Pipeline name;
  3. content: Pipeline script content;
  4. testData: Optional; test sample data.

After successful import, the Pipeline type will be automatically recognized and filled in the description of the list, and it will distinguish between Chinese and English.

Feedback

Is this page helpful?