Resource Catalog¶

In addition to hosts, containers, and processes, you can create custom resources by combining attributes, associated views, JSON text configurations, and use the DataKit API and DataFlux Func to report any data to Guance, including cloud vendor resources data, various business data of enterprises, and other arbitrary data that needs to be observed. Ultimately, all data will be uniformly visualized and analyzed in the custom resource explorer on the front-end console.

By creating explorer templates tailored to the characteristics of different resource classes, after the data is connected to the console, it will prioritize applying created templates. You can use this explorer template to view and analyze the data from the resource catalog. If no match is found, the official template library's template will be applied.

Note:

1. Whether or not a resource explorer template is created does not affect the reporting and reception of data;
2. The "mandatory properties" in the template can be configured, and the 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 through DataFlux Func to DataKit, and ultimately report the data through DataKit to the Guance workspace.

For specific operational steps, refer to Resource Catalog Data Reporting.

Note:

1. Custom fields in the mandatory properties are required fields when reporting data. If the reported data lacks the required fields, it will not be reported to the Guance workspace;
2. If the data type of the reported data 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 character type in DataFlux Func, but the data type during reporting is integer type, then the data will not be reported to the Guance workspace;
3. Resource catalogs that go offline for 48 hours will be cleared.

Create a Resource Explorer¶

You can create an explorer in the following ways:

Custom creation: Click to directly enter the creation page.

Import explorer template: Import the template and then edit it.

Start Configuration¶

Default Configuration¶

1. Select whether to group resources as needed;
2. Define the name of the resource class for reporting resource catalog data;
3. Mandatory properties: Fields that must be included in the data; default adds the object's name field. If the reported data does not contain the fields you set, it will not be reported to Guance, thus filtering out non-standard data;
4. Input the alias of the resource class, and after configuration, the list will prioritize displaying the alias;
5. Explorer display configuration:
   • Default displayed columns: That is, the default headers displayed in the explorer table configuration;
   • Default quick filter: That is, the default filter fields displayed in the quick filter on the left side of the explorer;
   • Detail page associated view: Define the view display name, select the view, and fill in the associated fields as needed, thereby binding built-in views or pages;
   • Color fill field: In the honeycomb chart mode, the list of fields used for color filling, if not configured, it will default to listing all numeric-type fields;
   • Group analysis field: In the honeycomb chart mode, the list of fields available for group analysis, if not configured, it will default to listing all string-type fields;
6. Click confirm.

Note:

• Built-in views include all views; if there are duplicates, user views take precedence over system views;
• Built-in pages include explorer lists (such as logs, traces, containers), network topology, etc., page templates.

JSON Configuration¶

When switching from default configuration to JSON configuration, if selected:

• Yes: Automatically imports the current content into JSON configuration;

• No: After entering JSON mode, only basic configurations are provided.

• Select whether to group resources as needed;

• Add mandatory properties;
• Modify JSON configuration as needed;
• Click confirm.

Resource Classifications¶

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

• In the search bar, input the resource name for quick positioning;
• Click the button:
  • Modify or export existing object classifications;
  • Delete this explorer template;
  • Add this resource classification to the secondary menu for easier viewing.
• Click the expand/collapse button to hide the resource classification to meet display preferences.
• Add groups: That is, categorize the resource explorers. After completion, click the button on the right side of a single resource to move the current resource to the target group.
  • Click the button on the right side of the group to modify the name of the group;
  • Delete the group and choose whether to "only delete the group" or "synchronously delete all explorer templates under the group" as needed.

Note: After adding fields, the original object data remains unchanged, but subsequently reported data must include the newly added fields.

Delete¶

Deleting the explorer template here will not delete the data. If data continues to be reported, it will automatically apply the default explorer template.

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

• Specific resource catalog classification: Only deletes the data under the selected object classification, does not delete the index;
• All resource catalogs: Deletes all resource catalog data and indexes.

Note:

1. Only Owner and Administrator can perform deletion operations;
2. Once all resource catalogs are deleted, all data and indexes reported to the custom infrastructure will be deleted and cannot be recovered. All settings for resource catalog classification data need to be re-reported, with a limit of 5 deletions per day.

Cross Workspace Query¶

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

Resource Catalog Explorer¶

View and analyze the resource catalog in list or honeycomb chart form.

Quick Filter¶

You can add filters to the resource catalog.

Note: Space-level filters can only be added by the current workspace Owner and Administrator.

1. Click the Add space-level filter button;
2. Search or directly add fields in the dropdown box;
3. Click confirm.

For more details, refer to Explorer Quick Filter.

Detail Page¶

After reporting resource catalog data, clicking the name in the resource catalog list on the right side of the explorer will slide out the detail page to view detailed information about the object, including object name, extended attributes, associated views, etc.

Basic Attributes¶

View all attribute fields attached to the resource catalog data.

Associated Views¶

That is, bind or delete built-in views (system views, user views) to the infrastructure resource catalog detail page.

Note: Before binding built-in views, ensure that the view variables in the bound built-in views contain fields related to the resource catalog, such as host.

More Reading¶