Skip to content

Resource Catalog


By creating custom resources, combined with properties, associated views, JSON text, and other configurations, you can use the DataKit API and DataFlux Func to report any data to Guance, including cloud vendor cloud resource data, enterprise business data, etc., and perform visual management and correlation analysis in the console's custom resource explorer.

By creating explorer templates that match the data characteristics for different resource classifications, data accessed by the console will preferentially apply created templates. You can use this explorer template to view and analyze Resource Catalog data. If no match is found, a template from the official template library will be applied.

Note
  • Whether or not an explorer template is created for a resource does not affect the reporting and receiving of data;
  • The template supports configuring "mandatory properties". Data must contain this field to be received, which can be used for data filtering and interception.

Data Reporting

After adding the Resource Catalog classification, you can proceed with custom data reporting. Report data to DataKit via DataFlux Func, and finally report the data to the Guance workspace via DataKit.

For specific operations, please refer to Resource Catalog Data Reporting.

Create Resource Explorer

You can create an explorer in the following ways:

Create directly using the system template library. Click and select it in the right slide-out panel.

Create a custom one

Import an explorer template.

You can create explorer templates that match the data characteristics for different resource classifications. Data accessed by the console will preferentially apply created templates. If no match is found, a template from the official template library will be applied.

Note
  • Whether the resource's explorer template is created does not affect the reporting and receiving of data;

  • The template supports configuring "mandatory properties". Data must contain this field to be received, which can be used for data filtering and interception. If the reported data lacks a mandatory field, the data cannot be reported to the Guance workspace.

Start Configuration

Default Configuration

  1. Choose whether to group resources as needed;
  2. Define the resource classification name for Resource Catalog data reporting;
  3. Mandatory Properties: Fields that must be included in the data; the object's name field is added by default. If the reported data does not contain the field you set, it will not be reported to Guance, thereby filtering out non-compliant data;
  4. Enter an alias for the resource classification. Once configured, the alias is displayed preferentially in the list;
  5. Explorer Display Configuration:
    • Default Display Columns: The table headers displayed by default in the explorer table;
    • Default Quick Filters: The filter fields displayed by default in the quick filter on the left side of the explorer;
    • Detail Page Associated Views: Define the view display name, select the view, fill in the associated fields as needed to bind built-in views or pages;
    • Color Fill Fields: The list of fields used for color filling in the honeycomb chart mode. If not configured, all numeric type fields are listed by default;
    • Group Analysis Fields: The list of fields that can be used for group analysis in the honeycomb chart mode. If not configured, all string type fields are listed by default.
  6. Confirm.
Note
  • The built-in views here include all views; if there are duplicates, user views take precedence over system views;
  • Built-in pages include explorer lists (e.g., Logs, Traces, Containers), network topology, and other page templates.

JSON Configuration

When switching from Default Configuration to JSON Configuration, if you choose:

  • Yes: The currently filled content will be automatically brought into the JSON configuration;
  • No: After entering JSON mode, only the basic configuration will be provided.

  • Choose whether to group resources as needed;

  • Add Mandatory Properties;
  • Modify the JSON configuration as needed;
  • Confirm.

Resource Classification

In the resource classification list on the left side of the page, you can perform the following operations:

  • In the search bar, enter the resource name for quick positioning;
  • Navigate to the Service List page;
  • Click the button:
    • Modify or Export the existing object classification;
    • Delete this explorer template;
    • Add this resource classification to the secondary menu for easier viewing.
  • Click the collapse/expand button to collapse the resource classification to meet page display preferences;
  • Add Group: Categorize the resource explorers. After adding, click the button to the right of a single resource to move the current resource to the target group;
    • Click the button to the right of the group name to modify the group's name;
    • You can delete the group and choose whether to "Delete Group Only" or "Also Delete All Explorer Templates Under the Group" as needed.
Note

After adding a field, the original object data remains unchanged. Subsequently reported data must contain the newly added field.

Delete

Deleting an explorer template here does not delete the data. If data continues to be reported, the default explorer template will be applied automatically.

If you want to delete the data completely, you can go to Manage > Delete Resource Catalog to perform the deletion operation.

  • Specify Resource Catalog Classification: Only deletes data under the selected object classification and does not delete the index;
  • All Resource Catalogs: Deletes all Resource Catalog data and indexes.
Note
  • Only the Owner and Administrator can perform deletion operations;
  • Once all Resource Catalogs are deleted, all data and indexes for all infrastructure custom data reported will be deleted and cannot be recovered. All set Resource Catalog classification data needs to be reported again. The operation to delete all Resource Catalogs is limited to 5 times per day.

Cross-Workspace Query

Select all workspaces associated with the account to enable cross-space query of resource list data.

Resource Catalog Explorer

View and analyze the Resource Catalog in list or chart form.

Detail Page

After Resource Catalog data is reported, click the name in the Resource Catalog list on the right side of the explorer to slide out the detail page and view detailed information about the object, including the object name, extended properties, complete information, associated views, etc.

Basic Properties

You can view all property fields attached to this Resource Catalog data.

Associated Views

Bind or delete built-in views to the infrastructure Resource Catalog detail page.

Before binding a built-in view, you need to confirm whether the view variables in the bound built-in view contain fields related to this Resource Catalog, such as host.

Further Reading

Feedback

Is this page helpful? ×