IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

improvements to scenario log handling

Browse Source
This commit is contained in:
Jonathan Shook 2021-01-13 02:28:21 -06:00
parent ead06c0a25
commit bb787fd584
8 changed files with 144 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
engine-cli/src/main/java/io/nosqlbench/engine/cli/NBCLI.java
View File

@ -29,8 +29,8 @@ import io.nosqlbench.nb.api.logging.NBLogLevel;
import io.nosqlbench.nb.api.markdown.exporter.MarkdownExporter;
import io.nosqlbench.virtdata.userlibs.apps.VirtDataMainApp;
import joptsimple.internal.Strings;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.ConfigurationFactory;
import java.io.BufferedReader;
@ -40,7 +40,9 @@ import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
import java.util.Arrays;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.locks.LockSupport;
import java.util.stream.Collectors;
@ -339,6 +341,7 @@ public class NBCLI {
options.wantsGraaljsCompatMode(),
options.wantsStackTraces(),
options.wantsCompileScript(),
options.getReportSummaryTo(),
String.join("\n", args)
);
ScriptBuffer buffer = new BasicScriptBuffer()

11
engine-cli/src/main/java/io/nosqlbench/engine/cli/NBCLIOptions.java
View File

@ -76,6 +76,7 @@ public class NBCLIOptions {
private static final String REPORT_INTERVAL = "--report-interval";
private static final String REPORT_GRAPHITE_TO = "--report-graphite-to";
private static final String REPORT_CSV_TO = "--report-csv-to";
private static final String REPORT_SUMMARY_TO = "--report-summary-to";
private static final String PROGRESS = "--progress";
private static final String WITH_LOGGING_PATTERN = "--with-logging-pattern";
private static final String LOG_HISTOGRAMS = "--log-histograms";
@ -149,6 +150,7 @@ public class NBCLIOptions {
private final List<String> statePathAccesses = new ArrayList<>();
private final String hdrForChartFileName = DEFAULT_CHART_HDR_LOG_NAME;
private String dockerPromRetentionDays = "183d";
private String reportSummaryTo = "stdout:60";
public String getAnnotatorsConfig() {
return annotatorsConfig;
@ -163,6 +165,10 @@ public class NBCLIOptions {
return this.dockerPromRetentionDays;
}
public String getReportSummaryTo() {
return reportSummaryTo;
}
public enum Mode {
ParseGlobalsOnly,
ParseAllOptions
@ -490,6 +496,10 @@ public class NBCLIOptions {
arglist.removeFirst();
reportCsvTo = arglist.removeFirst();
break;
case REPORT_SUMMARY_TO:
arglist.removeFirst();
reportSummaryTo = arglist.removeFirst();
break;
case LIST_DRIVERS:
case LIST_ACTIVITY_TYPES:
arglist.removeFirst();
@ -841,5 +851,4 @@ public class NBCLIOptions {
return progressSpec;
}
}

49
engine-core/src/main/java/io/nosqlbench/engine/core/lifecycle/ScenarioResult.java
View File

@ -25,6 +25,9 @@ import io.nosqlbench.engine.core.logging.Log4JMetricsReporter;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
@ -54,28 +57,25 @@ public class ScenarioResult {
logger.info("-- SCENARIO TOOK " + getElapsedMillis() + "ms --");
}
public void reportToLog() {
logger.debug("-- BEGIN METRICS DETAIL --");
Log4JMetricsReporter reporter = Log4JMetricsReporter.forRegistry(ActivityMetrics.getMetricRegistry())
.withLoggingLevel(Log4JMetricsReporter.LoggingLevel.DEBUG)
.convertDurationsTo(TimeUnit.MICROSECONDS)
.convertRatesTo(TimeUnit.SECONDS)
.filter(MetricFilter.ALL)
.outputTo(logger)
.build();
reporter.report();
logger.info("-- END METRICS DETAIL --");
}
public void reportToConsole() {
public String getSummaryReport() {
ByteArrayOutputStream os = new ByteArrayOutputStream();
PrintStream ps = new PrintStream(os);
ConsoleReporter consoleReporter = ConsoleReporter.forRegistry(ActivityMetrics.getMetricRegistry())
.convertDurationsTo(TimeUnit.MICROSECONDS)
.convertRatesTo(TimeUnit.SECONDS)
.filter(MetricFilter.ALL)
.outputTo(System.out)
.outputTo(ps)
.build();
consoleReporter.report();
ps.flush();
String result = os.toString(StandardCharsets.UTF_8);
return result;
}
public void reportToConsole() {
String summaryReport = getSummaryReport();
System.out.println(summaryReport);
}
@ -100,4 +100,21 @@ public class ScenarioResult {
public long getElapsedMillis() {
return endedAt - startedAt;
}
public void reportTo(PrintStream out) {
out.println(getSummaryReport());
}
public void reportToLog() {
logger.debug("-- BEGIN METRICS DETAIL --");
Log4JMetricsReporter reporter = Log4JMetricsReporter.forRegistry(ActivityMetrics.getMetricRegistry())
.withLoggingLevel(Log4JMetricsReporter.LoggingLevel.DEBUG)
.convertDurationsTo(TimeUnit.MICROSECONDS)
.convertRatesTo(TimeUnit.SECONDS)
.filter(MetricFilter.ALL)
.outputTo(logger)
.build();
reporter.report();
logger.info("-- END METRICS DETAIL --");
}
}

1
engine-core/src/main/java/io/nosqlbench/engine/core/lifecycle/ScenariosResults.java
View File

@ -69,7 +69,6 @@ public class ScenariosResults {
oresult.reportElapsedMillis();
if (oresult.getElapsedMillis() >= 60_000) {
oresult.reportToConsole();
oresult.reportToLog();
} else {
logger.info("Metrics suppressed because scenario was less than 1 minute long.");
logger.info("Metrics data is not reliable for short sampling periods.");

57
engine-core/src/main/java/io/nosqlbench/engine/core/script/Scenario.java
View File

@ -38,8 +38,7 @@ import javax.script.Compilable;
import javax.script.CompiledScript;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.*;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
@ -57,6 +56,7 @@ import java.util.stream.Collectors;
public class Scenario implements Callable<ScenarioResult> {
private final String commandLine;
private final String reportSummaryTo;
private Logger logger = LogManager.getLogger("SCENARIO");
private State state = State.Scheduled;
@ -84,7 +84,7 @@ public class Scenario implements Callable<ScenarioResult> {
private ScriptParams scenarioScriptParams;
private String scriptfile;
private Engine engine = Engine.Graalvm;
private boolean wantsStackTraces=false;
private boolean wantsStackTraces = false;
private boolean wantsCompiledScript;
private long startedAtMillis = -1L;
private long endedAtMillis = -1L;
@ -102,6 +102,7 @@ public class Scenario implements Callable<ScenarioResult> {
boolean wantsGraaljsCompatMode,
boolean wantsStackTraces,
boolean wantsCompiledScript,
String reportSummaryTo,
String commandLine) {
this.scenarioName = scenarioName;
this.scriptfile = scriptfile;
@ -110,6 +111,7 @@ public class Scenario implements Callable<ScenarioResult> {
this.wantsGraaljsCompatMode = wantsGraaljsCompatMode;
this.wantsStackTraces = wantsStackTraces;
this.wantsCompiledScript = wantsCompiledScript;
this.reportSummaryTo = reportSummaryTo;
this.commandLine = commandLine;
}
@ -124,6 +126,7 @@ public class Scenario implements Callable<ScenarioResult> {
public Scenario(String name, Engine engine) {
this.scenarioName = name;
this.reportSummaryTo = "CONSOLE";
this.engine = engine;
this.commandLine = "";
}
@ -268,7 +271,7 @@ public class Scenario implements Callable<ScenarioResult> {
String filename = scriptfile.replace("_SESSIONNAME_", scenarioName);
logger.debug("-> invoking main scenario script (" +
"interpreted from " + filename +")");
"interpreted from " + filename + ")");
Path written = Files.write(
Path.of(filename),
script.getBytes(StandardCharsets.UTF_8),
@ -353,7 +356,47 @@ public class Scenario implements Callable<ScenarioResult> {
public ScenarioResult call() {
run();
String iolog = scriptEnv.getTimedLog();
return new ScenarioResult(iolog, this.startedAtMillis, this.endedAtMillis);
ScenarioResult result = new ScenarioResult(iolog, this.startedAtMillis, this.endedAtMillis);
result.reportToLog();
Optional.ofNullable(getSummaryDestination(reportSummaryTo, result.getElapsedMillis()))
.ifPresent(result::reportTo);
return result;
}
private PrintStream getSummaryDestination(String reportSummaryTo, long elapsedMillis) {
if (reportSummaryTo != null && !reportSummaryTo.isBlank()) {
String[] split = reportSummaryTo.split(":", 2);
String summaryTo = split[0];
long summaryWhen = split.length == 2 ? Long.parseLong(split[1]) * 1000L : 60000L;
if (elapsedMillis > summaryWhen) {
PrintStream out = null;
switch (summaryTo.toLowerCase()) {
case "console":
case "stdout":
return System.out;
case "stderr":
return System.err;
default:
String outName = summaryTo
.replaceAll("_session_", getScenarioName())
.replaceAll("_scenario_", getScenarioName());
try {
out = new PrintStream(new FileOutputStream(outName));
return out;
} catch (FileNotFoundException e) {
throw new RuntimeException(e);
}
}
} else {
logger.info("Metrics suppressed because scenario was less than " + summaryWhen + "ms long.");
logger.info("Metrics data is not reliable for short sampling periods.");
logger.info("To get metrics on console, run a longer scenario.");
}
}
return null;
}
@Override
@ -406,5 +449,9 @@ public class Scenario implements Callable<ScenarioResult> {
public void enableCharting() {
MetricRegistry metricRegistry = ActivityMetrics.getMetricRegistry();
}
public String getReportSummaryTo() {
return reportSummaryTo;
}
}

1
engine-rest/src/main/java/io/nosqlbench/engine/rest/resources/ScenarioExecutorEndpoint.java
View File

@ -109,6 +109,7 @@ public class ScenarioExecutorEndpoint implements WebServiceObject {
false,
true,
false,
"",
cmdList.toString());
scenario.addScriptText(buffer.getParsedScript());

3
nb/src/test/java/io/nosqlbench/engine/core/script/AsyncScriptIntegrationTests.java
View File

@ -69,7 +69,6 @@ public class AsyncScriptIntegrationTests {
e.execute(s);
ScenariosResults scenariosResults = e.awaitAllResults();
ScenarioResult scenarioResult = scenariosResults.getOne();
scenarioResult.reportToLog();
return scenarioResult;
}
@ -199,13 +198,11 @@ public class AsyncScriptIntegrationTests {
@Test
public void testAwaitFinished() {
ScenarioResult scenarioResult = runScenario("awaitfinished");
scenarioResult.reportToLog();
}
@Test
public void testStartStop() {
ScenarioResult scenarioResult = runScenario("startstopdiag");
scenarioResult.reportToLog();
int startedAt = scenarioResult.getIOLog().indexOf("starting activity teststartstopdiag");
int stoppedAt = scenarioResult.getIOLog().indexOf("stopped activity teststartstopdiag");
assertThat(startedAt).isGreaterThan(0);

1
nb/src/test/java/io/nosqlbench/engine/core/script/ScriptIntegrationTests.java
View File

@ -64,7 +64,6 @@ public class ScriptIntegrationTests {
e.execute(s);
ScenariosResults scenariosResults = e.awaitAllResults();
ScenarioResult scenarioResult = scenariosResults.getOne();
scenarioResult.reportToLog();
return scenarioResult;
}