Skip to content

Commit 3016654

Browse files
committed
Merge branch '6.x' into ccr-6.x
* 6.x: Fix scriptdocvalues tests with dates Correct minor typo in explain.asciidoc for HLRC Fix painless whitelist and warnings from backporting #31441 Build: Add elastic maven to repos used by BuildPlugin (#32549) Scripting: Conditionally use java time api in scripting (#31441) [ML] Improve error when no available field exists for rule scope (#32550) [ML] Improve error for functions with limited rule condition support (#32548) [ML] Remove multiple_bucket_spans [ML] Fix thread leak when waiting for job flush (#32196) (#32541) Painless: Clean Up PainlessField (#32525) Add @AwaitsFix for #32554 Remove broken @link in Javadoc Add AwaitsFix to failing test - see #32546 SQL: Added support for string manipulating functions with more than one parameter (#32356) [DOCS] Reloadable Secure Settings (#31713) Fix compilation error introduced by #32339 [Rollup] Remove builders from TermsGroupConfig (#32507) Use hostname instead of IP with SPNEGO test (#32514) Switch x-pack rolling restart to new style Requests (#32339) [DOCS] Small fixes in rule configuration page (#32516) Painless: Clean up PainlessMethod (#32476) SQL: Add test for handling of partial results (#32474) Docs: Add missing migration doc for logging change Build: Remove shadowing from benchmarks (#32475) Docs: Add all JDKs to CONTRIBUTING.md Logging: Make node name consistent in logger (#31588) High-level client: fix clusterAlias parsing in SearchHit (#32465) REST high-level client: parse back _ignored meta field (#32362) backport fix of reduceRandom fix (#32508) Add licensing enforcement for FIPS mode (#32437) INGEST: Clean up Java8 Stream Usage (#32059) (#32485) Improve the error message when an index is incompatible with field aliases. (#32482) Mute testFilterCacheStats Scripting: Fix painless compiler loader to know about context classes (#32385) [ML][DOCS] Fix typo applied_to => applies_to Mute SSLTrustRestrictionsTests on JDK 11 Changed ReindexRequest to use Writeable.Reader (#32401) Increase max chunk size to 256Mb for repo-azure (#32101) Mute KerberosAuthenticationIT fix no=>not typo (#32463) HLRC: Add delete watch action (#32337) Fix calculation of orientation of polygons (#27967) [Kerberos] Add missing javadocs (#32469) Fix missing JavaDoc for @throws in several places in KerberosTicketValidator. Make get all app privs requires "*" permission (#32460) Ensure KeyStoreWrapper decryption exceptions are handled (#32472) update rollover to leverage write-alias semantics (#32216) [Kerberos] Remove Kerberos bootstrap checks (#32451) Switch security to new style Requests (#32290) Switch security spi example to new style Requests (#32341) Painless: Add PainlessConstructor (#32447) Update Fuzzy Query docs to clarify default behavior re max_expansions (#30819) Remove > from Javadoc (fatal with Java 11) Tests: Fix convert error tests to use fixed value (#32415) IndicesClusterStateService should replace an init. replica with an init. primary with the same aId (#32374) auto-interval date histogram - 6.x backport (#32107) [CI] Mute DocumentSubsetReaderTests testSearch [TEST] Mute failing InternalEngineTests#testSeqNoAndCheckpoints TEST: testDocStats should always use forceMerge (#32450) TEST: Avoid deletion in FlushIT AwaitsFix IndexShardTests#testDocStats Painless: Add method type to method. (#32441) Remove reference to non-existent store type (#32418) [TEST] Mute failing FlushIT test Fix ordering of bootstrap checks in docs (#32417) Wrong discovery.type for azure in breaking changes (#32432) Mute ConvertProcessorTests failing tests TESTS: Move netty leak detection to paranoid level (#32354) (#32425) Upgrade to Lucene-7.5.0-snapshot-608f0277b0 (#32390) [Kerberos] Avoid vagrant update on precommit (#32416) TEST: Avoid triggering merges in FlushIT [DOCS] Fixes formatting of scope object in job resource Switch x-pack/plugin to new style Requests (#32327) Release requests in cors handle (#32410) Remove BouncyCastle dependency from runtime (#32402) Copy missing segment attributes in getSegmentInfo (#32396) Rest HL client: Add put license action (#32214) Docs: Correcting a typo in tophits (#32359) Build: Stop double generating buildSrc pom (#32408) Switch x-pack full restart to new style Requests (#32294) Painless: Clean Up PainlessClass Variables (#32380) [ML] Consistent pattern for strict/lenient parser names (#32399) Add Restore Snapshot High Level REST API Update update-settings.asciidoc (#31378) Introduce index store plugins (#32375) Rank-Eval: Reduce scope of an unchecked supression Make sure _forcemerge respects `max_num_segments`. (#32291)
2 parents 133f56c + 5d804d0 commit 3016654

