Resource Catalog¶

By creating custom resources and configuring attributes, associated views, JSON text, etc., you can use the DataKit API and DataFlux Func to report any data to TrueWatch, including cloud vendor resource data, enterprise business data, etc., and perform visual management and correlation analysis in the custom resource explorer of the console.

By creating explorer templates that match the data characteristics for different resource classes, the templates created will be applied first when data is reported to the console. You can view and analyze resource catalog data through this explorer template. If no match is found, the template from the official template library will be applied.

Note

Whether or not an explorer template is created for a resource, it does not affect data reporting and reception.
The template supports configuring "required attributes". Data must include these fields to be received, which can be used for data filtering and interception.

Data Reporting¶

After adding a resource catalog class, you can proceed with custom data reporting. Use DataFlux Func to report data to DataKit, and finally through DataKit to report data to the TrueWatch workspace.

For specific operations, refer to Resource Catalog Data Reporting.

Create a Resource Explorer¶

You can create an explorer in the following ways:

Use the system template library to directly create one. Click and select in the slide-out panel.

Custom creation

Import an explorer template.

You can create explorer templates that match the data characteristics for different resource classes. When data is reported to the console, the created templates will be applied first. If no match is found, the template from the official template library will be applied.

Note

Whether an explorer template is created for a resource, does not affect data reporting and reception.
The template supports configuring "required attributes". Data must include these fields to be received, which can be used for data filtering and interception. If the reported data lacks required fields, that data will not be reported to the TrueWatch workspace.

Configure¶

Default Configuration¶

Choose whether to group resources as needed.
Define the resource class name used when reporting resource catalog data.
Required attributes: fields that must be included in the data. The name field of the object is added by default. If the reported data does not contain the fields you set, it will not be reported to TrueWatch, thus filtering out non-conforming data.
Enter an alias for the resource class. After configuration, the alias will be displayed first in the list.
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 a view, and fill in the associated fields as needed to bind built-in views or pages.
- Color fill fields: in honeycomb chart mode, the field list used for color filling. If not configured, all numeric type fields are listed by default.
- Group analysis fields: in honeycomb chart mode, the field list optionally used for group analysis. If not configured, all string type fields are listed by default.
Confirm.

Note

The built-in views here include all views. If there are duplicate names, 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, select:

Yes: automatically bring the current content into the JSON configuration.
No: only basic configuration will be provided after entering JSON mode.
Choose whether to group resources as needed.
Add required attributes.
Modify the JSON configuration as needed.
Confirm.

Resource Classes¶

In the resource class 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.
Go to the Unified Catalog > Services page.
Click the button:
- Modify or export an existing object class.
- Delete the explorer template.
- Add the resource class to the secondary menu for easy viewing.
Click the collapse button to collapse the resource classes, satisfying page display preferences.
Add groups: to categorize resource explorers. After adding, 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 a group to modify the group name.
- Delete a group, and choose to either "delete only the group" or "delete all explorer templates under the group simultaneously".

Note

After adding fields, the original object data remains unchanged, but subsequent reported data must include the new fields.

Delete¶

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

To completely delete the data, you can go to Management > Delete Resource Catalog to perform the deletion.

Specify a resource catalog class: only delete the data under the selected object class, without deleting the index.
All resource catalogs: delete all resource catalog data and indices.

Note

Only the Owner and Administrator can perform deletion operations.
Once all resource catalogs are deleted, all data and indices reported to Infrastructure Custom will be completely deleted and cannot be recovered. All set resource catalog class data needs to be re-reported. 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 query resource list data across workspaces.