1. Simplified the Tracing-enabling procedure for non-containerized projects.
2. Allowed disabling Tracing.
FineOps provides a Tracing function to facilitate performance troubleshooting, but enabling this function requires preliminary preparations.
This document describes the checks and preparations required for FineOps and O&M projects before you use the Tracing function.
1. The Tracing function is only available in FineOps Standard Edition and is unavailable in FineOps Basic Edition.
2. The Tracing function only applies to the following project components: FineReport, FineDataLink, FineBI - Application Node (of FineBI V6.x projects), FineBI - Application Node, Engine - Metadata Node, Engine - Calculation Node, and Nginx, and is unavailable for other components.
3. In Tracing, the First-Screen Trace function is available for PC-end visits only, while the Trace function applies to visits on both PC and mobile ends.
FineOps Basic Edition does not support Tracing. If Basic Edition is displayed in the top-left corner, install FineOps Standard Edition.
For details, see FineOps Deployment.
The Tracing function is provided by the following O&M components of FineOps: Elasticsearch and SkyWalking OAP.
To use the Tracing function, you must first ensure that these components are started. Otherwise, the prompt will appear, saying "Tracing-related components are not enabled. Start Elasticsearch and SkyWalking OAP in O&M Component."
Log in to FineOps as the admin, choose Platform Management > O&M Component, start the Elasticsearch component first, and then start the SkyWalking OAP component.
To enable Tracing, first check the disk space usage of the partition where FineOps is located. Ensure the usage does not exceed 90%.
If the disk usage of the partition where FineOps is located is 90% or higher, the Tracing function cannot be enabled.
Before officially using the Tracing-related functions, configure the related parameters in the global settings first. These settings apply to all O&M projects in FineOps.
Log in to FineOps as the admin, choose Setting > Tracing, configure these parameters, and click Save.
The following table describes the setting items.
It refers to the number of days the trace data is retained, which defaults to 5 days.
To increase the number of retention days, ensure the disk has sufficient space. When the disk space is insufficient, the data collection will automatically stop.
You can evaluate the required increment of the disk space by Number of projects * Incremental day count * 10 GB.
It refers to the maximum number of collections at a single endpoint in three seconds.
The default value is -1, meaning no limit.
The input range is -1 to 10000.
You can exclude endpoints from collection.
Endpoints excluded from collection by default include:
/webroot/decision/metrics/schedule
/webroot/decision/system/health
/webroot/decision/metrics/once
It refers to the maximum number of spans collected per endpoint. Any excess spans will be discarded.
The default value is 300.
The input range is 0 to 10000.
You can raise the collection threshold for information with low anomaly probability (for example, pre-connection validation) to highlight critical data.
The default value is 5 (unit: ms).
The value -1 means no limit.
It is used as a slow request indicator of Tracing and Health Inspection (in Template Performance).
The default value is 10000 ms.
Enter an integer of 1000 or greater.
Log in to the project as the admin and choose System Management > Registration Management > Version Information to view the minor version number of the project.
Ensure the O&M project versions meet the following requirements: 11.0.12 or later for FineReport projects, 6.0.9 or later for FineBI projects, and 4.2.1.1 or later for FineDataLink projects.
Ensure the O&M project is available. Otherwise, a prompt will appear, saying "Abnormal project status. Use this project after restoring it or view other projects."
The SkyWalking OAP component of FineOps is responsible for analyzing, processing, and reporting data.
Therefore, you must ensure that the servers hosting the FanRuan projects can access the ports of SkyWalking OAP.
The default ports of SkyWalking OAP are 11800 and 12800.
Tracing is enabled by default for O&M projects deployed via the current FineOps if the requirements are met, requiring no operation described in this section.
For O&M projects not deployed via the current FineOps, Tracing must be manually enabled.
1. Enable Tracing.
Log in to FineOps as the admin, click the O&M project for which you want to enable Tracing, and click Tracing.
Click Enable Tracing below the message "Tracing is not enabled."
A prompt will appear, saying "Manually restart the project. You need to manually restart the project after enabling Tracing." Click OK. Tracing will be enabled after the restart.
2. FineOps performs configuration automatically.
After Tracing is enabled, FineOps will automatically:
Transfer the skywalking-java-agent file to the WEB-INF directory of the FanRuan projects.
Add the necessary skywalkingAgent-related startup parameters to the configuration of FanRuan projects.
3. Restart the project manually.
Restart the FanRuan project. For details, see Closing or Restarting FineBI, Closing or Restarting the FineReport Project, and Stopping/Restarting/Starting a FineDataLink Project.
Once completed, the Tracing function is available for the non-containerized FanRuan projects.
1. You must perform the above operations sequentially on all nodes in the FanRuan project.
2. The skywalking-java-agent file is continuously updated and upgraded, and FineOps will check if the file in the project requires an update upon the admin's login.
FineOps will update it automatically if an update is available. After a successful update, you need to restart the FanRuan project to apply the changes.
If the file has been updated but you have not restarted the non-containerized project, a prompt will appear when you use Tracing for the project, saying: "The Tracing function of the current project can be updated. Restart the project to complete the update."
1. Log in to FineOps as the admin, click the project for which you want to enable Tracing, and click Tracing.
2. Click Enable Tracing below the message "Tracing is not enabled." A prompt will appear, saying "The xxx project will restart automatically. If you enable Tracing for this project, the project will be automatically restarted, which will take 3 to 5 minutes. Do you want to continue?"
3. Click Restart Project and Continue to initiate the automatic restart. Tracing will be enabled after a successful restart.
The skywalking-java-agent file is continuously updated and upgraded.
For projects not deployed via FineOps, FineOps checks whether an update is available for the skywalking-java-agent file in the project upon the admin's login.
You can disable the Tracing function for projects in FineOps.
1. Log in to FineOps and choose Setting > Tracing.
2. Disable Tracing for the target project. A prompt will appear, saying "Are you sure to disable Tracing for the project?" Click OK.
3. Restart the O&M project to apply the changes.
For FineOps-deployed projects, you can restart the application node component under Project Management > Maintenance > Component Management.
For projects not deployed via FineOps, restart them by referring to Closing or Restarting FineBI, Closing or Restarting the FineReport Project, and Stopping/Restarting/Starting a FineDataLink Project.
Once Tracing is enabled, trace data will be retained for five days by default.
However, the trace data collection will automatically stop if the disk space is insufficient, requiring the cleanup of historical trace data.
2. Locate the target project in Tracing Disabling and click the Empty button to clean up historical trace data.