HBASE-27811 Enable cache control for logs endpoint and set max age as 0 (#5204)

This commit is contained in:
Yash Dodeja 2023-05-25 12:58:16 +05:30 committed by GitHub
parent d7b2fb463e
commit ea3a44ea2d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 41 additions and 5 deletions

View File

@ -56,6 +56,7 @@ import org.apache.hadoop.hbase.http.conf.ConfServlet;
import org.apache.hadoop.hbase.http.log.LogLevel;
import org.apache.hadoop.hbase.util.ReflectionUtils;
import org.apache.hadoop.hbase.util.Threads;
import org.apache.hadoop.security.AuthenticationFilterInitializer;
import org.apache.hadoop.security.SecurityUtil;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.security.authentication.server.AuthenticationFilter;
@ -143,6 +144,7 @@ public class HttpServer implements FilterContainer {
HTTP_SPNEGO_AUTHENTICATION_PREFIX + "admin.groups";
public static final String HTTP_PRIVILEGED_CONF_KEY =
"hbase.security.authentication.ui.config.protected";
public static final String HTTP_UI_NO_CACHE_ENABLE_KEY = "hbase.http.filter.no-store.enable";
public static final boolean HTTP_PRIVILEGED_CONF_DEFAULT = false;
// The ServletContext attribute where the daemon Configuration
@ -679,7 +681,7 @@ public class HttpServer implements FilterContainer {
ctx.getServletContext().setAttribute(org.apache.hadoop.http.HttpServer2.CONF_CONTEXT_ATTRIBUTE,
conf);
ctx.getServletContext().setAttribute(ADMINS_ACL, adminsAcl);
addNoCacheFilter(ctx);
addNoCacheFilter(ctx, conf);
return ctx;
}
@ -701,9 +703,16 @@ public class HttpServer implements FilterContainer {
return gzipHandler;
}
private static void addNoCacheFilter(WebAppContext ctxt) {
defineFilter(ctxt, NO_CACHE_FILTER, NoCacheFilter.class.getName(),
Collections.<String, String> emptyMap(), new String[] { "/*" });
private static void addNoCacheFilter(ServletContextHandler ctxt, Configuration conf) {
if (conf.getBoolean(HTTP_UI_NO_CACHE_ENABLE_KEY, false)) {
Map<String, String> filterConfig =
AuthenticationFilterInitializer.getFilterConfigMap(conf, "hbase.http.filter.");
defineFilter(ctxt, NO_CACHE_FILTER, NoCacheFilter.class.getName(), filterConfig,
new String[] { "/*" });
} else {
defineFilter(ctxt, NO_CACHE_FILTER, NoCacheFilter.class.getName(),
Collections.<String, String> emptyMap(), new String[] { "/*" });
}
}
/** Get an array of FilterConfiguration specified in the conf */
@ -749,6 +758,7 @@ public class HttpServer implements FilterContainer {
}
logContext.setDisplayName("logs");
setContextAttributes(logContext, conf);
addNoCacheFilter(logContext, conf);
defaultContexts.put(logContext, true);
}
// set up the context for "/static/*"

View File

@ -31,15 +31,28 @@ import org.apache.yetus.audience.InterfaceAudience;
@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.CONFIG)
public class NoCacheFilter implements Filter {
/**
* Constant for the configuration property that indicates no-store cache control is enabled.
*/
public static final String NO_STORE = "no-store.enable";
private boolean noStoreEnabled = false;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
this.noStoreEnabled = Boolean.valueOf(filterConfig.getInitParameter(NO_STORE));
}
@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
throws IOException, ServletException {
HttpServletResponse httpRes = (HttpServletResponse) res;
httpRes.setHeader("Cache-Control", "no-cache");
StringBuilder header = new StringBuilder("no-cache");
if (noStoreEnabled) {
header.append(", no-store, max-age=0");
}
httpRes.setHeader("Cache-Control", header.toString());
long now = EnvironmentEdgeManager.currentTime();
httpRes.addDateHeader("Expires", now);
httpRes.addDateHeader("Date", now);

View File

@ -71,6 +71,19 @@ See Nick Dimiduk's contribution on this link:http://stackoverflow.com/questions/
If you know how to fix this without opening a second port for HTTPS, patches are appreciated.
====
[[hbase.ui.cache]]
=== Disable cache in HBase UI
Set the following configuration in hbase-site to set max age to zero and disable cache for the web UI:
[source,xml]
----
<property>
<name>hbase.http.filter.no-store.enable</name>
<value>true</value>
</property>
----
[[hbase.secure.spnego.ui]]
=== Using SPNEGO for Kerberos authentication with Web UIs