Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HBASE-23994:Add WebUI to Canary #1292

Merged
merged 6 commits into from
Apr 14, 2020
Merged

HBASE-23994:Add WebUI to Canary #1292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2e1cf6a
HBASE-23994:Add WebUI to Canary
GeorryHuang Mar 16, 2020
b168847
HBASE-23994:Add WebUI to Canary(Modify code)
GeorryHuang Mar 31, 2020
717fb3f
HBASE-23994:Add WebUI to Canary(Map to ConcurrentMap)
GeorryHuang Apr 9, 2020
22658fe
HBASE-23994:Add WebUI to Canary(Checkstyle)
GeorryHuang Apr 10, 2020
102c8e3
HBASE-23994:Add WebUI to Canary(Revise according to comments)
GeorryHuang Apr 10, 2020
d5403ea
HBASE-23994:Add WebUI to Canary(Purge tabs and add assertions to Test…
GeorryHuang Apr 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 156 additions & 0 deletions hbase-server/src/main/jamon/org/apache/hadoop/hbase/tmpl/tool/CanaryStatusTmpl.jamon
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@

<%doc>

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.
</%doc>
<%args>
RegionStdOutSink sink;
</%args>
<%import>
java.util.Map;
java.util.concurrent.atomic.LongAdder;
org.apache.hadoop.hbase.ServerName;
org.apache.hadoop.hbase.tool.CanaryTool.RegionStdOutSink;
</%import>

<!--[if IE]>
<!DOCTYPE html>
<![endif]-->
<?xml version="1.0" encoding="UTF-8" ?>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Canary</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<link href="/static/css/bootstrap.min.css" rel="stylesheet">
<link href="/static/css/bootstrap-theme.min.css" rel="stylesheet">
<link href="/static/css/hbase.css" rel="stylesheet">
</head>

<body>

<div class="navbar navbar-fixed-top navbar-default">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/canary-status"><img src="/static/hbase_logo_small.png" alt="HBase Logo"/></a>
</div>
</div>
</div>

<div class="container">
<section>
<h2>Failed Servers</h2>
<%java>
Map<ServerName, LongAdder> perServerFailuresCount = sink.getPerServerFailuresCount();
</%java>
<table class="table table-striped">
<tr>
<th>Server</th>
<th>Failures Count</th>
</tr>
<%if (perServerFailuresCount != null && perServerFailuresCount.size() > 0)%>
<%for Map.Entry<ServerName, LongAdder> entry : perServerFailuresCount.entrySet() %>
<tr>
<td><& serverNameLink ; serverName = entry.getKey() &></td>
<td><% entry.getValue() %></td>
</tr>
</%for>
</%if>
<tr><td>Total Failed Servers: <% (perServerFailuresCount != null) ? perServerFailuresCount.size() : 0 %></td></tr>
</table>
</section>
<section>
<h2>Failed Tables</h2>
<%java>
Map<String, LongAdder> perTableFailuresCount = sink.getPerTableFailuresCount();
</%java>
<table class="table table-striped">
<tr>
<th>Table</th>
<th>Failures Count</th>
</tr>
<%if (perTableFailuresCount != null && perTableFailuresCount.size() > 0)%>
<%for Map.Entry<String, LongAdder> entry : perTableFailuresCount.entrySet()%>
<tr>
<td><% entry.getKey() %></td>
<td><% entry.getValue() %></td>
</tr>
</%for>
</%if>
<tr><td>Total Failed Tables: <% (perTableFailuresCount != null) ? perTableFailuresCount.size() : 0 %></td></tr>
</table>
</section>

<section>
<h2>Software Attributes</h2>
<table id="attributes_table" class="table table-striped">
<tr>
<th>Attribute Name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>HBase Version</td>
<td><% org.apache.hadoop.hbase.util.VersionInfo.getVersion() %>, r<% org.apache.hadoop.hbase.util.VersionInfo.getRevision() %></td><td>HBase version and revision</td>
</tr>
<tr>
<td>HBase Compiled</td>
<td><% org.apache.hadoop.hbase.util.VersionInfo.getDate() %>, <% org.apache.hadoop.hbase.util.VersionInfo.getUser() %></td>
<td>When HBase version was compiled and by whom</td>
</tr>
<tr>
<td>Hadoop Version</td>
<td><% org.apache.hadoop.util.VersionInfo.getVersion() %>, r<% org.apache.hadoop.util.VersionInfo.getRevision() %></td>
<td>Hadoop version and revision</td>
</tr>
<tr>
<td>Hadoop Compiled</td>
<td><% org.apache.hadoop.util.VersionInfo.getDate() %>, <% org.apache.hadoop.util.VersionInfo.getUser() %></td>
<td>When Hadoop version was compiled and by whom</td>
</tr>
</table>
</section>
</div>
</div> <!-- /container -->

<script src="/static/js/jquery.min.js" type="text/javascript"></script>
<script src="/static/js/bootstrap.min.js" type="text/javascript"></script>
<script src="/static/js/tab.js" type="text/javascript"></script>
</body>
</html>

<%def serverNameLink>
<%args>
ServerName serverName;
</%args>
<%java>
int infoPort = serverName.getPort() + 1;
String url = "//" + serverName.getHostname() + ":" + infoPort + "/";
</%java>

<%if (infoPort > 0) %>
<a href="<% url %>"><% serverName.getServerName() %></a>
<%else>
<% serverName.getServerName() %>
</%if>
</%def>
49 changes: 49 additions & 0 deletions hbase-server/src/main/java/org/apache/hadoop/hbase/tool/CanaryStatusServlet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
*
* 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.
*/
package org.apache.hadoop.hbase.tool;

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.hadoop.hbase.tmpl.tool.CanaryStatusTmpl;
import org.apache.yetus.audience.InterfaceAudience;


@InterfaceAudience.Private
public class CanaryStatusServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
CanaryTool.RegionStdOutSink sink =
(CanaryTool.RegionStdOutSink) getServletContext().getAttribute(
"sink");
if (sink == null) {
throw new ServletException(
"RegionStdOutSink is null! The CanaryTool's InfoServer is not initialized correctly");
}

resp.setContentType("text/html");

CanaryStatusTmpl tmpl = new CanaryStatusTmpl();
tmpl.render(resp.getWriter(), sink);
}

}
78 changes: 76 additions & 2 deletions hbase-server/src/main/java/org/apache/hadoop/hbase/tool/CanaryTool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

