Feat/config option os metrics enabled

iotdb-core/confignode/src/main/java/org/apache/iotdb/confignode/service/ConfigNode.java

@@ -26,6 +26,8 @@
 import org.apache.iotdb.commons.concurrent.ThreadModule;
 import org.apache.iotdb.commons.concurrent.ThreadName;
 import org.apache.iotdb.commons.concurrent.ThreadPoolMetrics;
+import org.apache.iotdb.commons.conf.CommonConfig;
+import org.apache.iotdb.commons.conf.CommonDescriptor;
 import org.apache.iotdb.commons.conf.IoTDBConstant;
 import org.apache.iotdb.commons.exception.StartupException;
 import org.apache.iotdb.commons.service.JMXService;
@@ -260,8 +262,12 @@ private void setUpMetricService() throws StartupException {
     MetricService.getInstance().addMetricSet(new JvmMetrics());
     MetricService.getInstance().addMetricSet(new LogbackMetrics());
     MetricService.getInstance().addMetricSet(new ProcessMetrics());
-    MetricService.getInstance().addMetricSet(new DiskMetrics(IoTDBConstant.CN_ROLE));
-    MetricService.getInstance().addMetricSet(new NetMetrics(IoTDBConstant.CN_ROLE));
+    // Only enable OS-level metrics, if this is wanted.
+    CommonConfig commonConfig = CommonDescriptor.getInstance().getConfig();
+    if (commonConfig.isOsMetricsEnabled()) {
+      MetricService.getInstance().addMetricSet(new DiskMetrics(IoTDBConstant.CN_ROLE));
+      MetricService.getInstance().addMetricSet(new NetMetrics(IoTDBConstant.CN_ROLE));
+    }
     MetricService.getInstance().addMetricSet(JvmGcMonitorMetrics.getInstance());
     MetricService.getInstance().addMetricSet(ClientManagerMetrics.getInstance());
     MetricService.getInstance().addMetricSet(ThreadPoolMetrics.getInstance());
@@ -270,11 +276,16 @@ private void setUpMetricService() throws StartupException {
   }
 
   private void initSystemMetrics() {
-    ArrayList<String> diskDirs = new ArrayList<>();
-    diskDirs.add(CONF.getSystemDir());
-    diskDirs.add(CONF.getConsensusDir());
-    SystemMetrics.getInstance().setDiskDirs(diskDirs);
-    MetricService.getInstance().addMetricSet(SystemMetrics.getInstance());
+    // Only enable OS-level metrics, if this is wanted.
+    CommonConfig commonConfig = CommonDescriptor.getInstance().getConfig();
+    if (commonConfig.isOsMetricsEnabled()) {
+      ArrayList<String> diskDirs = new ArrayList<>();
+      diskDirs.add(CONF.getSystemDir());
+      diskDirs.add(CONF.getConsensusDir());
+      SystemMetrics systemMetrics = SystemMetrics.getInstance();
+      systemMetrics.setDiskDirs(diskDirs);
+      MetricService.getInstance().addMetricSet(systemMetrics);
+    }
   }
 
   private void initCpuMetrics() {

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/conf/IoTDBConfig.java

@@ -20,6 +20,7 @@
 
 import org.apache.iotdb.common.rpc.thrift.TEndPoint;
 import org.apache.iotdb.commons.client.property.ClientPoolProperty.DefaultProperty;
+import org.apache.iotdb.commons.conf.CommonConfig;
 import org.apache.iotdb.commons.conf.CommonDescriptor;
 import org.apache.iotdb.commons.conf.IoTDBConstant;
 import org.apache.iotdb.commons.utils.FileUtils;
@@ -1287,14 +1288,18 @@ void reloadDataDirs(String[][] tierDataDirs) throws LoadConfigurationException {
   }
 
   void reloadSystemMetrics() {
-    ArrayList<String> diskDirs = new ArrayList<>();
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSystemDir());
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getConsensusDir());
-    diskDirs.addAll(Arrays.asList(IoTDBDescriptor.getInstance().getConfig().getDataDirs()));
-    diskDirs.addAll(Arrays.asList(CommonDescriptor.getInstance().getConfig().getWalDirs()));
-    diskDirs.add(CommonDescriptor.getInstance().getConfig().getSyncDir());
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSortTmpDir());
-    SystemMetrics.getInstance().setDiskDirs(diskDirs);
+    // Only enable OS-level metrics, if this is wanted.
+    CommonConfig commonConfig = CommonDescriptor.getInstance().getConfig();
+    if (commonConfig.isOsMetricsEnabled()) {
+      ArrayList<String> diskDirs = new ArrayList<>();
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSystemDir());
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getConsensusDir());
+      diskDirs.addAll(Arrays.asList(IoTDBDescriptor.getInstance().getConfig().getDataDirs()));
+      diskDirs.addAll(Arrays.asList(CommonDescriptor.getInstance().getConfig().getWalDirs()));
+      diskDirs.add(CommonDescriptor.getInstance().getConfig().getSyncDir());
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSortTmpDir());
+      SystemMetrics.getInstance().setDiskDirs(diskDirs);
+    }
   }
 
   // if IOTDB_DATA_HOME is not set, then we keep dataHomeDir prefix being the same with IOTDB_HOME

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/service/DataNode.java

@@ -27,6 +27,7 @@
 import org.apache.iotdb.common.rpc.thrift.TNodeResource;
 import org.apache.iotdb.commons.client.exception.ClientManagerException;
 import org.apache.iotdb.commons.concurrent.IoTDBDefaultThreadExceptionHandler;
