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.

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

Make admin interfaces streamable #474

Merged
merged 2 commits into from
Oct 10, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@
import com.hotels.styx.routing.RoutingObjectRecord;
import com.hotels.styx.routing.config.RoutingObjectFactory;
import com.hotels.styx.routing.db.StyxObjectStore;
import com.hotels.styx.server.AdminHttpRouter;
import com.hotels.styx.server.HttpServer;
import com.hotels.styx.server.StandardHttpRouter;
import com.hotels.styx.server.handlers.ClassPathResourceHandler;
import com.hotels.styx.server.netty.NettyServerBuilderSpec;
import com.hotels.styx.server.netty.WebServerConnectorFactory;
Expand Down Expand Up @@ -114,42 +114,42 @@ public HttpServer build() {

return new NettyServerBuilderSpec("Admin", environment.serverEnvironment(), new WebServerConnectorFactory())
.toNettyServerBuilder(adminServerConfig)
.handlerFactory(() -> new HttpAggregator(adminEndpoints(styxConfig, startupConfig)))
.handlerFactory(() -> adminEndpoints(styxConfig, startupConfig))
.build();
}

private WebServiceHandler adminEndpoints(StyxConfig styxConfig, StartupConfig startupConfig) {
private HttpHandler adminEndpoints(StyxConfig styxConfig, StartupConfig startupConfig) {
Optional<Duration> metricsCacheExpiration = styxConfig.adminServerConfig().metricsCacheExpiration();

StandardHttpRouter httpRouter = new StandardHttpRouter();
httpRouter.add("/", new IndexHandler(indexLinkPaths()));
httpRouter.add("/version.txt", new VersionTextHandler(styxConfig.versionFiles(startupConfig)));
httpRouter.add("/admin", new IndexHandler(indexLinkPaths()));
httpRouter.add("/admin/ping", new PingHandler());
httpRouter.add("/admin/threads", new ThreadsHandler());
httpRouter.add("/admin/current_requests", new CurrentRequestsHandler(CurrentRequestTracker.INSTANCE));
AdminHttpRouter httpRouter = new AdminHttpRouter();
httpRouter.aggregate("/", new IndexHandler(indexLinkPaths()));
httpRouter.aggregate("/version.txt", new VersionTextHandler(styxConfig.versionFiles(startupConfig)));
httpRouter.aggregate("/admin", new IndexHandler(indexLinkPaths()));
httpRouter.aggregate("/admin/ping", new PingHandler());
httpRouter.aggregate("/admin/threads", new ThreadsHandler());
httpRouter.aggregate("/admin/current_requests", new CurrentRequestsHandler(CurrentRequestTracker.INSTANCE));
MetricsHandler metricsHandler = new MetricsHandler(environment.metricRegistry(), metricsCacheExpiration);
httpRouter.add("/admin/metrics", metricsHandler);
httpRouter.add("/admin/metrics/", metricsHandler);
httpRouter.add("/admin/configuration", new StyxConfigurationHandler(configuration));
httpRouter.add("/admin/configuration/origins", new OriginsHandler(backendServicesRegistry));
httpRouter.add("/admin/jvm", new JVMMetricsHandler(environment.metricRegistry(), metricsCacheExpiration));
httpRouter.add("/admin/origins/status", new OriginsInventoryHandler(environment.eventBus()));
httpRouter.add("/admin/configuration/logging", new LoggingConfigurationHandler(startupConfig.logConfigLocation()));
httpRouter.add("/admin/configuration/startup", new StartupConfigHandler(startupConfig));
httpRouter.aggregate("/admin/metrics", metricsHandler);
httpRouter.aggregate("/admin/metrics/", metricsHandler);
httpRouter.aggregate("/admin/configuration", new StyxConfigurationHandler(configuration));
httpRouter.aggregate("/admin/configuration/origins", new OriginsHandler(backendServicesRegistry));
httpRouter.aggregate("/admin/jvm", new JVMMetricsHandler(environment.metricRegistry(), metricsCacheExpiration));
httpRouter.aggregate("/admin/origins/status", new OriginsInventoryHandler(environment.eventBus()));
httpRouter.aggregate("/admin/configuration/logging", new LoggingConfigurationHandler(startupConfig.logConfigLocation()));
httpRouter.aggregate("/admin/configuration/startup", new StartupConfigHandler(startupConfig));

RoutingObjectHandler routingObjectHandler = new RoutingObjectHandler(routeDatabase, routingObjectFactoryContext);
httpRouter.add("/admin/routing", routingObjectHandler);
httpRouter.add("/admin/routing/", routingObjectHandler);
httpRouter.aggregate("/admin/routing", routingObjectHandler);
httpRouter.aggregate("/admin/routing/", routingObjectHandler);

// Dashboard
httpRouter.add("/admin/dashboard/data.json", dashboardDataHandler(styxConfig));
httpRouter.add("/admin/dashboard/", new ClassPathResourceHandler("/admin/dashboard/"));
httpRouter.aggregate("/admin/dashboard/data.json", dashboardDataHandler(styxConfig));
httpRouter.aggregate("/admin/dashboard/", new ClassPathResourceHandler("/admin/dashboard/"));

// Tasks
httpRouter.add("/admin/tasks/origins/reload", new HttpMethodFilteringHandler(POST, new OriginsReloadCommandHandler(backendServicesRegistry)));
httpRouter.add("/admin/tasks/origins", new HttpMethodFilteringHandler(POST, new OriginsCommandHandler(environment.eventBus())));
httpRouter.add("/admin/tasks/plugin/", new PluginToggleHandler(environment.configStore()));
httpRouter.aggregate("/admin/tasks/origins/reload", new HttpMethodFilteringHandler(POST, new OriginsReloadCommandHandler(backendServicesRegistry)));
httpRouter.aggregate("/admin/tasks/origins", new HttpMethodFilteringHandler(POST, new OriginsCommandHandler(environment.eventBus())));
httpRouter.aggregate("/admin/tasks/plugin/", new PluginToggleHandler(environment.configStore()));

// Plugins Handler

Expand All @@ -158,10 +158,10 @@ private WebServiceHandler adminEndpoints(StyxConfig styxConfig, StartupConfig st
NamedPlugin namedPlugin = entry.value();

routesForPlugin(namedPlugin).forEach(route ->
httpRouter.add(route.path(), route.handler()));
httpRouter.stream(route.path(), route.handler()));
});

