Introduce indices filter

This is backport of #167

Signed-off-by: nhuttran <[email protected]>

README.md

@@ -120,6 +120,40 @@ For example to get stats for all cluster nodes from any node use settings:
 prometheus.nodes.filter: "_all"
 ```
 
+#### Indices filter
+
+Prometheus exporter can be configured to filter indices statistics from selected indices.
+To target all indices, use "" or * or _all or null.
+Default value: `""`.
+
+For example to filter indices statistics:
+```
+prometheus.indices_filter.selected_indices: "log-*,*log,*log*,log*-test"
+```
+
+Users can select which option for filtering indices statistics.
+Default value: `"STRICT_EXPAND_OPEN_FORBID_CLOSED"`.
+
+For example to select an option:
+```
+prometheus.indices_filter.selected_option: "LENIENT_EXPAND_OPEN"
+```
+Here is a list of indices options available for selection
+```
+STRICT_EXPAND_OPEN: indices options that requires every specified index to exist, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).
+STRICT_EXPAND_OPEN_HIDDEN: indices options that requires every specified index to exist, expands wildcards only to open indices, includes hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).
+STRICT_EXPAND_OPEN_FORBID_CLOSED: indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error) and forbids the use of closed indices by throwing an error.
+STRICT_EXPAND_OPEN_HIDDEN_FORBID_CLOSED: indices options that requires every specified index to exist, expands wildcards only to open indices, includes hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error) and forbids the use of closed indices by throwing an error.
+STRICT_EXPAND_OPEN_FORBID_CLOSED_IGNORE_THROTTLED: indices options that requires every specified index to exist, expands wildcards only to open indices, allows that no indices are resolved from wildcard expressions (not returning an error), forbids the use of closed indices by throwing an error and ignores indices that are throttled.
+STRICT_EXPAND_OPEN_CLOSED: indices option that requires every specified index to exist, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
+STRICT_EXPAND_OPEN_CLOSED_HIDDEN: indices option that requires every specified index to exist, expands wildcards to both open and closed indices, includes hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).
+STRICT_SINGLE_INDEX_NO_EXPAND_FORBID_CLOSED: indices option that requires each specified index or alias to exist, doesn't expand wildcards and throws error if any of the aliases resolves to multiple indices.
+LENIENT_EXPAND_OPEN: indices options that ignores unavailable indices, expands wildcards only to open indices and allows that no indices are resolved from wildcard expressions (not returning an error).
+LENIENT_EXPAND_OPEN_HIDDEN: indices options that ignores unavailable indices, expands wildcards to open and hidden indices, and allows that no indices are resolved from wildcard expressions (not returning an error).
+LENIENT_EXPAND_OPEN_CLOSED: indices options that ignores unavailable indices, expands wildcards to both open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
+LENIENT_EXPAND_OPEN_CLOSED_HIDDEN: indices options that ignores unavailable indices, expands wildcards to all open and closed indices and allows that no indices are resolved from wildcard expressions (not returning an error).
+```
+
 ## Usage
 
 Metrics are directly available at:

build.gradle

@@ -3,49 +3,8 @@ import org.opensearch.gradle.test.RestIntegTestTask
 import java.util.regex.Matcher
 import java.util.regex.Pattern
 
-apply plugin: 'java'
-apply plugin: 'idea'
-apply plugin: 'opensearch.opensearchplugin'
-apply plugin: 'opensearch.yaml-rest-test'
-
-def pluginName = pluginName
-def pluginDescription = pluginDescription
-//def projectPath = 'org.opensearch'
-//def pathToPlugin = 'path.to.plugin'
-def pluginClassName = pluginClassname
-
-//tasks.register("preparePluginPathDirs") {
-//    mustRunAfter clean
-//    doLast {
-//        def newPath = pathToPlugin.replace(".", "/")
-//        mkdir "src/main/java/org/opensearch/$newPath"
-//        mkdir "src/test/java/org/opensearch/$newPath"
-//        mkdir "src/yamlRestTest/java/org/opensearch/$newPath"
-//    }
-//}
-
-opensearchplugin {
-    name pluginName
-    description pluginDescription
-//    classname "${projectPath}.${pathToPlugin}.${pluginClassName}"
-    classname pluginClassName
-    licenseFile rootProject.file('LICENSE.txt')
-    noticeFile rootProject.file('NOTICE.txt')
-}
-
-// thirdparty audit needs can be enabled
-thirdPartyAudit.enabled = false
-
-// This requires an additional Jar not published as part of build-tools
-loggerUsageCheck.enabled = false
-
-// No need to validate pom, as we do not upload to maven/sonatype
-validateNebulaPom.enabled = false
-
 buildscript {
-
     ext {
-
         // Four {digit(s)} concatenated with a "." followed by -rc{digit(s)}
         // Examples: 1.0.0.1-rc2, 2.10.4.0-rc5
         // Group (3) refers to the last .{digit{(s)} pattern (this is what we want to remove for OpS version)
@@ -81,19 +40,50 @@ buildscript {
 
     repositories {
         mavenLocal()
+        maven { url "https://aws.oss.sonatype.org/content/repositories/releases" }
         maven { url "https://aws.oss.sonatype.org/content/repositories/snapshots" }
         mavenCentral()
         maven { url "https://plugins.gradle.org/m2/" }
-        jcenter()
     }
 
     dependencies {
         classpath   "org.opensearch.gradle:build-tools:${versions.opensearch}"
     }
 }
 
+apply plugin: 'java'
+apply plugin: 'idea'
+apply plugin: 'opensearch.opensearchplugin'
+apply plugin: 'opensearch.yaml-rest-test'
+//apply plugin: 'checkstyle'
+
+def pluginName = pluginName
+def pluginDescription = pluginDescription
+//def projectPath = 'org.opensearch'
+//def pathToPlugin = 'path.to.plugin'
+def pluginClassName = pluginClassname
+
+opensearchplugin {
+    name pluginName
+    description pluginDescription
+//    classname "${projectPath}.${pathToPlugin}.${pluginClassName}"
+    classname pluginClassName
+    licenseFile rootProject.file('LICENSE.txt')
+    noticeFile rootProject.file('NOTICE.txt')
+}
+
+// thirdparty audit needs can be enabled
+thirdPartyAudit.enabled = false
+
+// This requires an additional Jar not published as part of build-tools
+loggerUsageCheck.enabled = false
+
+// No need to validate pom, as we do not upload to maven/sonatype
+validateNebulaPom.enabled = false
+
 repositories {
     mavenLocal()
+    maven { url "https://aws.oss.sonatype.org/content/repositories/releases" }
     maven { url "https://aws.oss.sonatype.org/content/repositories/snapshots" }
     mavenCentral()
     maven { url "https://plugins.gradle.org/m2/" }
@@ -109,6 +99,12 @@ dependencies {
     implementation group: 'io.prometheus', name: 'simpleclient_common', version: '0.16.0'
 }
 
+restResources {
+    restApi {
+        includeCore '_common', 'cat', 'cluster', 'nodes', 'indices', 'index'
+    }
+}
+
 test {
     include '**/*Tests.class'
 }
@@ -152,4 +148,4 @@ testClusters.integTest {
 
 run {
     useCluster testClusters.integTest
-}
+}