Skip to content

Resource Catalog


By creating custom resources, combined with configurations such as attributes, associated views, and JSON text, 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 classes, data ingested into the console will first apply the created templates. You can use this explorer template to view and analyze Resource Catalog data. If no match is found, the templates 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 "Required Attributes". Data must contain these fields to be received, which can be used for data filtering and interception.

Data Reporting

Prerequisite

Install DataKit and DataFlux Func.

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 steps, refer to Resource Catalog Data Reporting.

Note
  • Custom fields in Required Attributes are mandatory fields during data reporting. If the reported data lacks a required field, the data cannot be reported to the Guance workspace.
  • If the data type reported does not match the defined field data type, the data cannot be reported to the Guance workspace. For example: if the field type is defined as a string type in DataFlux Func but the reported data type is an integer, the data cannot be reported to the Guance workspace.
  • Resource Catalog data will be cleared 48 hours after going offline.

Create Resource Explorer

You can create an explorer in the following ways:

Custom Create: Click to directly enter the creation page.

Import Explorer Template: Import a template and then edit and modify it.

Start Configuration

Default Configuration

  1. Choose whether to group resources as needed.
  2. Define the resource classification name for Resource Catalog data reporting.
  3. Required Attributes: 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 fields you set, it will ultimately 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: Configure the table headers displayed by default in the explorer table.
    • Default Quick Filters: Configure 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 a view, and optionally fill in associated fields to bind built-in views or pages.
    • Color Fill Fields: List of fields used for color filling in the Honeycomb view mode. If not configured, all numeric type fields are listed by default.
    • Group Analysis Fields: List of fields available for group analysis in the Honeycomb view mode. If not configured, all string type fields are listed by default.
  6. Click OK.
Note
  • Built-in views here include all views. If there are views with the same name, 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 Required Attributes.
  • Modify the JSON configuration as needed.
  • Click OK.

Resource Class

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

  • Use the search bar to quickly locate resources by name.
  • Click the button:
    • Modify or Export the existing object classification.
    • Delete this explorer template.
    • Add this resource class to the secondary menu for easier viewing.
  • Click the collapse/expand button to collapse the resource class list, accommodating page display preferences.
  • Add Group: Categorize resource explorers. After adding, click the button to the right of an individual 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 a group and choose to "Delete Group Only" or "Synchronously Delete All Explorer Templates Under the Group".
Note

After adding a field, the existing 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 completely delete the data, you can go to Manage > Delete Resource Catalog to perform the deletion.

  • Specify Resource Catalog Classification: Only deletes data under the selected object classification; 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 reported for all infrastructure customizations will be deleted and cannot be recovered. All set Resource Catalog classification data needs to be reported again. Deleting all Resource Catalogs is limited to 5 times per day.

Cross-Workspace Query

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

Resource Catalog Explorer

View and analyze the Resource Catalog in list or honeycomb view mode.

Quick Filter

You can add filter items for the Resource Catalog.

Note

Workspace-level filter items can only be added by the current workspace Owner and Administrator.

  1. Click the Add Workspace-level Filter Item button.
  2. Search for or directly add fields from the dropdown.
  3. Click OK.

For more details, refer to Explorer Quick Filter.

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 attributes, complete information, associated views, etc.

Basic Attributes

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

Associated Views

Bind or delete built-in views (system views, user views) to the infrastructure Resource Catalog detail page.

Note

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? ×