httpRouter.add("/admin/plugins", new PluginListHandler(environment.configStore()));
httpRouter.aggregate("/admin/plugins", new PluginListHandler(environment.configStore()));
return httpRouter;
}

Expand Down Expand Up @@ -199,7 +199,7 @@ private static List<Route> routesForPlugin(NamedPlugin namedPlugin) {
? new StaticBodyHttpHandler(HTML_UTF_8, format("This plugin (%s) does not expose any admin interfaces", namedPlugin.name()))
: new IndexHandler(endpointLinks);

Route indexRoute = new Route(pluginPath(namedPlugin), handler);
Route indexRoute = new Route(pluginPath(namedPlugin), new HttpAggregator(MEGABYTE, handler));

return concatenate(indexRoute, routes);
}
Expand All @@ -219,7 +219,7 @@ private static List<PluginAdminEndpointRoute> pluginAdminEndpointRoutes(NamedPlu
Map<String, HttpHandler> adminInterfaceHandlers = namedPlugin.adminInterfaceHandlers();

return mapToList(adminInterfaceHandlers, (relativePath, handler) ->
new PluginAdminEndpointRoute(namedPlugin, relativePath, new HttpStreamer(MEGABYTE, handler)));
new PluginAdminEndpointRoute(namedPlugin, relativePath, handler));
}

// allows key and value to be labelled in lambda instead of having to use Entry.getKey, Entry.getValue
Expand All @@ -231,9 +231,9 @@ private static <K, V, T> List<T> mapToList(Map<K, V> map, BiFunction<K, V, T> fu

private static class Route {
private final String path;
private final WebServiceHandler handler;
private final HttpHandler handler;

Route(String path, WebServiceHandler handler) {
Route(String path, HttpHandler handler) {
this.path = path;
this.handler = handler;
}
Expand All @@ -242,15 +242,15 @@ String path() {
return path;
}

WebServiceHandler handler() {
HttpHandler handler() {
return handler;
}
}

private static class PluginAdminEndpointRoute extends Route {
private final NamedPlugin namedPlugin;

PluginAdminEndpointRoute(NamedPlugin namedPlugin, String relativePath, WebServiceHandler handler) {
PluginAdminEndpointRoute(NamedPlugin namedPlugin, String relativePath, HttpHandler handler) {
super(pluginAdminEndpointPath(namedPlugin, relativePath), handler);

this.namedPlugin = namedPlugin;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
Copyright (C) 2013-2019 Expedia Inc.

Licensed 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 com.hotels.styx.server;

import com.hotels.styx.api.Eventual;
import com.hotels.styx.api.HttpHandler;
import com.hotels.styx.api.HttpInterceptor;
import com.hotels.styx.api.LiveHttpRequest;
import com.hotels.styx.api.LiveHttpResponse;
import com.hotels.styx.api.WebServiceHandler;
import com.hotels.styx.common.http.handler.HttpAggregator;

import static com.hotels.styx.api.HttpResponse.response;
import static com.hotels.styx.api.HttpResponseStatus.NOT_FOUND;

/**
* Simple Http Router.
*/
public class AdminHttpRouter implements HttpHandler {
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @taer Thank you for doing this! Very useful. But one comment.

Please move this class to styx-proxy module. This class is called AdminHttpRouter, and you are adding it to the styx-server module which doesn't have an admin interface. The admin interface is in the styx-proxy. Therefore it should live in the proxy module. But otherwise it good to go :-D.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done. I think the test failure is a timeout based test

private static final int MEGABYTE = 1024 * 1024;
private static final HttpHandler NOT_FOUND_HANDLER = (request, context) -> Eventual.of(response(NOT_FOUND).build().stream());

private final PathTrie<HttpHandler> routes = new PathTrie<>();

@Override
public Eventual<LiveHttpResponse> handle(LiveHttpRequest request, HttpInterceptor.Context context) {
return routes.get(request.path())
.orElse(NOT_FOUND_HANDLER)
.handle(request, context);
}

public AdminHttpRouter aggregate(String path, WebServiceHandler httpHandler) {
routes.put(path, new HttpAggregator(MEGABYTE, httpHandler));
return this;
}

public AdminHttpRouter stream(String path, HttpHandler httpHandler) {
routes.put(path, httpHandler);
return this;
}
}