From 6ad26f124838932e34a93b974906776d2a9f93bc Mon Sep 17 00:00:00 2001 From: uboness Date: Sun, 27 Sep 2015 14:43:29 +0200 Subject: [PATCH] fixed ClusterStatsIT test - `ClusterStatsIT` is now `ClusterStatsTests` (moving it to maven `test` phase) - Simplified and restructured the test - changed the `LocalExporter` to handle the case where the marvel template was deleted. Now every time the cluster state is updated, it'll make sure the template still exists and if not put it back. - moved all the marvel template logic to a centrailzed place (`MarvelTemplateUtils`) - moved all es/marvel version logic to a cernralized place (`VersionUtils`) - now the `MarvelIntegTestCase` doesn't allow the marvel template to be deleted by the test infra - improved logging output Original commit: elastic/x-pack-elasticsearch@502532ddad12e7e9e5b8fa57d10ea608793c010e --- .../marvel/agent/AgentService.java | 9 +- .../agent/collector/AbstractCollector.java | 16 ++- .../cluster/ClusterInfoCollector.java | 2 +- .../cluster/ClusterStateCollector.java | 4 +- .../cluster/ClusterStatsCollector.java | 4 +- .../indices/IndexRecoveryCollector.java | 4 +- .../indices/IndexStatsCollector.java | 4 +- .../indices/IndicesStatsCollector.java | 4 +- .../collector/node/NodeStatsCollector.java | 4 +- .../collector/shards/ShardsCollector.java | 4 +- .../marvel/agent/exporter/Exporter.java | 3 +- .../agent/exporter/MarvelTemplateUtils.java | 66 +++++++++++ .../agent/exporter/http/HttpExporter.java | 10 +- .../exporter/http/HttpExporterUtils.java | 59 ---------- .../agent/exporter/local/LocalBulk.java | 3 - .../agent/exporter/local/LocalExporter.java | 95 +++++++++------ .../marvel/support/VersionUtils.java | 45 +++++++ .../collector/AbstractCollectorTestCase.java | 4 +- .../exporter/http/HttpExporterUtilsTests.java | 25 ++-- .../exporter/local/LocalExporterTests.java | 41 +------ .../renderer/cluster/ClusterStateIT.java | 4 +- .../renderer/cluster/ClusterStatsIT.java | 100 ---------------- .../renderer/cluster/ClusterStatsTests.java | 86 ++++++++++++++ .../marvel/test/MarvelIntegTestCase.java | 111 ++++++++++++++---- 24 files changed, 404 insertions(+), 303 deletions(-) create mode 100644 marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/MarvelTemplateUtils.java create mode 100644 marvel/src/main/java/org/elasticsearch/marvel/support/VersionUtils.java delete mode 100644 marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsIT.java create mode 100644 marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsTests.java diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/AgentService.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/AgentService.java index 6dfaf619dbc..d6625f1d460 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/AgentService.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/AgentService.java @@ -5,6 +5,7 @@ */ package org.elasticsearch.marvel.agent; +import org.elasticsearch.common.Strings; import org.elasticsearch.common.component.AbstractLifecycleComponent; import org.elasticsearch.common.inject.Inject; import org.elasticsearch.common.regex.Regex; @@ -172,13 +173,15 @@ public class AgentService extends AbstractLifecycleComponent imple if (bulk == null) { // exporters are either not ready or faulty continue; } -// long start = System.nanoTime(); //TODO remove try { + if (logger.isTraceEnabled()) { + logger.trace("collecting data - collectors [{}]", Strings.collectionToCommaDelimitedString(collectors)); + } for (Collector collector : collectors) { if (collecting) { Collection docs = collector.collect(); if (docs != null) { - logger.trace("bulk [{}] - adding collected docs from [{}] collector", bulk, collector.name()); + logger.trace("bulk [{}] - adding [{}] collected docs from [{}] collector", bulk, docs.size(), collector.name()); bulk.add(docs); } else { logger.trace("bulk [{}] - skipping collected docs from [{}] collector", bulk, collector.name()); @@ -190,8 +193,6 @@ public class AgentService extends AbstractLifecycleComponent imple } } } finally { -// long delta = System.nanoTime() - start; TODO remove -// logger.trace("closing bulk [{}] - collection took [{}] seconds", bulk, TimeValue.timeValueNanos(delta).format(PeriodType.seconds())); bulk.close(!closed && collecting); } diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/AbstractCollector.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/AbstractCollector.java index b61470e3c2d..480fb61c069 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/AbstractCollector.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/AbstractCollector.java @@ -39,6 +39,11 @@ public abstract class AbstractCollector extends AbstractLifecycleComponent return name; } + @Override + public String toString() { + return name; + } + @Override public T start() { logger.debug("starting collector [{}]", name()); @@ -52,8 +57,12 @@ public abstract class AbstractCollector extends AbstractLifecycleComponent /** * Indicates if the current collector is allowed to collect data */ - protected boolean canCollect() { - return licenseService.enabled() || licenseService.inExpirationGracePeriod(); + protected boolean shouldCollect() { + boolean validLicense = licenseService.enabled() || licenseService.inExpirationGracePeriod(); + if (!validLicense) { + logger.trace("collector [{}] can not collect data due to invalid license", name()); + } + return validLicense; } protected boolean isLocalNodeMaster() { @@ -63,11 +72,10 @@ public abstract class AbstractCollector extends AbstractLifecycleComponent @Override public Collection collect() { try { - if (canCollect()) { + if (shouldCollect()) { logger.trace("collector [{}] - collecting data...", name()); return doCollect(); } - logger.trace("collector [{}] can not collect data", name()); } catch (ElasticsearchTimeoutException e) { logger.error("collector [{}] timed out when collecting data"); } catch (Exception e) { diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/cluster/ClusterInfoCollector.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/cluster/ClusterInfoCollector.java index e4121e9a233..e6f202371f5 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/cluster/ClusterInfoCollector.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/cluster/ClusterInfoCollector.java @@ -50,7 +50,7 @@ public class ClusterInfoCollector extends AbstractCollector } @Override - protected boolean canCollect() { - return super.canCollect() && isLocalNodeMaster(); + protected boolean shouldCollect() { + return super.shouldCollect() && isLocalNodeMaster(); } @Override diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/indices/IndicesStatsCollector.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/indices/IndicesStatsCollector.java index 43e2bfadb9b..429a2add31f 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/indices/IndicesStatsCollector.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/indices/IndicesStatsCollector.java @@ -39,8 +39,8 @@ public class IndicesStatsCollector extends AbstractCollector { } @Override - protected boolean canCollect() { - return super.canCollect() && nodeEnvironment.hasNodeFile(); + protected boolean shouldCollect() { + return super.shouldCollect() && nodeEnvironment.hasNodeFile(); } @Override diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/shards/ShardsCollector.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/shards/ShardsCollector.java index fa79ae817ea..aaa48a9c320 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/shards/ShardsCollector.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/collector/shards/ShardsCollector.java @@ -40,8 +40,8 @@ public class ShardsCollector extends AbstractCollector { } @Override - protected boolean canCollect() { - return super.canCollect() && isLocalNodeMaster(); + protected boolean shouldCollect() { + return super.shouldCollect() && isLocalNodeMaster(); } @Override diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/Exporter.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/Exporter.java index 631dd79a5ff..b0a800b9278 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/Exporter.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/Exporter.java @@ -6,7 +6,9 @@ package org.elasticsearch.marvel.agent.exporter; import org.elasticsearch.Version; +import org.elasticsearch.cluster.metadata.IndexTemplateMetaData; import org.elasticsearch.common.Nullable; +import org.elasticsearch.common.Strings; import org.elasticsearch.common.logging.ESLogger; import org.elasticsearch.common.logging.Loggers; import org.elasticsearch.common.settings.Settings; @@ -26,7 +28,6 @@ public abstract class Exporter { public static final Version MIN_SUPPORTED_TEMPLATE_VERSION = Version.V_2_0_0_beta2; public static final String DEFAULT_INDEX_NAME_TIME_FORMAT = "YYYY.MM.dd"; - public static final String INDEX_TEMPLATE_NAME = "marvel"; protected final String type; protected final Config config; diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/MarvelTemplateUtils.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/MarvelTemplateUtils.java new file mode 100644 index 00000000000..b8022c9a8f4 --- /dev/null +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/MarvelTemplateUtils.java @@ -0,0 +1,66 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License; + * you may not use this file except in compliance with the Elastic License. + */ +package org.elasticsearch.marvel.agent.exporter; + +import org.elasticsearch.Version; +import org.elasticsearch.cluster.ClusterState; +import org.elasticsearch.cluster.metadata.IndexTemplateMetaData; +import org.elasticsearch.cluster.metadata.MetaData; +import org.elasticsearch.common.Strings; +import org.elasticsearch.common.io.Streams; +import org.elasticsearch.marvel.support.VersionUtils; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * + */ +public final class MarvelTemplateUtils { + + public static final String MARVEL_TEMPLATE_FILE = "/marvel_index_template.json"; + public static final String INDEX_TEMPLATE_NAME = ".marvel-es"; + public static final String MARVEL_VERSION_FIELD = "marvel_version"; + + + private MarvelTemplateUtils() { + } + + /** + * Loads the default Marvel template + */ + public static byte[] loadDefaultTemplate() { + try (InputStream is = MarvelTemplateUtils.class.getResourceAsStream(MARVEL_TEMPLATE_FILE)) { + ByteArrayOutputStream out = new ByteArrayOutputStream(); + Streams.copy(is, out); + return out.toByteArray(); + } catch (IOException e) { + throw new IllegalStateException("unable to load marvel template", e); + } + } + + public static Version templateVersion(IndexTemplateMetaData templateMetaData) { + String version = templateMetaData.settings().get("index." + MARVEL_VERSION_FIELD); + if (Strings.hasLength(version)) { + return Version.fromString(version); + } + return null; + } + + public static IndexTemplateMetaData findMarvelTemplate(ClusterState state) { + MetaData metaData = state.getMetaData(); + return metaData != null ? metaData.getTemplates().get(INDEX_TEMPLATE_NAME) : null; + } + + public static Version parseTemplateVersion(byte[] template) { + return VersionUtils.parseVersion(MARVEL_VERSION_FIELD, template); + } + + public static Version parseTemplateVersion(String template) { + return VersionUtils.parseVersion(MARVEL_VERSION_FIELD, template); + } +} diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporter.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporter.java index 719399bd3d0..f04dcca8cb5 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporter.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporter.java @@ -24,10 +24,12 @@ import org.elasticsearch.env.Environment; import org.elasticsearch.marvel.agent.exporter.ExportBulk; import org.elasticsearch.marvel.agent.exporter.Exporter; import org.elasticsearch.marvel.agent.exporter.MarvelDoc; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; import org.elasticsearch.marvel.agent.renderer.Renderer; import org.elasticsearch.marvel.agent.renderer.RendererRegistry; import org.elasticsearch.marvel.agent.settings.MarvelSettings; import org.elasticsearch.marvel.shield.MarvelSettingsFilter; +import org.elasticsearch.marvel.support.VersionUtils; import javax.net.ssl.*; import java.io.*; @@ -121,7 +123,7 @@ public class HttpExporter extends Exporter { hostnameVerification = config.settings().getAsBoolean(SSL_HOSTNAME_VERIFICATION_SETTING, true); // Checks that the built-in template is versioned - templateVersion = HttpExporterUtils.parseTemplateVersion(HttpExporterUtils.loadDefaultTemplate()); + templateVersion = MarvelTemplateUtils.parseTemplateVersion(MarvelTemplateUtils.loadDefaultTemplate()); if (templateVersion == null) { throw new IllegalStateException("unable to find built-in template version"); } @@ -354,7 +356,7 @@ public class HttpExporter extends Exporter { try (InputStream is = connection.getInputStream()) { ByteArrayOutputStream out = new ByteArrayOutputStream(); Streams.copy(is, out); - return HttpExporterUtils.parseElasticsearchVersion(out.toByteArray()); + return VersionUtils.parseVersion(out.toByteArray()); } } catch (IOException e) { throw new ElasticsearchException("failed to verify the remote cluster version on host [" + host + "]:\n" + e.getMessage()); @@ -408,7 +410,7 @@ public class HttpExporter extends Exporter { return false; } - Version remoteVersion = HttpExporterUtils.parseTemplateVersion(remoteTemplate); + Version remoteVersion = MarvelTemplateUtils.parseTemplateVersion(remoteTemplate); logger.debug("detected existing remote template in version [{}] on host [{}]", remoteVersion, host); if (remoteVersion == null) { @@ -461,7 +463,7 @@ public class HttpExporter extends Exporter { } logger.debug("loading marvel pre-configured template"); - byte[] template = HttpExporterUtils.loadDefaultTemplate(); + byte[] template = MarvelTemplateUtils.loadDefaultTemplate(); // Uploads the template and closes the outputstream Streams.copy(template, connection.getOutputStream()); diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtils.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtils.java index b0c3fa378e0..cbe11d54ded 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtils.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtils.java @@ -5,26 +5,12 @@ */ package org.elasticsearch.marvel.agent.exporter.http; -import org.elasticsearch.Version; -import org.elasticsearch.common.Strings; -import org.elasticsearch.common.io.Streams; - -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.InputStream; import java.net.MalformedURLException; import java.net.URISyntaxException; import java.net.URL; -import java.nio.charset.Charset; -import java.util.regex.Matcher; -import java.util.regex.Pattern; public class HttpExporterUtils { - public static final String MARVEL_TEMPLATE_FILE = "/marvel_index_template.json"; - public static final String MARVEL_VERSION_FIELD = "marvel_version"; - static final String VERSION_FIELD = "number"; - public static URL parseHostWithPath(String host, String path) throws URISyntaxException, MalformedURLException { if (!host.contains("://")) { @@ -49,49 +35,4 @@ public class HttpExporterUtils { } - /** - * Loads the default Marvel template - */ - public static byte[] loadDefaultTemplate() { - try (InputStream is = HttpExporterUtils.class.getResourceAsStream(MARVEL_TEMPLATE_FILE)) { - ByteArrayOutputStream out = new ByteArrayOutputStream(); - Streams.copy(is, out); - return out.toByteArray(); - } catch (IOException e) { - throw new IllegalStateException("unable to load marvel template", e); - } - } - - /** - * Extract & parse the version contained in the given template - */ - public static Version parseTemplateVersion(byte[] template) { - return parseTemplateVersion(new String(template, Charset.forName("UTF-8"))); - } - - /** - * Extract & parse the version contained in the given template - */ - public static Version parseTemplateVersion(String template) { - return parseVersion(MARVEL_VERSION_FIELD, template); - } - - /** - * Extract & parse the elasticsearch version, as returned by the REST API - */ - public static Version parseElasticsearchVersion(byte[] template) { - return parseVersion(VERSION_FIELD, new String(template, Charset.forName("UTF-8"))); - } - - static Version parseVersion(String field, String template) { - Pattern pattern = Pattern.compile(field + "\"\\s*:\\s*\"?([0-9a-zA-Z\\.\\-]+)\"?"); - Matcher matcher = pattern.matcher(template); - if (matcher.find()) { - String parsedVersion = matcher.group(1); - if (Strings.hasText(parsedVersion)) { - return Version.fromString(parsedVersion); - } - } - return null; - } } diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalBulk.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalBulk.java index 2327fefde80..db55c428180 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalBulk.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalBulk.java @@ -95,10 +95,7 @@ public class LocalBulk extends ExportBulk { return; } logger.trace("exporter [{}] - exporting data...", name); -// long start = System.nanoTime(); TODO remove BulkResponse bulkResponse = requestBuilder.get(); -// TimeValue time = TimeValue.timeValueNanos(System.nanoTime() - start); -// logger.trace("exporter [{}] - data exported, took [{}] seconds", name, time.format(PeriodType.seconds())); if (bulkResponse.hasFailures()) { throw new ElasticsearchException(bulkResponse.buildFailureMessage()); } diff --git a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporter.java b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporter.java index 9a40b0dd78d..2f4bff52d6f 100644 --- a/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporter.java +++ b/marvel/src/main/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporter.java @@ -15,21 +15,19 @@ import org.elasticsearch.cluster.ClusterService; import org.elasticsearch.cluster.ClusterState; import org.elasticsearch.cluster.ClusterStateListener; import org.elasticsearch.cluster.metadata.IndexTemplateMetaData; -import org.elasticsearch.common.Strings; import org.elasticsearch.common.inject.Inject; import org.elasticsearch.common.io.Streams; import org.elasticsearch.common.settings.Settings; import org.elasticsearch.gateway.GatewayService; import org.elasticsearch.marvel.agent.exporter.ExportBulk; import org.elasticsearch.marvel.agent.exporter.Exporter; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; import org.elasticsearch.marvel.agent.renderer.RendererRegistry; import org.elasticsearch.marvel.shield.SecuredClient; import java.io.ByteArrayOutputStream; import java.io.InputStream; -import static org.elasticsearch.marvel.agent.exporter.http.HttpExporterUtils.MARVEL_VERSION_FIELD; - /** * */ @@ -42,19 +40,38 @@ public class LocalExporter extends Exporter implements ClusterStateListener { private final RendererRegistry renderers; private volatile LocalBulk bulk; + private volatile boolean active = true; public LocalExporter(Exporter.Config config, Client client, ClusterService clusterService, RendererRegistry renderers) { super(TYPE, config); this.client = client; this.clusterService = clusterService; this.renderers = renderers; - bulk = start(clusterService.state()); + bulk = resolveBulk(clusterService.state(), bulk); clusterService.add(this); } @Override public void clusterChanged(ClusterChangedEvent event) { - bulk = start(event.state()); + LocalBulk currentBulk = bulk; + LocalBulk newBulk = resolveBulk(event.state(), currentBulk); + + // yes, this method will always be called by the cluster event loop thread + // but we need to sync with the {@code #close()} mechanism + synchronized (this) { + if (active) { + bulk = newBulk; + } else if (newBulk != null) { + newBulk.terminate(); + } + if (currentBulk == null && bulk != null) { + logger.debug("local exporter [{}] - started!", name()); + } + if (bulk != currentBulk && currentBulk != null) { + logger.debug("local exporter [{}] - stopped!", name()); + currentBulk.terminate(); + } + } } @Override @@ -62,31 +79,34 @@ public class LocalExporter extends Exporter implements ClusterStateListener { return bulk; } + // requires synchronization due to cluster state update events (see above) @Override - public void close() { + public synchronized void close() { + active = false; clusterService.remove(this); if (bulk != null) { try { bulk.terminate(); + bulk = null; } catch (Exception e) { - logger.error("failed to cleanly close open bulk for [{}] exporter", e, name()); + logger.error("local exporter [{}] - failed to cleanly close bulk", e, name()); } } } - LocalBulk start(ClusterState clusterState) { - if (clusterService.localNode() == null || clusterState == null || bulk != null) { - return bulk; + LocalBulk resolveBulk(ClusterState clusterState, LocalBulk currentBulk) { + if (clusterService.localNode() == null || clusterState == null) { + return currentBulk; } if (clusterState.blocks().hasGlobalBlock(GatewayService.STATE_NOT_RECOVERED_BLOCK)) { // wait until the gateway has recovered from disk, otherwise we think may not have .marvel-es- // indices but they may not have been restored from the cluster state on disk - logger.debug("exporter [{}] waiting until gateway has recovered from disk", name()); + logger.debug("local exporter [{}] - waiting until gateway has recovered from disk", name()); return null; } - IndexTemplateMetaData installedTemplate = clusterState.getMetaData().getTemplates().get(INDEX_TEMPLATE_NAME); + IndexTemplateMetaData installedTemplate = MarvelTemplateUtils.findMarvelTemplate(clusterState); // if this is not the master, we'll just look to see if the marvel template is already // installed and if so, if it has a compatible version. If it is (installed and compatible) @@ -94,40 +114,41 @@ public class LocalExporter extends Exporter implements ClusterStateListener { if (!clusterService.localNode().masterNode()) { if (installedTemplate == null) { // the marvel template is not yet installed in the given cluster state, we'll wait. - logger.debug("marvel index template [{}] does not exist, so service cannot start", INDEX_TEMPLATE_NAME); + logger.debug("local exporter [{}] - marvel index template [{}] does not exist, so service cannot start", name(), MarvelTemplateUtils.INDEX_TEMPLATE_NAME); return null; } - Version installedTemplateVersion = templateVersion(installedTemplate); + Version installedTemplateVersion = MarvelTemplateUtils.templateVersion(installedTemplate); if (!installedTemplateVersionIsSufficient(Version.CURRENT, installedTemplateVersion)) { - logger.debug("exporter cannot start. the currently installed marvel template (version [{}]) is incompatible with the " + - "current elasticsearch version [{}]. waiting until the template is updated", installedTemplateVersion, Version.CURRENT); + logger.debug("local exporter [{}] - cannot start. the currently installed marvel template (version [{}]) is incompatible with the " + + "current elasticsearch version [{}]. waiting until the template is updated", name(), installedTemplateVersion, Version.CURRENT); return null; } // ok.. we have a compatible template... we can start - logger.debug("marvel [{}] exporter started!", name()); - return new LocalBulk(name(), logger, client, indexNameResolver, renderers); + logger.debug("local exporter [{}] - started!", name()); + return currentBulk != null ? currentBulk : new LocalBulk(name(), logger, client, indexNameResolver, renderers); } // we are on master // // if we cannot find a template or a compatible template, we'll install one in / update it. if (installedTemplate == null) { + logger.debug("local exporter [{}] - could not find existing marvel template, installing a new one", name()); putTemplate(config.settings().getAsSettings("template.settings")); // we'll get that template on the next cluster state update return null; } - Version installedTemplateVersion = templateVersion(installedTemplate); + Version installedTemplateVersion = MarvelTemplateUtils.templateVersion(installedTemplate); if (installedTemplateVersionMandatesAnUpdate(Version.CURRENT, installedTemplateVersion)) { - logger.debug("installing new marvel template [{}], replacing [{}]", Version.CURRENT, installedTemplateVersion); + logger.debug("local exporter [{}] - installing new marvel template [{}], replacing [{}]", name(), Version.CURRENT, installedTemplateVersion); putTemplate(config.settings().getAsSettings("template.settings")); // we'll get that template on the next cluster state update return null; } else if (!installedTemplateVersionIsSufficient(Version.CURRENT, installedTemplateVersion)) { - logger.error("marvel template version [{}] is below the minimum compatible version [{}]. " + logger.error("local exporter [{}] - marvel template version [{}] is below the minimum compatible version [{}]. " + "please manually update the marvel template to a more recent version" + "and delete the current active marvel index (don't forget to back up it first if needed)", - installedTemplateVersion, MIN_SUPPORTED_TEMPLATE_VERSION); + name(), installedTemplateVersion, MIN_SUPPORTED_TEMPLATE_VERSION); // we're not going to do anything with the template.. it's too old, and the schema might // be too different than what this version of marvel/es can work with. For this reason we're // not going to export any data, to avoid mapping conflicts. @@ -135,16 +156,7 @@ public class LocalExporter extends Exporter implements ClusterStateListener { } // ok.. we have a compatible template... we can start - logger.debug("marvel [{}] exporter started!", name()); - return new LocalBulk(name(), logger, client, indexNameResolver, renderers); - } - - static Version templateVersion(IndexTemplateMetaData templateMetaData) { - String version = templateMetaData.settings().get("index." + MARVEL_VERSION_FIELD); - if (Strings.hasLength(version)) { - return Version.fromString(version); - } - return null; + return currentBulk != null ? currentBulk : new LocalBulk(name(), logger, client, indexNameResolver, renderers); } boolean installedTemplateVersionIsSufficient(Version current, Version installed) { @@ -165,6 +177,7 @@ public class LocalExporter extends Exporter implements ClusterStateListener { boolean installedTemplateVersionMandatesAnUpdate(Version current, Version installed) { if (installed == null) { + logger.debug("local exporter [{}] - currently installed marvel template is missing a version - installing a new one [{}]", name(), current); return true; } // Never update a very old template @@ -173,15 +186,15 @@ public class LocalExporter extends Exporter implements ClusterStateListener { } // Always update a template to the last up-to-date version if (current.after(installed)) { - logger.debug("the installed marvel template version [{}] will be updated to a newer version [{}]", installed, current); + logger.debug("local exporter [{}] - currently installed marvel template version [{}] will be updated to a newer version [{}]", name(), installed, current); return true; // When the template is up-to-date, force an update for snapshot versions only } else if (current.equals(installed)) { - logger.debug("the installed marvel template version [{}] is up-to-date", installed); + logger.debug("local exporter [{}] - currently installed marvel template version [{}] is up-to-date", name(), installed); return installed.snapshot() && !current.snapshot(); // Never update a template that is newer than the expected one } else { - logger.debug("the installed marvel template version [{}] is newer than the one required [{}]... keeping it.", installed, current); + logger.debug("local exporter [{}] - currently installed marvel template version [{}] is newer than the one required [{}]... keeping it.", name(), installed, current); return false; } } @@ -191,11 +204,13 @@ public class LocalExporter extends Exporter implements ClusterStateListener { ByteArrayOutputStream out = new ByteArrayOutputStream(); Streams.copy(is, out); final byte[] template = out.toByteArray(); - PutIndexTemplateRequest request = new PutIndexTemplateRequest(INDEX_TEMPLATE_NAME).source(template); + PutIndexTemplateRequest request = new PutIndexTemplateRequest(MarvelTemplateUtils.INDEX_TEMPLATE_NAME).source(template); if (customSettings != null && customSettings.names().size() > 0) { Settings updatedSettings = Settings.builder() .put(request.settings()) .put(customSettings) + // making sure we override any other template that may apply + .put("order", Integer.MAX_VALUE) .build(); request.settings(updatedSettings); } @@ -206,14 +221,16 @@ public class LocalExporter extends Exporter implements ClusterStateListener { client.admin().indices().putTemplate(request, new ActionListener() { @Override public void onResponse(PutIndexTemplateResponse response) { - if (!response.isAcknowledged()) { - logger.error("failed to update marvel index template"); + if (response.isAcknowledged()) { + logger.trace("local exporter [{}] - successfully installed marvel template", name()); + } else { + logger.error("local exporter [{}] - failed to update marvel index template", name()); } } @Override public void onFailure(Throwable throwable) { - logger.error("failed to update marvel index template", throwable); + logger.error("local exporter [{}] - failed to update marvel index template", throwable, name()); } }); diff --git a/marvel/src/main/java/org/elasticsearch/marvel/support/VersionUtils.java b/marvel/src/main/java/org/elasticsearch/marvel/support/VersionUtils.java new file mode 100644 index 00000000000..9d917ee737b --- /dev/null +++ b/marvel/src/main/java/org/elasticsearch/marvel/support/VersionUtils.java @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License; + * you may not use this file except in compliance with the Elastic License. + */ +package org.elasticsearch.marvel.support; + +import org.elasticsearch.Version; +import org.elasticsearch.common.Strings; + +import java.nio.charset.Charset; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +/** + * + */ +public final class VersionUtils { + + private VersionUtils() { + } + + public static Version parseVersion(byte[] text) { + return parseVersion("", new String(text, Charset.forName("UTF-8"))); + } + + /** + * Extract & parse the version contained in the given template + */ + public static Version parseVersion(String prefix, byte[] text) { + return parseVersion(prefix, new String(text, Charset.forName("UTF-8"))); + } + + public static Version parseVersion(String prefix, String text) { + Pattern pattern = Pattern.compile(prefix + "\"\\s*:\\s*\"?([0-9a-zA-Z\\.\\-]+)\"?"); + Matcher matcher = pattern.matcher(text); + if (matcher.find()) { + String parsedVersion = matcher.group(1); + if (Strings.hasText(parsedVersion)) { + return Version.fromString(parsedVersion); + } + } + return null; + } +} diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/collector/AbstractCollectorTestCase.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/collector/AbstractCollectorTestCase.java index 8fc03e80d33..dc021054911 100644 --- a/marvel/src/test/java/org/elasticsearch/marvel/agent/collector/AbstractCollectorTestCase.java +++ b/marvel/src/test/java/org/elasticsearch/marvel/agent/collector/AbstractCollectorTestCase.java @@ -74,14 +74,14 @@ public class AbstractCollectorTestCase extends MarvelIntegTestCase { protected void assertCanCollect(AbstractCollector collector) { assertNotNull(collector); - assertTrue("collector [" + collector.name() + "] should be able to collect data", collector.canCollect()); + assertTrue("collector [" + collector.name() + "] should be able to collect data", collector.shouldCollect()); Collection results = collector.collect(); assertNotNull(results); } protected void assertCannotCollect(AbstractCollector collector) { assertNotNull(collector); - assertFalse("collector [" + collector.name() + "] should not be able to collect data", collector.canCollect()); + assertFalse("collector [" + collector.name() + "] should not be able to collect data", collector.shouldCollect()); Collection results = collector.collect(); assertTrue(results == null || results.isEmpty()); } diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtilsTests.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtilsTests.java index bc7e47945c9..444401e78ca 100644 --- a/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtilsTests.java +++ b/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/http/HttpExporterUtilsTests.java @@ -6,6 +6,8 @@ package org.elasticsearch.marvel.agent.exporter.http; import org.elasticsearch.Version; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; +import org.elasticsearch.marvel.support.VersionUtils; import org.elasticsearch.test.ESTestCase; import org.hamcrest.Matchers; import org.junit.Test; @@ -17,6 +19,7 @@ import java.net.URL; import java.util.ArrayList; import java.util.List; +import static org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils.MARVEL_VERSION_FIELD; import static org.hamcrest.CoreMatchers.equalTo; @@ -24,17 +27,17 @@ public class HttpExporterUtilsTests extends ESTestCase { @Test public void testLoadTemplate() { - byte[] template = HttpExporterUtils.loadDefaultTemplate(); + byte[] template = MarvelTemplateUtils.loadDefaultTemplate(); assertNotNull(template); assertThat(template.length, Matchers.greaterThan(0)); } @Test public void testParseTemplateVersionFromByteArrayTemplate() throws IOException { - byte[] template = HttpExporterUtils.loadDefaultTemplate(); + byte[] template = MarvelTemplateUtils.loadDefaultTemplate(); assertNotNull(template); - Version version = HttpExporterUtils.parseTemplateVersion(template); + Version version = MarvelTemplateUtils.parseTemplateVersion(template); assertNotNull(version); } @@ -49,22 +52,22 @@ public class HttpExporterUtilsTests extends ESTestCase { templates.add("{ \"template\": \".marvel*\", \"settings\": { \"marvel_version\": \"2.0.0-beta1-SNAPSHOT\", \"index.number_of_shards\": 1 } }"); for (String template : templates) { - Version version = HttpExporterUtils.parseTemplateVersion(template); + Version version = MarvelTemplateUtils.parseTemplateVersion(template); assertNotNull(version); } - Version version = HttpExporterUtils.parseTemplateVersion("{\"marvel.index_format\": \"7\"}"); + Version version = MarvelTemplateUtils.parseTemplateVersion("{\"marvel.index_format\": \"7\"}"); assertNull(version); } @Test public void testParseVersion() throws IOException { - assertNotNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD, "{\"marvel_version\": \"2.0.0-beta1\"}")); - assertNotNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD, "{\"marvel_version\": \"2.0.0\"}")); - assertNotNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD, "{\"marvel_version\": \"1.5.2\"}")); - assertNotNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD, "{ \"template\": \".marvel*\", \"settings\": { \"marvel_version\": \"2.0.0-beta1-SNAPSHOT\", \"index.number_of_shards\": 1 } }")); - assertNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD, "{\"marvel.index_format\": \"7\"}")); - assertNull(HttpExporterUtils.parseVersion(HttpExporterUtils.MARVEL_VERSION_FIELD + "unkown", "{\"marvel_version\": \"1.5.2\"}")); + assertNotNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD, "{\"marvel_version\": \"2.0.0-beta1\"}")); + assertNotNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD, "{\"marvel_version\": \"2.0.0\"}")); + assertNotNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD, "{\"marvel_version\": \"1.5.2\"}")); + assertNotNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD, "{ \"template\": \".marvel*\", \"settings\": { \"marvel_version\": \"2.0.0-beta1-SNAPSHOT\", \"index.number_of_shards\": 1 } }")); + assertNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD, "{\"marvel.index_format\": \"7\"}")); + assertNull(VersionUtils.parseVersion(MARVEL_VERSION_FIELD + "unkown", "{\"marvel_version\": \"1.5.2\"}")); } diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporterTests.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporterTests.java index 6b934bacba7..3f6de59cda5 100644 --- a/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporterTests.java +++ b/marvel/src/test/java/org/elasticsearch/marvel/agent/exporter/local/LocalExporterTests.java @@ -27,6 +27,7 @@ import org.elasticsearch.marvel.agent.collector.indices.IndexRecoveryMarvelDoc; import org.elasticsearch.marvel.agent.exporter.Exporter; import org.elasticsearch.marvel.agent.exporter.Exporters; import org.elasticsearch.marvel.agent.exporter.MarvelDoc; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; import org.elasticsearch.marvel.agent.renderer.RendererRegistry; import org.elasticsearch.marvel.agent.settings.MarvelSettings; import org.elasticsearch.marvel.test.MarvelIntegTestCase; @@ -47,7 +48,6 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicLong; import static org.elasticsearch.marvel.agent.exporter.Exporter.MIN_SUPPORTED_TEMPLATE_VERSION; -import static org.elasticsearch.marvel.agent.exporter.http.HttpExporterUtils.MARVEL_VERSION_FIELD; import static org.hamcrest.Matchers.*; import static org.mockito.Mockito.*; @@ -129,7 +129,7 @@ public class LocalExporterTests extends MarvelIntegTestCase { awaitMarvelTemplateInstalled(); // now lets update the template with an old one and then restart the cluster - exporter.putTemplate(Settings.builder().put(MARVEL_VERSION_FIELD, fakeVersion.toString()).build()); + exporter.putTemplate(Settings.builder().put(MarvelTemplateUtils.MARVEL_VERSION_FIELD, fakeVersion.toString()).build()); logger.debug("full cluster restart"); final CountDownLatch latch = new CountDownLatch(1); internalCluster().fullRestart(new InternalTestCluster.RestartCallback() { @@ -168,7 +168,7 @@ public class LocalExporterTests extends MarvelIntegTestCase { IndexTemplateMetaData template = mock(IndexTemplateMetaData.class); when(template.settings()).thenReturn(Settings.builder().put("index.marvel_version", unsupportedVersion.toString()).build()); MetaData metaData = mock(MetaData.class); - when(metaData.getTemplates()).thenReturn(ImmutableOpenMap.builder().fPut(Exporter.INDEX_TEMPLATE_NAME, template).build()); + when(metaData.getTemplates()).thenReturn(ImmutableOpenMap.builder().fPut(MarvelTemplateUtils.INDEX_TEMPLATE_NAME, template).build()); ClusterBlocks blocks = mock(ClusterBlocks.class); when(blocks.hasGlobalBlock(GatewayService.STATE_NOT_RECOVERED_BLOCK)).thenReturn(false); ClusterState clusterState = mock(ClusterState.class); @@ -176,7 +176,7 @@ public class LocalExporterTests extends MarvelIntegTestCase { when(clusterState.blocks()).thenReturn(blocks); when(clusterService.state()).thenReturn(clusterState); - assertThat(exporter.start(clusterState), nullValue()); + assertThat(exporter.resolveBulk(clusterState, null), nullValue()); verifyZeroInteractions(client); if (master) { verify(exporter, times(1)).installedTemplateVersionMandatesAnUpdate(Version.CURRENT, unsupportedVersion); @@ -239,43 +239,14 @@ public class LocalExporterTests extends MarvelIntegTestCase { } } - private void awaitMarvelTemplateInstalled() throws Exception { - assertBusy(new Runnable() { - @Override - public void run() { - assertMarvelTemplateInstalled(); - } - }, 30, TimeUnit.SECONDS); - } - private void awaitMarvelTemplateInstalled(Version version) throws Exception { - assertBusy(new Runnable() { - @Override - public void run() { - assertMarvelTemplateInstalled(version); - } - }, 30, TimeUnit.SECONDS); - } - - protected void assertMarvelTemplateInstalled(Version version) { - for (IndexTemplateMetaData template : client().admin().indices().prepareGetTemplates(Exporter.INDEX_TEMPLATE_NAME).get().getIndexTemplates()) { - if (template.getName().equals(Exporter.INDEX_TEMPLATE_NAME)) { - Version templateVersion = LocalExporter.templateVersion(template); - if (templateVersion != null && templateVersion.id == version.id) { - return; - } - fail("did not find marvel template with expected version [" + version + "]. found version [" + templateVersion + "]"); - } - } - fail("marvel template could not be found"); - } private Version getCurrentlyInstalledTemplateVersion() { - GetIndexTemplatesResponse response = client().admin().indices().prepareGetTemplates(Exporter.INDEX_TEMPLATE_NAME).get(); + GetIndexTemplatesResponse response = client().admin().indices().prepareGetTemplates(MarvelTemplateUtils.INDEX_TEMPLATE_NAME).get(); assertThat(response, notNullValue()); assertThat(response.getIndexTemplates(), notNullValue()); assertThat(response.getIndexTemplates(), hasSize(1)); assertThat(response.getIndexTemplates().get(0), notNullValue()); - return LocalExporter.templateVersion(response.getIndexTemplates().get(0)); + return MarvelTemplateUtils.templateVersion(response.getIndexTemplates().get(0)); } } diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStateIT.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStateIT.java index 2d6f561b6b0..753dcd1a589 100644 --- a/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStateIT.java +++ b/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStateIT.java @@ -10,7 +10,7 @@ import org.elasticsearch.cluster.node.DiscoveryNodes; import org.elasticsearch.common.settings.Settings; import org.elasticsearch.index.query.QueryBuilders; import org.elasticsearch.marvel.agent.collector.cluster.ClusterStateCollector; -import org.elasticsearch.marvel.agent.exporter.http.HttpExporterUtils; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; import org.elasticsearch.marvel.agent.settings.MarvelSettings; import org.elasticsearch.marvel.test.MarvelIntegTestCase; import org.elasticsearch.search.SearchHit; @@ -68,7 +68,7 @@ public class ClusterStateIT extends MarvelIntegTestCase { ensureGreen(); logger.debug("--> forcing marvel's index template update"); - assertAcked(client().admin().indices().preparePutTemplate("marvel").setSource(HttpExporterUtils.loadDefaultTemplate()).execute().actionGet()); + assertAcked(client().admin().indices().preparePutTemplate("marvel").setSource(MarvelTemplateUtils.loadDefaultTemplate()).execute().actionGet()); logger.debug("--> deleting all marvel indices"); deleteMarvelIndices(); diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsIT.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsIT.java deleted file mode 100644 index bdcfc4d23b9..00000000000 --- a/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsIT.java +++ /dev/null @@ -1,100 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License; - * you may not use this file except in compliance with the Elastic License. - */ -package org.elasticsearch.marvel.agent.renderer.cluster; - -import org.elasticsearch.action.admin.cluster.node.info.NodeInfo; -import org.elasticsearch.action.admin.cluster.node.info.NodesInfoResponse; -import org.elasticsearch.action.admin.cluster.node.stats.NodeStats; -import org.elasticsearch.action.admin.cluster.node.stats.NodesStatsResponse; -import org.elasticsearch.action.admin.cluster.stats.ClusterStatsNodes; -import org.elasticsearch.action.admin.cluster.stats.ClusterStatsResponse; -import org.elasticsearch.action.search.SearchResponse; -import org.elasticsearch.cluster.metadata.IndexMetaData; -import org.elasticsearch.common.settings.Settings; -import org.elasticsearch.marvel.agent.collector.cluster.ClusterStatsCollector; -import org.elasticsearch.marvel.agent.settings.MarvelSettings; -import org.elasticsearch.marvel.test.MarvelIntegTestCase; -import org.elasticsearch.search.SearchHit; -import org.junit.Test; - -import java.util.Map; -import java.util.concurrent.TimeUnit; - -import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; -import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked; -import static org.hamcrest.Matchers.greaterThan; - -public class ClusterStatsIT extends MarvelIntegTestCase { - - @Override - protected Settings nodeSettings(int nodeOrdinal) { - return Settings.builder() - .put(super.nodeSettings(nodeOrdinal)) - .put(MarvelSettings.INTERVAL, "3s") - .put(MarvelSettings.COLLECTORS, ClusterStatsCollector.NAME) - .build(); - } - - @Test - public void testClusterStats() throws Exception { - ensureGreen(); - - logger.debug("--> creating some indices so that every data nodes will at leats a shard"); - ClusterStatsNodes.Counts counts = client().admin().cluster().prepareClusterStats().get().getNodesStats().getCounts(); - assertThat(counts.getTotal(), greaterThan(0)); - - for (int i = 0; i < randomIntBetween(1, 5); i++) { - assertAcked(prepareCreate("test-" + i).setSettings(Settings.settingsBuilder() - .put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, counts.getDataOnly() + counts.getMasterData()) - .build())); - index("test-" + i, "foo", "1", jsonBuilder().startObject().field("dummy_field", 1).endObject()); - } - - securedFlush(); - securedRefresh(); - - logger.debug("--> waiting for cluster stats to report data for each node"); - assertBusy(new Runnable() { - @Override - public void run() { - NodesInfoResponse nodesInfoResponse = client().admin().cluster().prepareNodesInfo().get(); - for (Map.Entry node : nodesInfoResponse.getNodesMap().entrySet()) { - // Checks that node has shards - ClusterStatsResponse clusterStatsResponse = client().admin().cluster().prepareClusterStats().setNodesIds(node.getKey()).get(); - assertNotNull(clusterStatsResponse.getIndicesStats().getShards()); - assertNotNull(clusterStatsResponse.getIndicesStats().getShards()); - assertThat(clusterStatsResponse.getIndicesStats().getShards().getTotal(), greaterThan(0)); - - NodesStatsResponse nodeStatsResponse = client().admin().cluster().prepareNodesStats(node.getKey()).setFs(true).get(); - for (NodeStats nodeStats : nodeStatsResponse) { - assertThat(nodeStats.getFs().total().getAvailable().bytes(), greaterThan(-1L)); - } - } - } - }, 30L, TimeUnit.SECONDS); - - logger.debug("--> delete all indices in case of cluster stats documents have been indexed with no shards data"); - deleteMarvelIndices(); - - awaitMarvelDocsCount(greaterThan(0L), ClusterStatsCollector.TYPE); - - logger.debug("--> searching for marvel documents of type [{}]", ClusterStatsCollector.TYPE); - SearchResponse response = client().prepareSearch().setTypes(ClusterStatsCollector.TYPE).get(); - assertThat(response.getHits().getTotalHits(), greaterThan(0L)); - - logger.debug("--> checking that every document contains the expected fields"); - String[] filters = ClusterStatsRenderer.FILTERS; - for (SearchHit searchHit : response.getHits().getHits()) { - Map fields = searchHit.sourceAsMap(); - - for (String filter : filters) { - assertContains(filter, fields); - } - } - - logger.debug("--> cluster stats successfully collected"); - } -} diff --git a/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsTests.java b/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsTests.java new file mode 100644 index 00000000000..ba7007e5cf3 --- /dev/null +++ b/marvel/src/test/java/org/elasticsearch/marvel/agent/renderer/cluster/ClusterStatsTests.java @@ -0,0 +1,86 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License; + * you may not use this file except in compliance with the Elastic License. + */ +package org.elasticsearch.marvel.agent.renderer.cluster; + +import org.elasticsearch.action.admin.cluster.stats.ClusterStatsNodes; +import org.elasticsearch.action.search.SearchResponse; +import org.elasticsearch.common.settings.Settings; +import org.elasticsearch.marvel.agent.collector.cluster.ClusterStatsCollector; +import org.elasticsearch.marvel.agent.settings.MarvelSettings; +import org.elasticsearch.marvel.test.MarvelIntegTestCase; +import org.elasticsearch.search.SearchHit; +import org.elasticsearch.test.ESIntegTestCase; +import org.elasticsearch.test.ESIntegTestCase.ClusterScope; +import org.junit.Test; + +import java.util.Locale; +import java.util.Map; + +import static org.elasticsearch.common.xcontent.XContentFactory.jsonBuilder; +import static org.elasticsearch.test.ESIntegTestCase.Scope.SUITE; +import static org.hamcrest.Matchers.greaterThan; + +@ClusterScope(scope = SUITE, maxNumDataNodes = 2) +public class ClusterStatsTests extends MarvelIntegTestCase { + + @Override + protected Settings nodeSettings(int nodeOrdinal) { + return Settings.builder() + .put(super.nodeSettings(nodeOrdinal)) + .put(MarvelSettings.INTERVAL, "3s") + .put(MarvelSettings.COLLECTORS, ClusterStatsCollector.NAME) + .build(); + } + + @Test + public void testClusterStats() throws Exception { + + // lets wait with the collection until all the shards started + stopCollection(); + + logger.debug("--> creating some indices so that every data nodes will at least a shard"); + ClusterStatsNodes.Counts counts = client().admin().cluster().prepareClusterStats().get().getNodesStats().getCounts(); + assertThat(counts.getTotal(), greaterThan(0)); + + String indexNameBase = randomAsciiOfLength(5).toLowerCase(Locale.ROOT); + int indicesCount = randomIntBetween(1, 5); + String[] indices = new String[indicesCount]; + for (int i = 0; i < indicesCount; i++) { + indices[i] = indexNameBase + "-" + i; + index(indices[i], "foo", "1", jsonBuilder().startObject().field("dummy_field", 1).endObject()); + } + + securedFlush(); + securedRefresh(); + securedEnsureGreen(); + + // ok.. we'll start collecting now... + startCollection(); + + awaitMarvelTemplateInstalled(); + + assertBusy(new Runnable() { + @Override + public void run() { + logger.debug("--> searching for marvel [{}] documents", ClusterStatsCollector.TYPE); + SearchResponse response = client().prepareSearch().setTypes(ClusterStatsCollector.TYPE).get(); + assertThat(response.getHits().getTotalHits(), greaterThan(0L)); + + logger.debug("--> checking that every document contains the expected fields"); + String[] filters = ClusterStatsRenderer.FILTERS; + for (SearchHit searchHit : response.getHits().getHits()) { + Map fields = searchHit.sourceAsMap(); + + for (String filter : filters) { + assertContains(filter, fields); + } + } + + logger.debug("--> cluster stats successfully collected"); + } + }); + } +} diff --git a/marvel/src/test/java/org/elasticsearch/marvel/test/MarvelIntegTestCase.java b/marvel/src/test/java/org/elasticsearch/marvel/test/MarvelIntegTestCase.java index 076feebc41d..1f1008f46d3 100644 --- a/marvel/src/test/java/org/elasticsearch/marvel/test/MarvelIntegTestCase.java +++ b/marvel/src/test/java/org/elasticsearch/marvel/test/MarvelIntegTestCase.java @@ -6,7 +6,12 @@ package org.elasticsearch.marvel.test; import org.elasticsearch.ElasticsearchException; +import org.elasticsearch.Version; +import org.elasticsearch.action.admin.cluster.state.ClusterStateResponse; +import org.elasticsearch.action.admin.indices.template.get.GetIndexTemplatesResponse; +import org.elasticsearch.cluster.ClusterState; import org.elasticsearch.cluster.metadata.IndexTemplateMetaData; +import org.elasticsearch.cluster.metadata.MetaData; import org.elasticsearch.common.Strings; import org.elasticsearch.common.io.Streams; import org.elasticsearch.common.settings.Settings; @@ -15,6 +20,7 @@ import org.elasticsearch.index.cache.IndexCacheModule; import org.elasticsearch.license.plugin.LicensePlugin; import org.elasticsearch.marvel.MarvelPlugin; import org.elasticsearch.marvel.agent.AgentService; +import org.elasticsearch.marvel.agent.exporter.MarvelTemplateUtils; import org.elasticsearch.marvel.agent.settings.MarvelSettings; import org.elasticsearch.plugins.Plugin; import org.elasticsearch.shield.ShieldPlugin; @@ -33,12 +39,9 @@ import java.io.OutputStream; import java.nio.charset.StandardCharsets; import java.nio.file.Files; import java.nio.file.Path; -import java.util.Arrays; -import java.util.Collection; -import java.util.Map; +import java.util.*; import java.util.concurrent.TimeUnit; -import static org.elasticsearch.marvel.agent.exporter.Exporter.INDEX_TEMPLATE_NAME; import static org.elasticsearch.test.hamcrest.ElasticsearchAssertions.assertAcked; import static org.hamcrest.Matchers.*; @@ -55,6 +58,11 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { return super.buildTestCluster(scope, seed); } + @Override + protected Set excludeTemplates() { + return Collections.singleton(MarvelTemplateUtils.INDEX_TEMPLATE_NAME); + } + @Override protected Settings nodeSettings(int nodeOrdinal) { Settings.Builder builder = Settings.builder() @@ -114,15 +122,12 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { protected void deleteMarvelIndices() { if (shieldEnabled) { try { - assertAcked(client().admin().indices().prepareDelete(MarvelSettings.MARVEL_INDICES_PREFIX + "*")); - } catch (Exception e) { + assertAcked(client().admin().indices().prepareDelete(".marvel-es-*")); + } catch (IndexNotFoundException e) { // if shield couldn't resolve any marvel index, it'll throw index not found exception. - if (!(e instanceof IndexNotFoundException)) { - throw e; - } } } else { - assertAcked(client().admin().indices().prepareDelete(MarvelSettings.MARVEL_INDICES_PREFIX + "*")); + assertAcked(client().admin().indices().prepareDelete(".marvel-es-*")); } } @@ -137,10 +142,23 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { }, 30, TimeUnit.SECONDS); } + protected void ensureMarvelIndicesGreen() { + if (shieldEnabled) { + try { + ensureGreen(".marvel-es-*"); + } catch (IndexNotFoundException e) { + // might happen with shield... + } + } else { + ensureGreen(".marvel-es-*"); + } + } + protected void assertMarvelDocsCount(Matcher matcher, String... types) { try { long count = client().prepareCount(MarvelSettings.MARVEL_INDICES_PREFIX + "*") .setTypes(types).get().getCount(); + logger.trace("--> searched for [{}] documents, found [{}]", Strings.arrayToCommaDelimitedString(types), count); assertThat(count, matcher); } catch (IndexNotFoundException e) { if (shieldEnabled) { @@ -152,22 +170,59 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { } protected void assertMarvelTemplateInstalled() { - for (IndexTemplateMetaData template : client().admin().indices().prepareGetTemplates(INDEX_TEMPLATE_NAME).get().getIndexTemplates()) { - if (template.getName().equals(INDEX_TEMPLATE_NAME)) { + ClusterStateResponse clusterStateResponse = client().admin().cluster().prepareState().get(); + if (clusterStateResponse != null) { + ClusterState state = clusterStateResponse.getState(); + MetaData md = state.getMetaData(); + } + GetIndexTemplatesResponse response = client().admin().indices().prepareGetTemplates().get(); + for (IndexTemplateMetaData template : response.getIndexTemplates()) { + if (template.getName().equals(MarvelTemplateUtils.INDEX_TEMPLATE_NAME)) { return; } } - fail("marvel template should exists"); + fail("marvel template should exist"); } protected void assertMarvelTemplateMissing() { - for (IndexTemplateMetaData template : client().admin().indices().prepareGetTemplates(INDEX_TEMPLATE_NAME).get().getIndexTemplates()) { - if (template.getName().equals(INDEX_TEMPLATE_NAME)) { - fail("marvel template shouldn't exists"); + for (IndexTemplateMetaData template : client().admin().indices().prepareGetTemplates(MarvelTemplateUtils.INDEX_TEMPLATE_NAME).get().getIndexTemplates()) { + if (template.getName().equals(MarvelTemplateUtils.INDEX_TEMPLATE_NAME)) { + fail("marvel template shouldn't exist"); } } } + protected void awaitMarvelTemplateInstalled() throws Exception { + assertBusy(new Runnable() { + @Override + public void run() { + assertMarvelTemplateInstalled(); + } + }, 30, TimeUnit.SECONDS); + } + + protected void awaitMarvelTemplateInstalled(Version version) throws Exception { + assertBusy(new Runnable() { + @Override + public void run() { + assertMarvelTemplateInstalled(version); + } + }, 30, TimeUnit.SECONDS); + } + + protected void assertMarvelTemplateInstalled(Version version) { + for (IndexTemplateMetaData template : client().admin().indices().prepareGetTemplates(MarvelTemplateUtils.INDEX_TEMPLATE_NAME).get().getIndexTemplates()) { + if (template.getName().equals(MarvelTemplateUtils.INDEX_TEMPLATE_NAME)) { + Version templateVersion = MarvelTemplateUtils.templateVersion(template); + if (templateVersion != null && templateVersion.id == version.id) { + return; + } + fail("did not find marvel template with expected version [" + version + "]. found version [" + templateVersion + "]"); + } + } + fail("marvel template could not be found"); + } + protected void awaitIndexExists(final String... indices) throws Exception { assertBusy(new Runnable() { @Override @@ -194,10 +249,8 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { if (shieldEnabled) { try { refresh(); - } catch (Exception e) { - if (!(e instanceof IndexNotFoundException)) { - throw e; - } + } catch (IndexNotFoundException e) { + // with shield we might get that if wildcards were resolved to no indices } } else { refresh(); @@ -208,16 +261,26 @@ public abstract class MarvelIntegTestCase extends ESIntegTestCase { if (shieldEnabled) { try { flush(indices); - } catch (Exception e) { - if (!(e instanceof IndexNotFoundException)) { - throw e; - } + } catch (IndexNotFoundException e) { + // with shield we might get that if wildcards were resolved to no indices } } else { flush(indices); } } + protected void securedEnsureGreen(String... indices) { + if (shieldEnabled) { + try { + ensureGreen(indices); + } catch (IndexNotFoundException e) { + // with shield we might get that if wildcards were resolved to no indices + } + } else { + ensureGreen(indices); + } + } + /** * Checks if a field exist in a map of values. If the field contains a dot like 'foo.bar' * it checks that 'foo' exists in the map of values and that it points to a sub-map. Then