Volcengine ESCloud Cloud Search Service

Collect metrics data from the Volcengine ESCloud cloud search service

Configuration¶

Install Func¶

It is recommended to enable Guance Integration - Extension - Managed Func: all prerequisites will be automatically installed, please continue with script installation.

If you deploy Func yourself, refer to Self-deployed Func

Install Script¶

Note: Please prepare a qualified Volcengine AK in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess).

To synchronize monitoring data of ESCloud cloud resources, we install the corresponding collection script: 「Guance Integration (Volcengine - Cloud Search Service Collection)」(ID: guance_volcengine_es_cloud)

After clicking 【Install】, enter the corresponding parameters: Volcengine AK, Volcengine account name, regions.

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

After enabling, you can see the corresponding automatic trigger configuration in "Manage / Automatic Trigger Configuration". Click 【Execute】 to run immediately without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification¶

1. In "Manage / Automatic Trigger Configuration", confirm whether the corresponding task has an automatic trigger configuration, and check the corresponding task records and logs for any anomalies.
2. In Guance, under "Infrastructure - Resource Catalog", check if there are asset information entries.
3. In Guance, under "Metrics", check if there are corresponding monitoring data.

Metrics¶

Configure Volcengine ESCloud monitoring metrics, more metrics can be collected via 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 set. Here is an introduction to related metric descriptions.

Objects¶

Collected Volcengine ESCloud object data structure, which 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"
    }
  }