+import org.apache.iotdb.commons.conf.CommonConfig;
 import org.apache.iotdb.commons.conf.CommonDescriptor;
 import org.apache.iotdb.commons.conf.IoTDBConstant;
 import org.apache.iotdb.commons.exception.StartupException;
@@ -618,7 +619,8 @@ private void setUpMetricService() throws StartupException {
     }
     MetricService.getInstance().startInternalReporter();
     // bind predefined metrics
-    DataNodeMetricsHelper.bind();
+    CommonConfig commonConfig = CommonDescriptor.getInstance().getConfig();
+    DataNodeMetricsHelper.bind(commonConfig.isOsMetricsEnabled());
   }
 
   public static TDataNodeLocation generateDataNodeLocation() {

iotdb-core/datanode/src/main/java/org/apache/iotdb/db/service/metrics/DataNodeMetricsHelper.java

@@ -52,19 +52,22 @@
 
 public class DataNodeMetricsHelper {
   /** Bind predefined metric sets into DataNode. */
-  public static void bind() {
+  public static void bind(boolean enableOsMetrics) {
     MetricService.getInstance().addMetricSet(new UpTimeMetrics());
     MetricService.getInstance().addMetricSet(new JvmMetrics());
     MetricService.getInstance().addMetricSet(ThreadPoolMetrics.getInstance());
     MetricService.getInstance().addMetricSet(new LogbackMetrics());
     MetricService.getInstance().addMetricSet(FileMetrics.getInstance());
     MetricService.getInstance().addMetricSet(CompactionMetrics.getInstance());
     MetricService.getInstance().addMetricSet(new ProcessMetrics());
-    MetricService.getInstance().addMetricSet(new DiskMetrics(IoTDBConstant.DN_ROLE));
-    MetricService.getInstance().addMetricSet(new NetMetrics(IoTDBConstant.DN_ROLE));
+    // Only enable OS-level metrics, if this is wanted.
+    if (enableOsMetrics) {
+      MetricService.getInstance().addMetricSet(new DiskMetrics(IoTDBConstant.DN_ROLE));
+      MetricService.getInstance().addMetricSet(new NetMetrics(IoTDBConstant.DN_ROLE));
+    }
     MetricService.getInstance().addMetricSet(ClientManagerMetrics.getInstance());
     initCpuMetrics();
-    initSystemMetrics();
+    initSystemMetrics(enableOsMetrics);
     MetricService.getInstance().addMetricSet(WritingMetrics.getInstance());
 
     // bind query related metrics
@@ -87,16 +90,20 @@ public static void bind() {
     MetricService.getInstance().addMetricSet(PipeMetrics.getInstance());
   }
 
-  private static void initSystemMetrics() {
-    ArrayList<String> diskDirs = new ArrayList<>();
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSystemDir());
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getConsensusDir());
-    diskDirs.addAll(Arrays.asList(IoTDBDescriptor.getInstance().getConfig().getDataDirs()));
-    diskDirs.addAll(Arrays.asList(CommonDescriptor.getInstance().getConfig().getWalDirs()));
-    diskDirs.add(CommonDescriptor.getInstance().getConfig().getSyncDir());
-    diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSortTmpDir());
-    SystemMetrics.getInstance().setDiskDirs(diskDirs);
-    MetricService.getInstance().addMetricSet(SystemMetrics.getInstance());
+  private static void initSystemMetrics(boolean enableOsMetrics) {
+    // Only enable OS-level metrics, if this is wanted.
+    if (enableOsMetrics) {
+      ArrayList<String> diskDirs = new ArrayList<>();
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSystemDir());
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getConsensusDir());
+      diskDirs.addAll(Arrays.asList(IoTDBDescriptor.getInstance().getConfig().getDataDirs()));
+      diskDirs.addAll(Arrays.asList(CommonDescriptor.getInstance().getConfig().getWalDirs()));
+      diskDirs.add(CommonDescriptor.getInstance().getConfig().getSyncDir());
+      diskDirs.add(IoTDBDescriptor.getInstance().getConfig().getSortTmpDir());
+      SystemMetrics systemMetrics = SystemMetrics.getInstance();
+      systemMetrics.setDiskDirs(diskDirs);
+      MetricService.getInstance().addMetricSet(systemMetrics);
+    }
   }
 
   private static void initCpuMetrics() {

iotdb-core/node-commons/src/main/java/org/apache/iotdb/commons/conf/CommonConfig.java

@@ -214,6 +214,12 @@ public class CommonConfig {
   // time in nanosecond precision when starting up
   private final long startUpNanosecond = System.nanoTime();
 
+  /**
+   * Configures, if OS-level metrics should be enabled. OS-level metrics can cause problems in some
+   * environments
+   */
+  private boolean osMetricsEnabled = true;
+
   CommonConfig() {
     // Empty constructor
   }
@@ -862,4 +868,12 @@ public void setDeviceLimitThreshold(long deviceLimitThreshold) {
   public long getStartUpNanosecond() {
     return startUpNanosecond;
   }
+
+  public boolean isOsMetricsEnabled() {
+    return osMetricsEnabled;
+  }
+
+  public void setOsMetricsEnabled(boolean osMetricsEnabled) {
+    this.osMetricsEnabled = osMetricsEnabled;
+  }
 }