/* * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one * or more contributor license agreements. Licensed under the "Elastic License * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side * Public License v 1"; you may not use this file except in compliance with, at * your election, the "Elastic License 2.0", the "GNU Affero General Public * License v3.0 only", or the "Server Side Public License, v 1". */ package org.elasticsearch.action.admin.cluster.stats; import org.elasticsearch.Version; import org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest; import org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse; import org.elasticsearch.action.admin.cluster.node.stats.NodeStats; import org.elasticsearch.action.admin.cluster.node.stats.NodesStatsResponse; import org.elasticsearch.client.Request; import org.elasticsearch.client.ResponseException; import org.elasticsearch.cluster.health.ClusterHealthStatus; import org.elasticsearch.cluster.node.DiscoveryNodeRole; import org.elasticsearch.common.Priority; import org.elasticsearch.common.Strings; import org.elasticsearch.common.settings.Settings; import org.elasticsearch.common.util.concurrent.EsExecutors; import org.elasticsearch.gateway.GatewayService; import org.elasticsearch.index.query.MatchAllQueryBuilder; import org.elasticsearch.index.query.QueryBuilders; import org.elasticsearch.monitor.os.OsStats; import org.elasticsearch.node.NodeRoleSettings; import org.elasticsearch.search.aggregations.bucket.terms.TermsAggregationBuilder; import org.elasticsearch.search.builder.SearchSourceBuilder; import org.elasticsearch.search.rescore.QueryRescorerBuilder; import org.elasticsearch.test.ESIntegTestCase; import org.elasticsearch.test.ESIntegTestCase.ClusterScope; import org.elasticsearch.test.ESIntegTestCase.Scope; import org.hamcrest.Matchers; import java.io.IOException; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.ExecutionException; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.greaterThan; import static org.hamcrest.Matchers.greaterThanOrEqualTo; import static org.hamcrest.Matchers.hasItem; import static org.hamcrest.Matchers.hasSize; import static org.hamcrest.Matchers.is; @ClusterScope(scope = Scope.TEST, numDataNodes = 0) public class ClusterStatsIT extends ESIntegTestCase { @Override protected boolean addMockHttpTransport() { return false; // enable http } private void assertCounts(ClusterStatsNodes.Counts counts, int total, Map roles) { assertThat(counts.getTotal(), equalTo(total)); assertThat(counts.getRoles(), equalTo(roles)); } private void waitForNodes(int numNodes) { ClusterHealthResponse actionGet = clusterAdmin().health( new ClusterHealthRequest(TEST_REQUEST_TIMEOUT, new String[] {}).waitForEvents(Priority.LANGUID) .waitForNodes(Integer.toString(numNodes)) ).actionGet(); assertThat(actionGet.isTimedOut(), is(false)); } public void testNodeCounts() { int total = 1; internalCluster().startNode(); Map expectedCounts = new HashMap<>(); expectedCounts.put(DiscoveryNodeRole.DATA_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.DATA_CONTENT_NODE_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.DATA_COLD_NODE_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.DATA_FROZEN_NODE_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.DATA_HOT_NODE_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.DATA_WARM_NODE_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.INGEST_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.INDEX_ROLE.roleName(), 0); expectedCounts.put(DiscoveryNodeRole.MASTER_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.ML_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.REMOTE_CLUSTER_CLIENT_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.SEARCH_ROLE.roleName(), 0); expectedCounts.put(DiscoveryNodeRole.TRANSFORM_ROLE.roleName(), 1); expectedCounts.put(DiscoveryNodeRole.VOTING_ONLY_NODE_ROLE.roleName(), 0); expectedCounts.put(ClusterStatsNodes.Counts.COORDINATING_ONLY, 0); int numNodes = randomIntBetween(1, 5); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); assertCounts(response.getNodesStats().getCounts(), total, expectedCounts); for (int i = 0; i < numNodes; i++) { boolean isDataNode = randomBoolean(); boolean isIngestNode = randomBoolean(); boolean isMasterNode = randomBoolean(); boolean isRemoteClusterClientNode = false; final Set roles = new HashSet<>(); if (isDataNode) { roles.add(DiscoveryNodeRole.DATA_ROLE); } if (isIngestNode) { roles.add(DiscoveryNodeRole.INGEST_ROLE); } if (isMasterNode) { roles.add(DiscoveryNodeRole.MASTER_ROLE); } if (isRemoteClusterClientNode) { roles.add(DiscoveryNodeRole.REMOTE_CLUSTER_CLIENT_ROLE); } Settings settings = Settings.builder() .putList(NodeRoleSettings.NODE_ROLES_SETTING.getKey(), roles.stream().map(DiscoveryNodeRole::roleName).toList()) .build(); internalCluster().startNode(settings); total++; waitForNodes(total); if (isDataNode) { incrementCountForRole(DiscoveryNodeRole.DATA_ROLE.roleName(), expectedCounts); } if (isIngestNode) { incrementCountForRole(DiscoveryNodeRole.INGEST_ROLE.roleName(), expectedCounts); } if (isMasterNode) { incrementCountForRole(DiscoveryNodeRole.MASTER_ROLE.roleName(), expectedCounts); } if (isRemoteClusterClientNode) { incrementCountForRole(DiscoveryNodeRole.REMOTE_CLUSTER_CLIENT_ROLE.roleName(), expectedCounts); } if (isDataNode == false && isMasterNode == false && isIngestNode == false && isRemoteClusterClientNode == false) { incrementCountForRole(ClusterStatsNodes.Counts.COORDINATING_ONLY, expectedCounts); } response = clusterAdmin().prepareClusterStats().get(); assertCounts(response.getNodesStats().getCounts(), total, expectedCounts); } } private static void incrementCountForRole(String role, Map counts) { Integer count = counts.get(role); if (count == null) { counts.put(role, 1); } else { counts.put(role, ++count); } } private void assertShardStats(ClusterStatsIndices.ShardStats stats, int indices, int total, int primaries, double replicationFactor) { assertThat(stats.getIndices(), Matchers.equalTo(indices)); assertThat(stats.getTotal(), Matchers.equalTo(total)); assertThat(stats.getPrimaries(), Matchers.equalTo(primaries)); assertThat(stats.getReplication(), Matchers.equalTo(replicationFactor)); } public void testIndicesShardStats() throws ExecutionException, InterruptedException { internalCluster().startNode(); ensureGreen(); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), Matchers.equalTo(ClusterHealthStatus.GREEN)); prepareCreate("test1").setSettings(indexSettings(2, 1)).get(); response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), Matchers.equalTo(ClusterHealthStatus.YELLOW)); assertThat(response.indicesStats.getDocs().getCount(), Matchers.equalTo(0L)); assertThat(response.indicesStats.getIndexCount(), Matchers.equalTo(1)); assertShardStats(response.getIndicesStats().getShards(), 1, 2, 2, 0.0); // add another node, replicas should get assigned internalCluster().startNode(); ensureGreen(); indexDoc("test1", "1", "f", "f"); refresh(); // make the doc visible response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), Matchers.equalTo(ClusterHealthStatus.GREEN)); assertThat(response.indicesStats.getDocs().getCount(), Matchers.equalTo(1L)); assertShardStats(response.getIndicesStats().getShards(), 1, 4, 2, 1.0); prepareCreate("test2").setSettings(indexSettings(3, 0)).get(); ensureGreen(); response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), Matchers.equalTo(ClusterHealthStatus.GREEN)); assertThat(response.indicesStats.getIndexCount(), Matchers.equalTo(2)); assertShardStats(response.getIndicesStats().getShards(), 2, 7, 5, 2.0 / 5); assertThat(response.getIndicesStats().getShards().getAvgIndexPrimaryShards(), Matchers.equalTo(2.5)); assertThat(response.getIndicesStats().getShards().getMinIndexPrimaryShards(), Matchers.equalTo(2)); assertThat(response.getIndicesStats().getShards().getMaxIndexPrimaryShards(), Matchers.equalTo(3)); assertThat(response.getIndicesStats().getShards().getAvgIndexShards(), Matchers.equalTo(3.5)); assertThat(response.getIndicesStats().getShards().getMinIndexShards(), Matchers.equalTo(3)); assertThat(response.getIndicesStats().getShards().getMaxIndexShards(), Matchers.equalTo(4)); assertThat(response.getIndicesStats().getShards().getAvgIndexReplication(), Matchers.equalTo(0.5)); assertThat(response.getIndicesStats().getShards().getMinIndexReplication(), Matchers.equalTo(0.0)); assertThat(response.getIndicesStats().getShards().getMaxIndexReplication(), Matchers.equalTo(1.0)); } public void testValuesSmokeScreen() throws IOException, ExecutionException, InterruptedException { internalCluster().startNodes(randomIntBetween(1, 3)); indexDoc("test1", "1", "f", "f"); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); String msg = response.toString(); assertThat(msg, response.getTimestamp(), greaterThan(946681200000L)); // 1 Jan 2000 assertThat(msg, response.indicesStats.getStore().sizeInBytes(), greaterThan(0L)); assertThat(msg, response.nodesStats.getFs().getTotal().getBytes(), greaterThan(0L)); assertThat(msg, response.nodesStats.getJvm().getVersions().size(), greaterThan(0)); assertThat(msg, response.nodesStats.getVersions(), hasSize(greaterThan(0))); // TODO: Build.current().unqualifiedVersion() -- or Build.current().version() if/when we move NodeInfo to Build version(s) assertThat(msg, response.nodesStats.getVersions(), hasItem(Version.CURRENT.toString())); assertThat(msg, response.nodesStats.getPlugins(), hasSize(greaterThanOrEqualTo(0))); assertThat(msg, response.nodesStats.getProcess().count, greaterThan(0)); // 0 happens when not supported on platform assertThat(msg, response.nodesStats.getProcess().getAvgOpenFileDescriptors(), greaterThanOrEqualTo(0L)); // these can be -1 if not supported on platform assertThat(msg, response.nodesStats.getProcess().getMinOpenFileDescriptors(), greaterThanOrEqualTo(-1L)); assertThat(msg, response.nodesStats.getProcess().getMaxOpenFileDescriptors(), greaterThanOrEqualTo(-1L)); NodesStatsResponse nodesStatsResponse = clusterAdmin().prepareNodesStats().setOs(true).get(); long total = 0; long free = 0; long used = 0; for (NodeStats nodeStats : nodesStatsResponse.getNodes()) { total += nodeStats.getOs().getMem().getTotal().getBytes(); free += nodeStats.getOs().getMem().getFree().getBytes(); used += nodeStats.getOs().getMem().getUsed().getBytes(); } assertEquals(msg, free, response.nodesStats.getOs().getMem().getFree().getBytes()); assertEquals(msg, total, response.nodesStats.getOs().getMem().getTotal().getBytes()); assertEquals(msg, used, response.nodesStats.getOs().getMem().getUsed().getBytes()); assertEquals(msg, OsStats.calculatePercentage(used, total), response.nodesStats.getOs().getMem().getUsedPercent()); assertEquals(msg, OsStats.calculatePercentage(free, total), response.nodesStats.getOs().getMem().getFreePercent()); } public void testAllocatedProcessors() throws Exception { // the node.processors setting is bounded above by Runtime#availableProcessors final int nodeProcessors = randomIntBetween(1, Runtime.getRuntime().availableProcessors()); internalCluster().startNode(Settings.builder().put(EsExecutors.NODE_PROCESSORS_SETTING.getKey(), nodeProcessors).build()); waitForNodes(1); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getNodesStats().getOs().getAllocatedProcessors(), equalTo(nodeProcessors)); } public void testClusterStatusWhenStateNotRecovered() { internalCluster().startMasterOnlyNode(Settings.builder().put(GatewayService.RECOVER_AFTER_DATA_NODES_SETTING.getKey(), 1).build()); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), equalTo(ClusterHealthStatus.RED)); internalCluster().startDataOnlyNode(); // wait for the cluster status to settle ensureGreen(); response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), equalTo(ClusterHealthStatus.GREEN)); } public void testFieldTypes() { internalCluster().startNode(); ensureGreen(); ClusterStatsResponse response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getStatus(), Matchers.equalTo(ClusterHealthStatus.GREEN)); assertTrue(response.getIndicesStats().getMappings().getFieldTypeStats().isEmpty()); indicesAdmin().prepareCreate("test1").setMapping(""" {"properties":{"foo":{"type": "keyword"}}}""").get(); indicesAdmin().prepareCreate("test2").setMapping(""" { "properties": { "foo": { "type": "keyword" }, "bar": { "properties": { "baz": { "type": "keyword" }, "eggplant": { "type": "integer" } } } } }""").get(); response = clusterAdmin().prepareClusterStats().get(); assertThat(response.getIndicesStats().getMappings().getFieldTypeStats().size(), equalTo(3)); List stats = response.getIndicesStats().getMappings().getFieldTypeStats(); for (FieldStats stat : stats) { if (stat.getName().equals("integer")) { assertThat(stat.getCount(), greaterThanOrEqualTo(1)); } else if (stat.getName().equals("keyword")) { assertThat(stat.getCount(), greaterThanOrEqualTo(3)); } else if (stat.getName().equals("object")) { assertThat(stat.getCount(), greaterThanOrEqualTo(1)); } } } public void testSearchUsageStats() throws IOException { internalCluster().startNode(); ensureStableCluster(1); { SearchUsageStats stats = clusterAdmin().prepareClusterStats().get().getIndicesStats().getSearchUsageStats(); assertEquals(0, stats.getTotalSearchCount()); assertEquals(0, stats.getQueryUsage().size()); assertEquals(0, stats.getSectionsUsage().size()); } // doesn't get counted because it doesn't specify a request body getRestClient().performRequest(new Request("GET", "/_search")); { Request request = new Request("GET", "/_search"); SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(QueryBuilders.matchQuery("field", "value")); request.setJsonEntity(Strings.toString(searchSourceBuilder)); getRestClient().performRequest(request); } { Request request = new Request("GET", "/_search"); // error at parsing: request not counted request.setJsonEntity("{\"unknown]\":10}"); expectThrows(ResponseException.class, () -> getRestClient().performRequest(request)); } { // non existent index: request counted Request request = new Request("GET", "/unknown/_search"); SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(QueryBuilders.termQuery("field", "value")); request.setJsonEntity(Strings.toString(searchSourceBuilder)); ResponseException responseException = expectThrows(ResponseException.class, () -> getRestClient().performRequest(request)); assertEquals(404, responseException.getResponse().getStatusLine().getStatusCode()); } { Request request = new Request("GET", "/_search"); SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query( QueryBuilders.boolQuery().must(QueryBuilders.rangeQuery("field").from(10)) ); request.setJsonEntity(Strings.toString(searchSourceBuilder)); getRestClient().performRequest(request); } { Request request = new Request("POST", "/_msearch"); SearchSourceBuilder searchSourceBuilder1 = new SearchSourceBuilder().aggregation( new TermsAggregationBuilder("name").field("field") ); SearchSourceBuilder searchSourceBuilder2 = new SearchSourceBuilder().query(QueryBuilders.termQuery("field", "value")); request.setJsonEntity( "{}\n" + Strings.toString(searchSourceBuilder1) + "\n" + "{}\n" + Strings.toString(searchSourceBuilder2) + "\n" ); getRestClient().performRequest(request); } { Request request = new Request("GET", "/_search"); SearchSourceBuilder searchSourceBuilder = new SearchSourceBuilder().query(QueryBuilders.termQuery("field", "value")) .addRescorer(new QueryRescorerBuilder(new MatchAllQueryBuilder().boost(3.0f))); request.setJsonEntity(Strings.toString(searchSourceBuilder)); getRestClient().performRequest(request); } SearchUsageStats stats = clusterAdmin().prepareClusterStats().get().getIndicesStats().getSearchUsageStats(); assertEquals(6, stats.getTotalSearchCount()); assertEquals(4, stats.getQueryUsage().size()); assertEquals(1, stats.getQueryUsage().get("match").longValue()); assertEquals(3, stats.getQueryUsage().get("term").longValue()); assertEquals(1, stats.getQueryUsage().get("range").longValue()); assertEquals(1, stats.getQueryUsage().get("bool").longValue()); assertEquals(3, stats.getSectionsUsage().size()); assertEquals(5, stats.getSectionsUsage().get("query").longValue()); assertEquals(1, stats.getSectionsUsage().get("aggs").longValue()); assertEquals(1, stats.getSectionsUsage().get("rescore").longValue()); assertEquals(1, stats.getRescorerUsage().size()); assertEquals(1, stats.getRescorerUsage().get("query").longValue()); } }