admin: Richer HTML home page with forms for params #19546
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -99,10 +99,26 @@ AdminImpl::AdminImpl(const std::string& profile_path, Server::Instance& server, | |
| MAKE_ADMIN_HANDLER(server_info_handler_.handlerCerts), false, false), | ||
| makeHandler("/clusters", "upstream cluster status", | ||
| MAKE_ADMIN_HANDLER(clusters_handler_.handlerClusters), false, false), | ||
| makeHandler( | ||
| "/config_dump", "dump current Envoy configs (experimental)", | ||
| MAKE_ADMIN_HANDLER(config_dump_handler_.handlerConfigDump), false, false, | ||
| {{Admin::ParamDescriptor::Type::String, "resource", "The resource to dump"}, | ||
|
Contributor
There was a problem hiding this comment. This is missing certain parameters listed on the doc page:
Contributor
Author
There was a problem hiding this comment. I realized that and was thinking of filling in all the new parameters that were added since I first wrote this code as a follow up. However I'm glad you asked about this because this brings a new complexity. I'll get that sorted before asking for the next round of comments. /wait
Contributor
Author
There was a problem hiding this comment. I decided to back out my addition of POST params in this PR and will follow up. I got this working but it was too hacky. I need to make some infrastructural changes to get POST params to work well, and also to handling the "/logging" semantics for an optional enum param. |
||
| {Admin::ParamDescriptor::Type::String, "mask", | ||
| "The mask to apply. When both resource and mask are specified, " | ||
| "the mask is applied to every element in the desired repeated field so that only a " | ||
| "subset of fields are returned. The mask is parsed as a ProtobufWkt::FieldMask"}, | ||
| {Admin::ParamDescriptor::Type::String, "name_regex", | ||
| "Dump only the currently loaded configurations whose names match the specified " | ||
| "regex. Can be used with both resource and mask query parameters."}, | ||
| {Admin::ParamDescriptor::Type::Boolean, "include_eds", | ||
| "Dump currently loaded configuration including EDS. See the response definition " | ||
| "for more information"}}), | ||
| makeHandler("/init_dump", "dump current Envoy init manager information (experimental)", | ||
| MAKE_ADMIN_HANDLER(init_dump_handler_.handlerInitDump), false, false, | ||
| {{Admin::ParamDescriptor::Type::String, "mask", | ||
| "The desired component to dump unready targets. The mask is parsed as " | ||
| "a ProtobufWkt::FieldMask. For example, get the unready targets of " | ||
| "all listeners with /init_dump?mask=listener`"}}), | ||
| makeHandler("/contention", "dump current Envoy mutex contention stats (if enabled)", | ||
| MAKE_ADMIN_HANDLER(stats_handler_.handlerContention), false, false), | ||
| makeHandler("/cpuprofiler", "enable/disable the CPU profiler", | ||
|
|
@@ -118,8 +134,13 @@ AdminImpl::AdminImpl(const std::string& profile_path, Server::Instance& server, | |
| makeHandler("/hot_restart_version", "print the hot restart compatibility version", | ||
| MAKE_ADMIN_HANDLER(server_info_handler_.handlerHotRestartVersion), false, | ||
| false), | ||
|
|
||
| // TODO(jmarantz): add support for param-passing through a POST. Browsers send | ||
| // those params as the post-body rather than query-params and that requires some | ||
| // re-plumbing through the admin callback API. See also drain_listeners. | ||
| makeHandler("/logging", "query/change logging levels", | ||
| MAKE_ADMIN_HANDLER(logs_handler_.handlerLogging), false, true), | ||
|
|
||
| makeHandler("/memory", "print current allocation/heap usage", | ||
| MAKE_ADMIN_HANDLER(server_info_handler_.handlerMemory), false, false), | ||
| makeHandler("/quitquitquit", "exit the server", | ||
|
|
@@ -132,9 +153,16 @@ AdminImpl::AdminImpl(const std::string& profile_path, Server::Instance& server, | |
| MAKE_ADMIN_HANDLER(server_info_handler_.handlerServerInfo), false, false), | ||
| makeHandler("/ready", "print server state, return 200 if LIVE, otherwise return 503", | ||
| MAKE_ADMIN_HANDLER(server_info_handler_.handlerReady), false, false), | ||
| stats_handler_.statsHandler(), | ||
| makeHandler("/stats/prometheus", "print server stats in prometheus format", | ||
| MAKE_ADMIN_HANDLER(stats_handler_.handlerPrometheusStats), false, false, | ||
| {{ParamDescriptor::Type::Boolean, "usedonly", | ||
| "Only include stats that have been written by system since restart"}, | ||
| {ParamDescriptor::Type::Boolean, "text_readouts", | ||
| "Render text_readouts as new gaugues with value 0 (increases Prometheus " | ||
| "data size)"}, | ||
| {ParamDescriptor::Type::String, "filter", | ||
| "Regular expression (ecmascript) for filtering stats"}}), | ||
| makeHandler("/stats/recentlookups", "Show recent stat-name lookups", | ||
| MAKE_ADMIN_HANDLER(stats_handler_.handlerStatsRecentLookups), false, false), | ||
| makeHandler("/stats/recentlookups/clear", "clear list of stat-name lookups and counter", | ||
|
|
@@ -147,18 +175,35 @@ AdminImpl::AdminImpl(const std::string& profile_path, Server::Instance& server, | |
| "/stats/recentlookups/enable", "enable recording of reset stat-name lookup names", | ||
| MAKE_ADMIN_HANDLER(stats_handler_.handlerStatsRecentLookupsEnable), false, true), | ||
| makeHandler("/listeners", "print listener info", | ||
| MAKE_ADMIN_HANDLER(listeners_handler_.handlerListenerInfo), false, false, | ||
| {{Admin::ParamDescriptor::Type::Enum, | ||
| "format", | ||
| "File format to use", | ||
| {"text", "json"}}}), | ||
| makeHandler("/runtime", "print runtime values", | ||
| MAKE_ADMIN_HANDLER(runtime_handler_.handlerRuntime), false, false), | ||
| makeHandler("/runtime_modify", | ||
| "Adds or modifies runtime values as passed in query parameters. To delete a " | ||
| "previously added key, use an empty string as the value. Note that deletion " | ||
| "only applies to overrides added via this endpoint; values loaded from disk " | ||
| "can be modified via override but not deleted. E.g. " | ||
| "?key1=value1&key2=value2...", | ||
| MAKE_ADMIN_HANDLER(runtime_handler_.handlerRuntimeModify), false, true), | ||
| makeHandler("/reopen_logs", "reopen access logs", | ||
| MAKE_ADMIN_HANDLER(logs_handler_.handlerReopenLogs), false, true), | ||
| }, | ||
| date_provider_(server.dispatcher().timeSource()), | ||
| admin_filter_chain_(std::make_shared<AdminFilterChain>()), | ||
| local_reply_(LocalReply::Factory::createDefault()), | ||
| ignore_global_conn_limit_(ignore_global_conn_limit) { | ||
| #ifndef NDEBUG | ||
| // Verify that no duplicate handlers exist. | ||
| absl::flat_hash_set<absl::string_view> handlers; | ||
| for (const UrlHandler& handler : handlers_) { | ||
| ASSERT(handlers.insert(handler.prefix_).second); | ||
| } | ||
| #endif | ||
| } | ||
|
|
||
| Http::ServerConnectionPtr AdminImpl::createCodec(Network::Connection& connection, | ||
| const Buffer::Instance& data, | ||
|
|
@@ -322,6 +367,13 @@ void AdminImpl::getHelp(Buffer::Instance& response) { | |
| // Prefix order is used during searching, but for printing do them in alpha order. | ||
| for (const UrlHandler* handler : sortedHandlers()) { | ||
| response.add(fmt::format(" {}: {}\n", handler->prefix_, handler->help_text_)); | ||
| for (const ParamDescriptor& param : handler->params_) { | ||
| response.add(fmt::format(" {}: {}", param.id_, param.help_)); | ||
| if (param.type_ == ParamDescriptor::Type::Enum) { | ||
| response.addFragments({"; One of (", absl::StrJoin(param.enum_choices_, ", "), ")"}); | ||
| } | ||
| response.add("\n"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -331,12 +383,15 @@ const Network::Address::Instance& AdminImpl::localAddress() { | |
|
|
||
| AdminImpl::UrlHandler AdminImpl::makeHandler(const std::string& prefix, | ||
| const std::string& help_text, HandlerCb callback, | ||
| bool removable, bool mutates_state, | ||
| const ParamDescriptorVec& params) { | ||
| return UrlHandler{prefix, help_text, RequestGasket::makeGen(callback), | ||
| removable, mutates_state, params}; | ||
| } | ||
|
|
||
| bool AdminImpl::addStreamingHandler(const std::string& prefix, const std::string& help_text, | ||
| GenRequestFn callback, bool removable, bool mutates_state, | ||
| const ParamDescriptorVec& params) { | ||
| ASSERT(prefix.size() > 1); | ||
| ASSERT(prefix[0] == '/'); | ||
|
|
||
|
|
@@ -353,16 +408,17 @@ bool AdminImpl::addStreamingHandler(const std::string& prefix, const std::string | |
| auto it = std::find_if(handlers_.cbegin(), handlers_.cend(), | ||
| [&prefix](const UrlHandler& entry) { return prefix == entry.prefix_; }); | ||
| if (it == handlers_.end()) { | ||
| handlers_.push_back({prefix, help_text, callback, removable, mutates_state, params}); | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| bool AdminImpl::addHandler(const std::string& prefix, const std::string& help_text, | ||
| HandlerCb callback, bool removable, bool mutates_state, | ||
| const ParamDescriptorVec& params) { | ||
| return addStreamingHandler(prefix, help_text, RequestGasket::makeGen(callback), removable, | ||
| mutates_state, params); | ||
| } | ||
|
|
||
| bool AdminImpl::removeHandler(const std::string& prefix) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| .home-table { | ||
| font-family: sans-serif; | ||
| font-size: medium; | ||
| border-collapse: collapse; | ||
| border-spacing: 0; | ||
| } | ||
|
|
||
| .home-data { | ||
| text-align: left; | ||
| padding: 4px; | ||
| } | ||
|
|
||
| .home-form { | ||
| margin-bottom: 0; | ||
| } | ||
|
|
||
| .button-as-link { | ||
| background: none!important; | ||
| border: none; | ||
| padding: 0!important; | ||
| font-family: sans-serif; | ||
| font-size: medium; | ||
| color: #069; | ||
| text-decoration: underline; | ||
| cursor: pointer; | ||
| } | ||
|
|
||
| .gray { | ||
| background-color: #dddddd; | ||
| } | ||
|
|
||
| .vert-space { | ||
| height: 4px; | ||
| } | ||
|
|
||
| .option { | ||
| padding-bottom: 4px; | ||
| padding-top: 4px; | ||
| padding-right: 4px; | ||
| padding-left: 20px; | ||
| text-align: right; | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to have an assert in the constructor body that there are no duplicate prefixes in handlers_ ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done.