HDDS-1145. Add optional web server to the Ozone freon test tool.

Contributed by Elek, Marton.
This commit is contained in:
Anu Engineer 2019-02-24 15:04:25 -08:00
parent 416b730f34
commit 5c1f946071
7 changed files with 222 additions and 2 deletions

View File

@ -380,6 +380,26 @@ public final class OzoneConfigKeys {
"ozone.fs.isolated-classloader";
public static final String OZONE_FREON_HTTP_ENABLED_KEY =
"ozone.freon.http.enabled";
public static final String OZONE_FREON_HTTP_BIND_HOST_KEY =
"ozone.freon.http-bind-host";
public static final String OZONE_FREON_HTTPS_BIND_HOST_KEY =
"ozone.freon.https-bind-host";
public static final String OZONE_FREON_HTTP_ADDRESS_KEY =
"ozone.freon.http-address";
public static final String OZONE_FREON_HTTPS_ADDRESS_KEY =
"ozone.freon.https-address";
public static final String OZONE_FREON_HTTP_BIND_HOST_DEFAULT = "0.0.0.0";
public static final int OZONE_FREON_HTTP_BIND_PORT_DEFAULT = 9884;
public static final int OZONE_FREON_HTTPS_BIND_PORT_DEFAULT = 9885;
public static final String
OZONE_FREON_HTTP_KERBEROS_PRINCIPAL_KEY =
"ozone.freon.http.kerberos.principal";
public static final String
OZONE_FREON_HTTP_KERBEROS_KEYTAB_FILE_KEY =
"ozone.freon.http.kerberos.keytab";
/**
* There is no need to instantiate this class.

View File

@ -1899,4 +1899,69 @@
the servlet.
</description>
</property>
</configuration>
<property>
<name>ozone.freon.http-address</name>
<value>0.0.0.0:9884</value>
<tag>OZONE, MANAGEMENT</tag>
<description>
The address and the base port where the FREON web ui will listen on.
If the port is 0 then the server will start on a free port.
</description>
</property>
<property>
<name>ozone.freon.http-bind-host</name>
<value>0.0.0.0</value>
<tag>OZONE, MANAGEMENT</tag>
<description>
The actual address the Freon web server will bind to. If this
optional address is set, it overrides only the hostname portion of
ozone.freon.http-address.
</description>
</property>
<property>
<name>ozone.freon.http.enabled</name>
<value>true</value>
<tag>OZONE, MANAGEMENT</tag>
<description>
Property to enable or disable FREON web ui.
</description>
</property>
<property>
<name>ozone.freon.https-address</name>
<value>0.0.0.0:9885</value>
<tag>OZONE, MANAGEMENT</tag>
<description>
The address and the base port where the Freon web server will listen
on using HTTPS.
If the port is 0 then the server will start on a free port.
</description>
</property>
<property>
<name>ozone.freon.https-bind-host</name>
<value>0.0.0.0</value>
<tag>OZONE, MANAGEMENT</tag>
<description>
The actual address the Freon web server will bind to using HTTPS.
If this optional address is set, it overrides only the hostname portion of
ozone.freon.http-address.
</description>
</property>
<property>
<name>ozone.freon.http.kerberos.principal</name>
<value>HTTP/_HOST@EXAMPLE.COM</value>
<tag>SECURITY</tag>
<description>
Security principal used by freon.
</description>
</property>
<property>
<name>ozone.freon.http.kerberos.keytab</name>
<value>/etc/security/keytabs/HTTP.keytab</value>
<tag>SECURITY</tag>
<description>
Keytab used by Freon.
</description>
</property>
</configuration>

View File

@ -45,6 +45,10 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd">
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-ozone-filesystem</artifactId>
</dependency>
<dependency>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-hdds-server-framework</artifactId>
</dependency>
<dependency>
<groupId>org.apache.hadoop</groupId>
<artifactId>hadoop-common</artifactId>

View File

@ -16,11 +16,16 @@
*/
package org.apache.hadoop.ozone.freon;
import java.io.IOException;
import org.apache.hadoop.hdds.cli.GenericCli;
import org.apache.hadoop.hdds.cli.HddsVersionProvider;
import org.apache.hadoop.hdds.tracing.TracingUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
/**
* Ozone data generator and performance test tool.
@ -33,12 +38,43 @@
mixinStandardHelpOptions = true)
public class Freon extends GenericCli {
public static final Logger LOG = LoggerFactory.getLogger(Freon.class);
@Option(names = "--server",
description = "Enable internal http server to provide metric "
+ "and profile endpoint")
private boolean httpServer = false;
private FreonHttpServer freonHttpServer;
@Override
public void execute(String[] argv) {
TracingUtil.initTracing("freon");
super.execute(argv);
}
public void stopHttpServer() {
if (freonHttpServer != null) {
try {
freonHttpServer.stop();
} catch (Exception e) {
LOG.error("Freon http server can't be stopped", e);
}
}
}
public void startHttpServer() {
if (httpServer) {
try {
freonHttpServer = new FreonHttpServer(createOzoneConfiguration());
freonHttpServer.start();
} catch (IOException e) {
LOG.error("Freon http server can't be started", e);
}
}
}
public static void main(String[] args) {
new Freon().run(args);
}

View File

@ -0,0 +1,74 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hadoop.ozone.freon;
import java.io.IOException;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hdds.server.BaseHttpServer;
import org.apache.hadoop.ozone.OzoneConfigKeys;
/**
* Http server to provide metrics + profile endpoint.
*/
public class FreonHttpServer extends BaseHttpServer {
public FreonHttpServer(Configuration conf) throws IOException {
super(conf, "freon");
}
@Override protected String getHttpAddressKey() {
return OzoneConfigKeys.OZONE_FREON_HTTP_ADDRESS_KEY;
}
@Override protected String getHttpBindHostKey() {
return OzoneConfigKeys.OZONE_FREON_HTTP_BIND_HOST_KEY;
}
@Override protected String getHttpsAddressKey() {
return OzoneConfigKeys.OZONE_FREON_HTTPS_ADDRESS_KEY;
}
@Override protected String getHttpsBindHostKey() {
return OzoneConfigKeys.OZONE_FREON_HTTPS_BIND_HOST_KEY;
}
@Override protected String getBindHostDefault() {
return OzoneConfigKeys.OZONE_FREON_HTTP_BIND_HOST_DEFAULT;
}
@Override protected int getHttpBindPortDefault() {
return OzoneConfigKeys.OZONE_FREON_HTTP_BIND_PORT_DEFAULT;
}
@Override protected int getHttpsBindPortDefault() {
return OzoneConfigKeys.OZONE_FREON_HTTPS_BIND_PORT_DEFAULT;
}
@Override protected String getKeytabFile() {
return OzoneConfigKeys.OZONE_FREON_HTTP_KERBEROS_KEYTAB_FILE_KEY;
}
@Override protected String getSpnegoPrincipal() {
return OzoneConfigKeys.OZONE_FREON_HTTP_KERBEROS_PRINCIPAL_KEY;
}
@Override protected String getEnabledKey() {
return OzoneConfigKeys.OZONE_FREON_HTTP_ENABLED_KEY;
}
}

View File

@ -214,6 +214,7 @@ public void init(OzoneConfiguration configuration) throws IOException {
for (FreonOps ops : FreonOps.values()) {
histograms.add(ops.ordinal(), new Histogram(new UniformReservoir()));
}
freon.startHttpServer();
}
@Override
@ -292,7 +293,10 @@ public Void call() throws Exception {
*/
private void addShutdownHook() {
Runtime.getRuntime().addShutdownHook(
new Thread(() -> printStats(System.out)));
new Thread(() -> {
printStats(System.out);
freon.stopHttpServer();
}));
}
/**
* Prints stats of {@link Freon} run to the PrintStream.

View File

@ -0,0 +1,17 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#