docs icon indicating copy to clipboard operation
docs copied to clipboard

add volcengine cloudmonitor exporter

Open Duncan-dsf opened this issue 2 years ago • 5 comments

Hello! I want to add Volcengine cloudmonitor exporter to the list of community exporters.

Volcengine is a Cloud Services platform owned by ByteDance.

The following is an sample output.

# HELP ConnUsage_engine_monitor_VCM_RDS_MySQL ConnUsage Unit:Percent
# TYPE ConnUsage_engine_monitor_VCM_RDS_MySQL gauge
ConnUsage_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 0.0185 1689154380000
# HELP CpuUtil_resource_monitor_VCM_RDS_MySQL CpuUtil Unit:Percent
# TYPE CpuUtil_resource_monitor_VCM_RDS_MySQL gauge
CpuUtil_resource_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 0.5050000000000001 1689154380000
# HELP CreatedTmpFiles_engine_monitor_VCM_RDS_MySQL CreatedTmpFiles Unit:Count/Second
# TYPE CreatedTmpFiles_engine_monitor_VCM_RDS_MySQL gauge
CreatedTmpFiles_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 0 1689154440000
# HELP CreatedTmpTables_engine_monitor_VCM_RDS_MySQL CreatedTmpTables Unit:Count/Second
# TYPE CreatedTmpTables_engine_monitor_VCM_RDS_MySQL gauge
CreatedTmpTables_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 8.833333333333334 1689154440000
# HELP DiskUsageBytes_resource_monitor_VCM_RDS_MySQL DiskUsageBytes Unit:Bytes(SI)
# TYPE DiskUsageBytes_resource_monitor_VCM_RDS_MySQL gauge
DiskUsageBytes_resource_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 1.00461282561e+11 1689154380000
# HELP DiskUtil_resource_monitor_VCM_RDS_MySQL DiskUtil Unit:Percent
# TYPE DiskUtil_resource_monitor_VCM_RDS_MySQL gauge
DiskUtil_resource_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 9.370000000000001 1689154380000
# HELP HandlerCommit_engine_monitor_VCM_RDS_MySQL HandlerCommit Unit:Count/Second
# TYPE HandlerCommit_engine_monitor_VCM_RDS_MySQL gauge
HandlerCommit_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 76.25 1689154440000
# HELP HandlerReadRndNext_engine_monitor_VCM_RDS_MySQL HandlerReadRndNext Unit:Count/Second
# TYPE HandlerReadRndNext_engine_monitor_VCM_RDS_MySQL gauge
HandlerReadRndNext_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 2666.616666666667 1689154440000
# HELP HandlerRollback_engine_monitor_VCM_RDS_MySQL HandlerRollback Unit:Count/Second
# TYPE HandlerRollback_engine_monitor_VCM_RDS_MySQL gauge
HandlerRollback_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 0 1689154440000
# HELP InnodbBufferPoolPagesFlushed_engine_monitor_VCM_RDS_MySQL InnodbBufferPoolPagesFlushed Unit:Count/Second
# TYPE InnodbBufferPoolPagesFlushed_engine_monitor_VCM_RDS_MySQL gauge
InnodbBufferPoolPagesFlushed_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 8 1689154440000
# HELP InnodbBufferPoolPagesFree_engine_monitor_VCM_RDS_MySQL InnodbBufferPoolPagesFree Unit:Count
# TYPE InnodbBufferPoolPagesFree_engine_monitor_VCM_RDS_MySQL gauge
InnodbBufferPoolPagesFree_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 8192 1689154380000
# HELP InnodbCacheHitRate_engine_monitor_VCM_RDS_MySQL InnodbCacheHitRate Unit:Percent
# TYPE InnodbCacheHitRate_engine_monitor_VCM_RDS_MySQL gauge
InnodbCacheHitRate_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 99.39011 1689154380000
# HELP InnodbCacheUtil_engine_monitor_VCM_RDS_MySQL InnodbCacheUtil Unit:Percent
# TYPE InnodbCacheUtil_engine_monitor_VCM_RDS_MySQL gauge
InnodbCacheUtil_engine_monitor_VCM_RDS_MySQL{ResourceID="mysql-xxxxxx"} 99.21875 1689154380000

Duncan-dsf avatar Jul 12 '23 09:07 Duncan-dsf

Can anyone help review it?

Duncan-dsf avatar Jul 13 '23 05:07 Duncan-dsf

@roidelapluie @juliusv @RichiH Can anyone help review it? pls.

Duncan-dsf avatar Aug 01 '23 10:08 Duncan-dsf

Hi @Duncan-dsf, thanks! Comparing the metric names to the best practices / conventions at https://prometheus.io/docs/practices/naming/ and https://prometheus.io/docs/instrumenting/writing_exporters/#naming (specifically for exporters), they look a bit unusual, for example lacking an application prefix, a unit in the metric name itself, or using CamelCase (although the second doc I link to gives a possible exemption for that rule). Is this an exporter that you control and could improve the metrics of, or are you not involved?

juliusv avatar Aug 01 '23 15:08 juliusv

@juliusv I understand what you mean, the exposed measurement names do not comply with best practices. But these measurement names are followed by the measurement names in the official doc of volcengine.

If we need to modify the measurement name, we need volcengine to modify it, but this is a complicated thing. Based on the current measurement name, users are already using it. Can I apply for an exemption from this problem?

Duncan-dsf avatar Aug 02 '23 01:08 Duncan-dsf

@Duncan-dsf I see, yeah. For my understanding, are you part of the Volcengine team, or an external user? I'm trying to understand more about this exporter in general. When I translate the Chinese documentation about it, I don't see any source code links, just a way to deploy it as a binary image into a cluster. If I'm not mistaken, this would be the first time that we'd include a closed-source exporter in this list that we don't have any visibility into. @roidelapluie any opinions on this?

juliusv avatar Aug 02 '23 09:08 juliusv