Configure trace query parameters

2025-01-10 06:15:54  Updated

Before you perform a trace query, you must configure the trace query parameters.

Prerequisites

The logged-on user has the ADMIN or PROPERTY_MANAGER role in OceanBase Cloud Platform (OCP).

Procedure

  1. Log on to the OCP console.

  2. In the left-side navigation pane, click Log service to go to the corresponding page.

  3. Click the Link query tab.

  4. In the dialog box that appears, click Modify system parameters to go to the System Parameters page.

    1

    Note

    • If you go to the System Parameters page by following the preceding steps, OCP automatically filters the parameters and displays only the parameters related to trace query.
    • You can also go to the System Parameters page by choosing System Management > System Parameters. In this case, OCP displays all system parameters on the System Parameters page.
  5. Set trace query parameters.

    2

    You can configure the parameters based on the following table.

    Parameter Description
    ocp.analyze.enabled Specifies whether to enable the data mid-end platform. You must set this parameter to true.
    ocp.analyze.ob.trace.enabled Specifies whether to enable trace data capture. You must set this parameter to true.
    ocp.analyze.es.client.addresses The endpoint of the OpenSearch cluster. Separate multiple endpoints with commas (,).
    ocp.analyze.es.client.username The username used to log on to the OpenSearch cluster.
    ocp.analyze.es.client.password The password used to log on to the OpenSearch cluster.
    ocp.analyze.es.index.keep.days The number of days that the OpenSearch indexes are retained. You can use the default value.
    ocp.analyze.es.index.replicas The number of replicas of each OpenSearch index. If you use only one OpenSearch server, you must set this parameter to 0.
    ocp.analyze.es.index.shards The number of shards of each OpenSearch index. You can use the default value.
    ocp.analyze.ob.log.enabled Specifies whether to enable OceanBase log capture. We recommend that you set this parameter to false.

Contact Us