Added ability to disable indices metrics in configuration

Author: vvanholl

README.md

@@ -3,10 +3,10 @@
 This is a builtin exporter from ElasticSearch to Prometheus.
 It collects all relevant metrics and make them available to Prometheus via ElasticSearch REST API.
 
-Current available metrics are :
+**Current available metrics are :**
 
 - Cluster status
-- Node status :
+- Nodes status :
     - JVM
     - Indices (global)
     - Transport
@@ -16,6 +16,7 @@ Current available metrics are :
     - Operating System
     - File System
     - Circuit Breaker
+- Indices status
 
 ## Compatibility matrix
 
@@ -49,14 +50,20 @@ Current available metrics are :
 - On old 2.x.x versions :
     ./bin/plugin install https://github.com/vvanholl/elasticsearch-prometheus-exporter/releases/download/2.4.1.0/elasticsearch-prometheus-exporter-2.4.1.0.zip
 
-Do not forget to restart the node after installation !
+**Do not forget to restart the node after installation !**
 
 Note that the plugin needs special permissions :
 
 - java.lang.RuntimePermission accessClassInPackage.sun.misc
 - java.lang.RuntimePermission accessDeclaredMembers
 - java.lang.reflect.ReflectPermission suppressAccessChecks
 
+If you have a lot of indices and think this data is irelevant, you can disable in the main configuration file:
+
+```
+prometheus.indices: false
+```
+
 ## Uninstall
 
 - Since ElasticSearch 5.0.0 :

src/main/java/org/compuscene/metrics/prometheus/PrometheusMetricsCollector.java

@@ -15,6 +15,9 @@
 import org.elasticsearch.client.Client;
 import org.elasticsearch.cluster.health.ClusterIndexHealth;
 import org.elasticsearch.common.logging.ESLoggerFactory;
+import org.elasticsearch.common.settings.Setting;
+import org.elasticsearch.common.settings.Setting.Property;
+import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.http.HttpStats;
 import org.elasticsearch.indices.NodeIndicesStats;
 import org.elasticsearch.indices.breaker.AllCircuitBreakerStats;
@@ -31,16 +34,20 @@
 import java.util.Map;
 
 public class PrometheusMetricsCollector {
+    public static final Setting<Boolean> PROMETHEUS_INDICES = Setting.boolSetting("prometheus.indices", true, Property.NodeScope);
+
     private final static Logger logger = ESLoggerFactory.getLogger(RestPrometheusMetricsAction.class.getSimpleName());
 
+    private final Settings settings;
     private final Client client;
 
     private String cluster;
     private String node;
 
     private PrometheusMetricsCatalog catalog;
 
-    public PrometheusMetricsCollector(final Client client) {
+    public PrometheusMetricsCollector(Settings settings, final Client client) {
+        this.settings = settings;
         this.client = client;
 
         NodesStatsRequest nodesStatsRequest = new NodesStatsRequest("_local").all();
@@ -67,7 +74,7 @@ private void registerMetrics() {
         registerCircuitBreakerMetrics();
         registerThreadPoolMetrics();
         registerFsMetrics();
-        registerPerIndexMetrics();
+        if (PROMETHEUS_INDICES.get(settings)) registerPerIndexMetrics();
     }
 
     private void registerClusterMetrics() {
@@ -768,14 +775,15 @@ public void updateMetrics() {
         updateThreadPoolMetrics(nodeStats.getThreadPool());
         updateFsMetrics(nodeStats.getFs());
 
-        IndicesStatsRequest indicesStatsRequest = new IndicesStatsRequest();
-        ActionFuture<IndicesStatsResponse> f = client.admin().indices().stats(indicesStatsRequest);
-        try {
-            updatePerIndexMetrics(clusterHealthResponse, f.get());
-        } catch (Exception e) {
-            logger.warn("Could not get indices statistics");
+        if (PROMETHEUS_INDICES.get(settings)) {
+            IndicesStatsRequest indicesStatsRequest = new IndicesStatsRequest();
+            ActionFuture<IndicesStatsResponse> f = client.admin().indices().stats(indicesStatsRequest);
+            try {
+                updatePerIndexMetrics(clusterHealthResponse, f.get());
+            } catch (Exception e) {
+                logger.warn("Could not get indices statistics");
+            }
         }
-
         timer.observeDuration();
     }
 

src/main/java/org/elasticsearch/plugin/prometheus/PrometheusExporterPlugin.java

@@ -1,14 +1,12 @@
 package org.elasticsearch.plugin.prometheus;
 
 import org.apache.logging.log4j.Logger;
+import org.compuscene.metrics.prometheus.PrometheusMetricsCollector;
 import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
 import org.elasticsearch.cluster.node.DiscoveryNodes;
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.logging.Loggers;
-import org.elasticsearch.common.settings.ClusterSettings;
-import org.elasticsearch.common.settings.IndexScopedSettings;
-import org.elasticsearch.common.settings.Settings;
-import org.elasticsearch.common.settings.SettingsFilter;
+import org.elasticsearch.common.settings.*;
 import org.elasticsearch.index.IndexModule;
 import org.elasticsearch.plugins.ActionPlugin;
 import org.elasticsearch.plugins.Plugin;
@@ -24,9 +22,12 @@ public class PrometheusExporterPlugin extends Plugin implements ActionPlugin {
 
     private final Logger logger = Loggers.getLogger(PrometheusExporterPlugin.class);
 
+    private final Settings settings;
+
     @Inject
     public PrometheusExporterPlugin(Settings settings) {
-        logger.info("starting Prometheus exporter plugin...");
+        logger.info("starting Prometheus exporter plugin");
+        this.settings = settings;
     }
 
     @Override
@@ -41,4 +42,10 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
         );
     }
 
+    @Override
+    public List<Setting<?>> getSettings() {
+        return Arrays.asList(
+                PrometheusMetricsCollector.PROMETHEUS_INDICES
+        );
+    }
 }

src/main/java/org/elasticsearch/rest/prometheus/RestPrometheusMetricsAction.java

@@ -35,7 +35,7 @@ public RestPrometheusMetricsAction(Settings settings, RestController controller)
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
         logger.trace(String.format("Received request for Prometheus metrics from %s", request.getRemoteAddress().toString()));
 
-        collector.compareAndSet(null, new PrometheusMetricsCollector(client));
+        collector.compareAndSet(null, new PrometheusMetricsCollector(settings, client));
 
         collector.get().updateMetrics();