import java.io.Closeable;
import java.io.IOException;
import java.net.BindException;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Arrays;
Expand All @@ -39,6 +40,7 @@
import java.util.TreeSet;
import java.util.concurrent.Callable;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
Expand Down Expand Up @@ -81,6 +83,7 @@
import org.apache.hadoop.hbase.client.TableDescriptor;
import org.apache.hadoop.hbase.client.TableDescriptorBuilder;
import org.apache.hadoop.hbase.filter.FirstKeyOnlyFilter;
import org.apache.hadoop.hbase.http.InfoServer;
import org.apache.hadoop.hbase.tool.CanaryTool.RegionTask.TaskType;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;
Expand Down Expand Up @@ -122,6 +125,37 @@
*/
@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.TOOLS)
public class CanaryTool implements Tool, Canary {
public static final String HBASE_CANARY_INFO_PORT = "hbase.canary.info.port";

public static final int DEFAULT_CANARY_INFOPORT = 16050;

public static final String HBASE_CANARY_INFO_BINDADDRESS = "hbase.canary.info.bindAddress";

private InfoServer infoServer;

private void putUpWebUI() throws IOException {
int port = conf.getInt(HBASE_CANARY_INFO_PORT, DEFAULT_CANARY_INFOPORT);
// -1 is for disabling info server
if (port < 0) {
return;
}
if (zookeeperMode) {
LOG.info("WebUI is not supported in Zookeeper mode");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could skip these warnings (and the whole function body) when HBASE_CANARY_INFO_PORT == -1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could skip these warnings (and the whole function body) when HBASE_CANARY_INFO_PORT == -1

will deal with it later

} else if (regionServerMode) {
LOG.info("WebUI is not supported in RegionServer mode");
} else {
String addr = conf.get(HBASE_CANARY_INFO_BINDADDRESS, "0.0.0.0");
try {
infoServer = new InfoServer("canary", addr, port, false, conf);
infoServer.addUnprivilegedServlet("canary", "/canary-status", CanaryStatusServlet.class);
infoServer.setAttribute("sink", this.sink);
infoServer.start();
LOG.info("Bind Canary http info server to {}:{} ", addr, port);
} catch (BindException e) {
LOG.warn("Failed binding Canary http info server to {}:{}", addr, port, e);
}
}
}

@Override
public int checkRegions(String[] targets) throws Exception {
Expand Down Expand Up @@ -273,17 +307,53 @@ public void publishReadTiming(String znode, String server, long msTime) {
public static class RegionStdOutSink extends StdOutSink {
private Map<String, LongAdder> perTableReadLatency = new HashMap<>();
private LongAdder writeLatency = new LongAdder();
private final Map<String, List<RegionTaskResult>> regionMap = new ConcurrentHashMap<>();
private final ConcurrentMap<String, List<RegionTaskResult>> regionMap =
new ConcurrentHashMap<>();
private ConcurrentMap<ServerName, LongAdder> perServerFailuresCount =
new ConcurrentHashMap<>();
private ConcurrentMap<String, LongAdder> perTableFailuresCount = new ConcurrentHashMap<>();

public ConcurrentMap<ServerName, LongAdder> getPerServerFailuresCount() {
return perServerFailuresCount;
}

public ConcurrentMap<String, LongAdder> getPerTableFailuresCount() {
return perTableFailuresCount;
}

public void resetFailuresCountDetails() {
perServerFailuresCount.clear();
perTableFailuresCount.clear();
}

private void incFailuresCountDetails(ServerName serverName, RegionInfo region) {
perServerFailuresCount.compute(serverName, (server, count) -> {
if (count == null) {
count = new LongAdder();
}
count.increment();
return count;
});
perTableFailuresCount.compute(region.getTable().getNameAsString(), (tableName, count) -> {
if (count == null) {
count = new LongAdder();
}
count.increment();
return count;
});
}

public void publishReadFailure(ServerName serverName, RegionInfo region, Exception e) {
incReadFailureCount();
incFailuresCountDetails(serverName, region);
LOG.error("Read from {} on serverName={} failed",
region.getRegionNameAsString(), serverName, e);
}

public void publishReadFailure(ServerName serverName, RegionInfo region,
ColumnFamilyDescriptor column, Exception e) {
incReadFailureCount();
incFailuresCountDetails(serverName, region);
LOG.error("Read from {} on serverName={}, columnFamily={} failed",
region.getRegionNameAsString(), serverName,
column.getNameAsString(), e);
Expand All @@ -304,12 +374,14 @@ public void publishReadTiming(ServerName serverName, RegionInfo region,

public void publishWriteFailure(ServerName serverName, RegionInfo region, Exception e) {
incWriteFailureCount();
incFailuresCountDetails(serverName, region);
LOG.error("Write to {} on {} failed", region.getRegionNameAsString(), serverName, e);
}

public void publishWriteFailure(ServerName serverName, RegionInfo region,
ColumnFamilyDescriptor column, Exception e) {
incWriteFailureCount();
incFailuresCountDetails(serverName, region);
LOG.error("Write to {} on {} {} failed", region.getRegionNameAsString(), serverName,
column.getNameAsString(), e);
}
Expand Down Expand Up @@ -345,7 +417,7 @@ public LongAdder getWriteLatency() {
return this.writeLatency;
}

public Map<String, List<RegionTaskResult>> getRegionMap() {
public ConcurrentMap<String, List<RegionTaskResult>> getRegionMap() {
return this.regionMap;
}

Expand Down Expand Up @@ -908,6 +980,7 @@ public int run(String[] args) throws Exception {
System.arraycopy(args, index, monitorTargets, 0, length);
}

putUpWebUI();
if (zookeeperMode) {
return checkZooKeeper();
} else if (regionServerMode) {
Expand Down Expand Up @@ -1352,6 +1425,7 @@ public void run() {
try {
List<Future<Void>> taskFutures = new LinkedList<>();
RegionStdOutSink regionSink = this.getSink();
regionSink.resetFailuresCountDetails();
if (this.targets != null && this.targets.length > 0) {
String[] tables = generateMonitorTables(this.targets);
// Check to see that each table name passed in the -readTableTimeouts argument is also
Expand Down
20 changes: 20 additions & 0 deletions hbase-server/src/main/resources/hbase-webapps/canary/canary.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<%--
/**
* 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.
*/
--%>
<meta HTTP-EQUIV="REFRESH" content="0;url=/canary-status"/>
Loading