File tree

487 files changed

+14841
-3283
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

487 files changed

+14841
-3283
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@ JDK 10 and testing on a JDK 8 runtime; to do this, set `RUNTIME_JAVA_HOME`
100100
pointing to the Java home of a JDK 8 installation. Note that this mechanism can
101101
be used to test against other JDKs as well, this is not only limited to JDK 8.
102102

103+
> Note: It is also required to have `JAVA7_HOME`, `JAVA8_HOME` and
104+
`JAVA10_HOME` available so that the tests can pass.
105+
106+
> Warning: do not use `sdkman` for Java installations which do not have proper
107+
`jrunscript` for jdk distributions.
108+
103109
Elasticsearch uses the Gradle wrapper for its build. You can execute Gradle
104110
using the wrapper via the `gradlew` script in the root of the repository.
105111

benchmarks/README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,39 @@ This directory contains the microbenchmark suite of Elasticsearch. It relies on
44

55
## Purpose
66

7-
We do not want to microbenchmark everything but the kitchen sink and should typically rely on our
8-
[macrobenchmarks](https://elasticsearch-benchmarks.elastic.co/app/kibana#/dashboard/Nightly-Benchmark-Overview) with
9-
[Rally](http://github.com/elastic/rally). Microbenchmarks are intended to spot performance regressions in performance-critical components.
7+
We do not want to microbenchmark everything but the kitchen sink and should typically rely on our
8+
[macrobenchmarks](https://elasticsearch-benchmarks.elastic.co/app/kibana#/dashboard/Nightly-Benchmark-Overview) with
9+
[Rally](http://github.com/elastic/rally). Microbenchmarks are intended to spot performance regressions in performance-critical components.
1010
The microbenchmark suite is also handy for ad-hoc microbenchmarks but please remove them again before merging your PR.
1111

1212
## Getting Started
1313

14-
Just run `gradle :benchmarks:jmh` from the project root directory. It will build all microbenchmarks, execute them and print the result.
14+
Just run `gradlew -p benchmarks run` from the project root
15+
directory. It will build all microbenchmarks, execute them and print
16+
the result.
1517

1618
## Running Microbenchmarks
1719

18-
Benchmarks are always run via Gradle with `gradle :benchmarks:jmh`.
19-
20-
Running via an IDE is not supported as the results are meaningless (we have no control over the JVM running the benchmarks).
20+
Running via an IDE is not supported as the results are meaningless
21+
because we have no control over the JVM running the benchmarks.
2122

22-
If you want to run a specific benchmark class, e.g. `org.elasticsearch.benchmark.MySampleBenchmark` or have special requirements
23-
generate the uberjar with `gradle :benchmarks:jmhJar` and run it directly with:
23+
If you want to run a specific benchmark class like, say,
24+
`MemoryStatsBenchmark`, you can use `--args`:
2425

2526
```
26-
java -jar benchmarks/build/distributions/elasticsearch-benchmarks-*.jar
27+
gradlew -p benchmarks run --args ' AllocationBenchmark'
2728
```
2829

29-
JMH supports lots of command line parameters. Add `-h` to the command above to see the available command line options.
30+
Everything in the `'` gets sent on the command line to JMH. The leading ` `
31+
inside the `'`s is important. Without it parameters are sometimes sent to
32+
gradle.
3033

3134
## Adding Microbenchmarks
3235

33-
Before adding a new microbenchmark, make yourself familiar with the JMH API. You can check our existing microbenchmarks and also the
36+
Before adding a new microbenchmark, make yourself familiar with the JMH API. You can check our existing microbenchmarks and also the
3437
[JMH samples](http://hg.openjdk.java.net/code-tools/jmh/file/tip/jmh-samples/src/main/java/org/openjdk/jmh/samples/).
3538

36-
In contrast to tests, the actual name of the benchmark class is not relevant to JMH. However, stick to the naming convention and
39+
In contrast to tests, the actual name of the benchmark class is not relevant to JMH. However, stick to the naming convention and
3740
end the class name of a benchmark with `Benchmark`. To have JMH execute a benchmark, annotate the respective methods with `@Benchmark`.
3841

3942
## Tips and Best Practices
@@ -42,15 +45,15 @@ To get realistic results, you should exercise care when running benchmarks. Here
4245

4346
### Do
4447

45-
* Ensure that the system executing your microbenchmarks has as little load as possible. Shutdown every process that can cause unnecessary
48+
* Ensure that the system executing your microbenchmarks has as little load as possible. Shutdown every process that can cause unnecessary
4649
runtime jitter. Watch the `Error` column in the benchmark results to see the run-to-run variance.
4750
* Ensure to run enough warmup iterations to get the benchmark into a stable state. If you are unsure, don't change the defaults.
4851
* Avoid CPU migrations by pinning your benchmarks to specific CPU cores. On Linux you can use `taskset`.
49-
* Fix the CPU frequency to avoid Turbo Boost from kicking in and skewing your results. On Linux you can use `cpufreq-set` and the
52+
* Fix the CPU frequency to avoid Turbo Boost from kicking in and skewing your results. On Linux you can use `cpufreq-set` and the
5053
`performance` CPU governor.
5154
* Vary the problem input size with `@Param`.
5255
* Use the integrated profilers in JMH to dig deeper if benchmark results to not match your hypotheses:
53-
* Run the generated uberjar directly and use `-prof gc` to check whether the garbage collector runs during a microbenchmarks and skews
56+
* Run the generated uberjar directly and use `-prof gc` to check whether the garbage collector runs during a microbenchmarks and skews
5457
your results. If so, try to force a GC between runs (`-gc true`) but watch out for the caveats.
5558
* Use `-prof perf` or `-prof perfasm` (both only available on Linux) to see hotspots.
5659
* Have your benchmarks peer-reviewed.
@@ -59,4 +62,4 @@ To get realistic results, you should exercise care when running benchmarks. Here
5962

6063
* Blindly believe the numbers that your microbenchmark produces but verify them by measuring e.g. with `-prof perfasm`.
6164
* Run more threads than your number of CPU cores (in case you run multi-threaded microbenchmarks).
62-
* Look only at the `Score` column and ignore `Error`. Instead take countermeasures to keep `Error` low / variance explainable.
65+
* Look only at the `Score` column and ignore `Error`. Instead take countermeasures to keep `Error` low / variance explainable.

benchmarks/build.gradle

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,8 @@
1818
*/
1919

2020
apply plugin: 'elasticsearch.build'
21-
22-
// order of this section matters, see: https://github.com/johnrengelman/shadow/issues/336
23-
apply plugin: 'application' // have the shadow plugin provide the runShadow task
21+
apply plugin: 'application'
2422
mainClassName = 'org.openjdk.jmh.Main'
25-
apply plugin: 'com.github.johnrengelman.shadow' // build an uberjar with all benchmarks
2623

2724
// Not published so no need to assemble
2825
tasks.remove(assemble)
@@ -51,10 +48,8 @@ compileJava.options.compilerArgs << "-Xlint:-cast,-deprecation,-rawtypes,-try,-u
5148
// needs to be added separately otherwise Gradle will quote it and javac will fail
5249
compileJava.options.compilerArgs.addAll(["-processor", "org.openjdk.jmh.generators.BenchmarkProcessor"])
5350

54-
forbiddenApis {
55-
// classes generated by JMH can use all sorts of forbidden APIs but we have no influence at all and cannot exclude these classes
56-
ignoreFailures = true
57-
}
51+
// classes generated by JMH can use all sorts of forbidden APIs but we have no influence at all and cannot exclude these classes
52+
forbiddenApisMain.enabled = false
5853

5954
// No licenses for our benchmark deps (we don't ship benchmarks)
6055
dependencyLicenses.enabled = false
@@ -70,20 +65,3 @@ thirdPartyAudit.excludes = [
7065
'org.openjdk.jmh.profile.HotspotRuntimeProfiler',
7166
'org.openjdk.jmh.util.Utils'
7267
]
73-
74-
runShadow {
75-
executable = new File(project.runtimeJavaHome, 'bin/java')
76-
}
77-
78-
// alias the shadowJar and runShadow tasks to abstract from the concrete plugin that we are using and provide a more consistent interface
79-
task jmhJar(
80-
dependsOn: shadowJar,
81-
description: 'Generates an uberjar with the microbenchmarks and all dependencies',
82-
group: 'Benchmark'
83-
)
84-
85-
task jmh(
86-
dependsOn: runShadow,
87-
description: 'Runs all microbenchmarks',
88-
group: 'Benchmark'
89-
)

benchmarks/src/main/resources/log4j2.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
appender.console.type = Console
22
appender.console.name = console
33
appender.console.layout.type = PatternLayout
4-
appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%m%n
4+
appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c] [%node_name]%marker %m%n
55

66
# Do not log at all if it is not really critical - we're in a benchmark
77
rootLogger.level = error

buildSrc/build.gradle

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,4 +183,12 @@ if (project != rootProject) {
183183
testClass = 'org.elasticsearch.gradle.test.GradleUnitTestCase'
184184
integTestClass = 'org.elasticsearch.gradle.test.GradleIntegrationTestCase'
185185
}
186+
187+
/*
188+
* We alread configure publication and we don't need or want this one that
189+
* comes from the java-gradle-plugin.
190+
*/
191+
afterEvaluate {
192+
generatePomFileForPluginMavenPublication.enabled = false
193+
}
186194
}

buildSrc/src/main/groovy/org/elasticsearch/gradle/BuildPlugin.groovy

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,10 @@ class BuildPlugin implements Plugin<Project> {
405405
repos.mavenLocal()
406406
}
407407
repos.mavenCentral()
408+
repos.maven {
409+
name "elastic"
410+
url "https://artifacts.elastic.co/maven"
411+
}
408412
String luceneVersion = VersionProperties.lucene
409413
if (luceneVersion.contains('-snapshot')) {
410414
// extract the revision number from the version with a regex matcher
@@ -778,11 +782,16 @@ class BuildPlugin implements Plugin<Project> {
778782
systemProperty property.getKey(), property.getValue()
779783
}
780784
}
785+
786+
// TODO: remove this once joda time is removed from scriptin in 7.0
787+
systemProperty 'es.scripting.use_java_time', 'true'
788+
781789
// Set the system keystore/truststore password if we're running tests in a FIPS-140 JVM
782790
if (project.inFipsJvm) {
783791
systemProperty 'javax.net.ssl.trustStorePassword', 'password'
784792
systemProperty 'javax.net.ssl.keyStorePassword', 'password'
785793
}
794+
786795
boolean assertionsEnabled = Boolean.parseBoolean(System.getProperty('tests.asserts', 'true'))
787796
enableSystemAssertions assertionsEnabled
788797
enableAssertions assertionsEnabled

buildSrc/version.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
elasticsearch = 6.5.0
2-
lucene = 7.5.0-snapshot-b9e064b935
2+
lucene = 7.5.0-snapshot-608f0277b0
33

44
# optional dependencies
55
spatial4j = 0.7

client/benchmark/README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,54 @@
22

33
1. Build `client-benchmark-noop-api-plugin` with `gradle :client:client-benchmark-noop-api-plugin:assemble`
44
2. Install it on the target host with `bin/elasticsearch-plugin install file:///full/path/to/client-benchmark-noop-api-plugin.zip`
5-
3. Start Elasticsearch on the target host (ideally *not* on the same machine)
6-
4. Build an uberjar with `gradle :client:benchmark:shadowJar` and execute it.
5+
3. Start Elasticsearch on the target host (ideally *not* on the machine
6+
that runs the benchmarks)
7+
4. Run the benchmark with
8+
```
9+
./gradlew -p client/benchmark run --args ' params go here'
10+
```
711

8-
Repeat all steps above for the other benchmark candidate.
12+
Everything in the `'` gets sent on the command line to JMH. The leading ` `
13+
inside the `'`s is important. Without it parameters are sometimes sent to
14+
gradle.
15+
16+
See below for some example invocations.
917

1018
### Example benchmark
1119

1220
In general, you should define a few GC-related settings `-Xms8192M -Xmx8192M -XX:+UseConcMarkSweepGC -verbose:gc -XX:+PrintGCDetails` and keep an eye on GC activity. You can also define `-XX:+PrintCompilation` to see JIT activity.
1321

1422
#### Bulk indexing
1523

16-
Download benchmark data from http://benchmarks.elastic.co/corpora/geonames/documents.json.bz2 and decompress them.
24+
Download benchmark data from http://benchmarks.elasticsearch.org.s3.amazonaws.com/corpora/geonames and decompress them.
1725

18-
Example command line parameters:
26+
Example invocation:
1927

2028
```
21-
rest bulk 192.168.2.2 ./documents.json geonames type 8647880 5000
29+
wget http://benchmarks.elasticsearch.org.s3.amazonaws.com/corpora/geonames/documents-2.json.bz2
30+
bzip2 -d documents-2.json.bz2
31+
mv documents-2.json client/benchmark/build
32+
gradlew -p client/benchmark run --args ' rest bulk localhost build/documents-2.json geonames type 8647880 5000'
2233
```
2334

24-
The parameters are in order:
35+
The parameters are all in the `'`s and are in order:
2536

2637
* Client type: Use either "rest" or "transport"
2738
* Benchmark type: Use either "bulk" or "search"
2839
* Benchmark target host IP (the host where Elasticsearch is running)
2940
* full path to the file that should be bulk indexed
3041
* name of the index
31-
* name of the (sole) type in the index
42+
* name of the (sole) type in the index
3243
* number of documents in the file
3344
* bulk size
3445

3546

36-
#### Bulk indexing
47+
#### Search
3748

38-
Example command line parameters:
49+
Example invocation:
3950

4051
```
41-
rest search 192.168.2.2 geonames "{ \"query\": { \"match_phrase\": { \"name\": \"Sankt Georgen\" } } }\"" 500,1000,1100,1200
52+
gradlew -p client/benchmark run --args ' rest search localhost geonames {"query":{"match_phrase":{"name":"Sankt Georgen"}}} 500,1000,1100,1200'
4253
```
4354

4455
The parameters are in order:
@@ -49,5 +60,3 @@ The parameters are in order:
4960
* name of the index
5061
* a search request body (remember to escape double quotes). The `TransportClientBenchmark` uses `QueryBuilders.wrapperQuery()` internally which automatically adds a root key `query`, so it must not be present in the command line parameter.
5162
* A comma-separated list of target throughput rates
52-
53-

client/benchmark/build.gradle

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@
1818
*/
1919

2020
apply plugin: 'elasticsearch.build'
21-
// build an uberjar with all benchmarks
22-
apply plugin: 'com.github.johnrengelman.shadow'
23-
// have the shadow plugin provide the runShadow task
2421
apply plugin: 'application'
2522

2623
group = 'org.elasticsearch.client'
@@ -32,7 +29,6 @@ build.dependsOn.remove('assemble')
3229
archivesBaseName = 'client-benchmarks'
3330
mainClassName = 'org.elasticsearch.client.benchmark.BenchmarkMain'
3431

35-
3632
// never try to invoke tests on the benchmark project - there aren't any
3733
check.dependsOn.remove(test)
3834
// explicitly override the test task too in case somebody invokes 'gradle test' so it won't trip
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
appender.console.type = Console
22
appender.console.name = console
33
appender.console.layout.type = PatternLayout
4-
appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%m%n
4+
appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c] [%node_name]%marker %m%n
55

66
rootLogger.level = info
77
rootLogger.appenderRef.console.ref = console

0 commit comments

Comments
 (0)