Log Extension Component Development Guide ​

Feature Introduction ​

As a pluggable extension component, the logging system is independently deployed on the openFuyao platform and provides log filtering, search, query, and alerting capabilities for both the platform and users.

Constraints ​

None.

Environment Preparation ​

For detailed installation steps, see Installation Guide.

Usage Scenarios ​

Scenario Overview ​

Developers need to install the log extension on the openFuyao cluster management plane. During installation, several options can be configured so that the logging system better matches service requirements:

• Configure the time limit for collected logs and the log retention update policy.
• Configure log collection sources.
• Configure custom alerting rules for logs.

System Architecture ​

The service layer of the logging system consists of the UI layer, backend layer, and component layer.

• UI layer: Users perform log operations on the console website.
• Backend layer: logging-operator is deployed as a microservice to provide core capabilities such as log filtering, search, query, configuration, and alerting.
• Component layer: Provides key capabilities for log collection, storage, and processing, and integrates with the backend layer to support efficient log operations.

Figure 1 Architecture of the log extension

Interface Description ​

Main APIs are listed in the following table.

Table 1 Main Interface Description

Development Steps ​

After the log extension is installed successfully, for detailed steps see Logs.

Verification ​

When the configured collection job name and collection source path match the listed paths in workflows of the current logging system, the configuration takes effect.

Table 2 Verification API