1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.application.command;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.stream.Collectors;
import org.sonar.process.Props;
public class EsJvmOptions extends JvmOptions<EsJvmOptions> {
private static final String ELASTICSEARCH_JVM_OPTIONS_HEADER = """
# This file has been automatically generated by SonarQube during startup.
# Please use sonar.search.javaOpts and/or sonar.search.javaAdditionalOpts in sonar.properties to specify jvm options for Elasticsearch
# DO NOT EDIT THIS FILE
""";
public EsJvmOptions(Props props, File tmpDir) {
super(mandatoryOptions(tmpDir, props));
}
// this basically writes down the content of jvm.options file distributed in vanilla Elasticsearch package
// with some changes to fit running bundled in SQ
private static Map<String, String> mandatoryOptions(File tmpDir, Props props) {
Map<String, String> res = new LinkedHashMap<>(30);
fromJvmDotOptionsFile(tmpDir, res, props);
fromSystemJvmOptionsClass(tmpDir, res);
boolean defaultDisableBootstrapChecks = props.value("sonar.jdbc.url", "").contains("jdbc:h2");
if (!props.valueAsBoolean("sonar.es.bootstrap.checks.disable", defaultDisableBootstrapChecks)) {
res.put("-Des.enforce.bootstrap.checks=", "true");
}
return res;
}
private static void fromJvmDotOptionsFile(File tmpDir, Map<String, String> res, Props props) {
// GC configuration
res.put("-XX:+UseG1GC", "");
// (by default ES 6.6.1 uses variable ${ES_TMPDIR} which is replaced by start scripts. Since we start JAR file
// directly on windows, we specify absolute file as URL (to support space in path) instead
res.put("-Djava.io.tmpdir=", tmpDir.getAbsolutePath());
// heap dumps (enable by default in ES 6.6.1, we don't enable them, no one will analyze them anyway)
// generate a heap dump when an allocation from the Java heap fails
// heap dumps are created in the working directory of the JVM
// res.put("-XX:+HeapDumpOnOutOfMemoryError", "");
// specify an alternative path for heap dumps; ensure the directory exists and
// has sufficient space
// res.put("-XX:HeapDumpPath", "data");
// specify an alternative path for JVM fatal error logs (ES 6.6.1 default is "logs/hs_err_pid%p.log")
var path = Paths.get(props.value("sonar.path.logs", "logs"), "es_hs_err_pid%p.log");
res.put("-XX:ErrorFile=", path.toAbsolutePath().toString());
res.put("-Xlog:disable", "");
}
/**
* JVM options from class "org.elasticsearch.tools.launchers.SystemJvmOptions"
*/
private static void fromSystemJvmOptionsClass(File tmpDir, Map<String, String> res) {
/*
* Cache ttl in seconds for positive DNS lookups noting that this overrides the JDK security property networkaddress.cache.ttl;
* can be set to -1 to cache forever.
*/
res.put("-Des.networkaddress.cache.ttl=", "60");
/*
* Cache ttl in seconds for negative DNS lookups noting that this overrides the JDK security property
* networkaddress.cache.negative ttl; set to -1 to cache forever.
*/
res.put("-Des.networkaddress.cache.negative.ttl=", "10");
// pre-touch JVM emory pages during initialization
res.put("-XX:+AlwaysPreTouch", "");
// explicitly set the stack size
res.put("-Xss1m", "");
// set to headless, just in case,
res.put("-Djava.awt.headless=", "true");
// ensure UTF-8 encoding by default (e.g., filenames)
res.put("-Dfile.encoding=", "UTF-8");
// use our provided JNA always versus the system one
res.put("-Djna.nosys=", "true");
res.put("-Djna.tmpdir=", tmpDir.getAbsolutePath());
/*
* Turn off a JDK optimization that throws away stack traces for common exceptions because stack traces are important for
* debugging.
*/
res.put("-XX:-OmitStackTraceInFastThrow", "");
// flags to configure Netty
res.put("-Dio.netty.noUnsafe=", "true");
res.put("-Dio.netty.noKeySetOptimization=", "true");
res.put("-Dio.netty.recycler.maxCapacityPerThread=", "0");
res.put("-Dio.netty.allocator.numDirectArenas=", "0");
// log4j 2
res.put("-Dlog4j.shutdownHookEnabled=", "false");
res.put("-Dlog4j2.disable.jmx=", "true");
res.put("-Dlog4j2.formatMsgNoLookups=", "true");
/*
* Due to internationalization enhancements in JDK 9 org.sonarqube.ws.tester.Elasticsearch need to set the provider to COMPAT otherwise
* time/date
* parsing will break in an incompatible way for some date patterns and locales.
*/
res.put("-Djava.locale.providers=", "COMPAT");
}
public void writeToJvmOptionFile(File file) {
String jvmOptions = getAll().stream().collect(Collectors.joining("\n"));
String jvmOptionsContent = ELASTICSEARCH_JVM_OPTIONS_HEADER + jvmOptions;
try {
Files.write(file.toPath(), jvmOptionsContent.getBytes(StandardCharsets.UTF_8));
} catch (IOException e) {
throw new IllegalStateException("Cannot write Elasticsearch jvm options file", e);
}
}
}
|
