Volcengine ESCloud Cloud Search Service

Collect Volcengine ESCloud Cloud Search Service Metrics

Configuration¶

Install Func¶

It is recommended to activate TrueWatch Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed, please proceed with the script installation

If deploying Func manually, refer to Manually Deploy Func

Install Script¶

Note: Please prepare the required Volcengine AK in advance (for simplicity, you can grant the global read-only permission ReadOnlyAccess)

To synchronize ESCloud cloud resource monitoring data, we install the corresponding collection script: 「TrueWatch Integration (Volcengine - Cloud Search Service Collection)」(ID: integration_volcengine_es_cloud)

After clicking 【Install】, input the corresponding parameters: Volcengine AK, Volcengine account name, and Regions.

Click 【Deploy Startup Script】, the system will automatically create the Startup script set and configure the corresponding startup scripts.

After enabling, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click 【Execute】 to immediately execute once without waiting for the scheduled time. After a while, you can check the execution task records and corresponding logs.

Verification¶

1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the automatic trigger configuration, and check the task records and logs for any exceptions
2. In TrueWatch, check if asset information exists in 「Infrastructure - Resource Catalog」
3. In TrueWatch, check if there are corresponding monitoring data in 「Metrics」

Metrics¶

Configure Volcengine ESCloud monitoring metrics to collect more metrics through configuration Volcengine Cloud Search Service Metrics Details

Volcengine ESCloud Cloud Search Service Monitoring Metrics¶

Volcengine ESCloud metrics are located under the volcengine_VCM_ESCloud measurement. Here are the related metric descriptions

Objects¶

The collected Volcengine ESCloud object data structure can be seen in 「Infrastructure - Resource Catalog」

  {
    "measurement": "volcengine_es_cloud",
    "tags": {
    "InstanceId"      : "o-0089apbhxxx",
    "RegionId"        : "cn-guangzhou",
    "Status"          : "Running",
    "ESEip"           : "118.145.xxx.xxx",
    "UserId"          : "2102598885",
    "ESEipId"         : "eip-11vuua67wc3r440yrhczl0xxx",
    "KibanaEipId"     : "'\'",
    "KibanaPublicDomain"                  : "'\'",
    "CerebroPublicDomain"                 : "'\'",
    "KibanaPrivateDomain"                 : "https://visual-o-xxxxxapbhpvmd.escloud.ivolces.com:5601",
    "CerebroPrivateDomain"                : "'\'",
    "CerebroEnabled"                      : "True",
    "EnableESPublicNetwork"               : "True",
    "EnableESPrivateNetwork"              : "vpc-13fpvlahzboxsxxxxxxxxxx",
    "EnableKibanaPublicNetwork"           : "True",
    "EnableKibanaPrivateNetwork"          : "True",
    "EnableESPrivateDomainPublic"         : "False",
    "EnableKibanaPrivateDomainPublic"     : "False",
    },
    "fileds": {
      "TotalNodes": "4",
      "ChargeEnabled": "True",
      "DeletionProtection": "True",
      "CreateTime": "2025-05-06T09:39:50+08:00",
      "ExpireDate": "'\'",
      "KibanaConfig": "'\'",
      "ResourceTags": "[]",
      "SubInstances": "[]",
      "TransferInfo": "{}",
      "MaintenanceDay": "[\"MONDAY\", \"TUESDAY\", \"WEDNESDAY\", \"THURSDAY\", \"FRIDAY\", \"SATURDAY\", \"SUNDAY\"",
      "ESPublicEndpoint": "https://elasticsearch-o-xxxxxxapbhpvmd.escloud.volces.com:9200",
      "ESPrivateEndpoint": "https://elasticsearch-o-xxxxxapbhpvmd.escloud.ivolces.com:9200",
      "ESPublicIpWhitelist": "127.0.0.1",
      "ESPrivateIpWhitelist": "0.0.0.0/0",
      "InstanceConfiguration": "{Json data}",
      "KibanaPublicIpWhitelist": "'\'",
      "KibanaPrivateIpWhitelist": "0.0.0.0/0"
    }
  }