Skip to content

Add ability for stats over http to run as a remap plugin #12316

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

Closed
ezelkow1 wants to merge 2 commits into from
Closed

Add ability for stats over http to run as a remap plugin #12316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ae6e11
Tested as global and remap, with path as param as well as
ezelkow1 Jun 24, 2025
33361fe
Add docs for remap usage
ezelkow1 Jun 27, 2025
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
4 changes: 4 additions & 0 deletions doc/admin-guide/plugins/stats_over_http.en.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ default URL::

where host and port is the hostname/IP and port number of the server.

This plugin can also run as a remap plugin with an optional stats over http config file as a parameter::

map / http://target @plugin=stats_over_http.so @pparam=config.file
Copy link
Copy Markdown
Contributor

@zwoop zwoop Jul 1, 2025

Choose a reason for hiding this comment

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

Nitpicky, but this seems like a dangerous example :). Shouldn't we use a more specific path here, like

map /_stats_over_http ...

or maybe even more specific (since the above captures the path for all hosts)?

Also, maybe mention that the "target" doesn't imply / mean anything, and can be whatever ?


Much like the global version this pparam can also be the path to be used on the remap in order to get the stats

Plugin Options
==============
Expand Down
61 changes: 57 additions & 4 deletions plugins/stats_over_http/stats_over_http.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
#include <zlib.h>

#include <ts/remap.h>
#include <ts/remap_version.h>
Copy link
Copy Markdown
Contributor

@zwoop zwoop Jul 1, 2025

Choose a reason for hiding this comment

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

Separate issue, but seeing this, makes me thing we ought to add the define from this file into ts/remap.h.

#include "swoc/TextView.h"
#include "tscore/ink_config.h"
#include <tsutil/ts_ip.h>
Expand Down Expand Up @@ -653,7 +654,7 @@ stats_dostuff(TSCont contp, TSEvent event, void *edata)
}

static int
stats_origin(TSCont contp, TSEvent /* event ATS_UNUSED */, void *edata)
stats_origin(config_t *this_config, TSEvent /* event ATS_UNUSED */, void *edata, bool is_remap)
{
TSCont icontp;
stats_state *my_state;
Expand All @@ -670,7 +671,7 @@ stats_origin(TSCont contp, TSEvent /* event ATS_UNUSED */, void *edata)
bool path_had_explicit_format = false;

Dbg(dbg_ctl, "in the read stuff");
config = get_config(contp);
config = this_config;

if (TSHttpTxnClientReqGet(txnp, &reqp, &hdr_loc) != TS_SUCCESS) {
goto cleanup;
Expand Down Expand Up @@ -783,6 +784,7 @@ stats_origin(TSCont contp, TSEvent /* event ATS_UNUSED */, void *edata)

TSContDataSet(icontp, my_state);
TSHttpTxnIntercept(icontp, txnp);

goto cleanup;

notforme:
Expand All @@ -800,10 +802,54 @@ stats_origin(TSCont contp, TSEvent /* event ATS_UNUSED */, void *edata)
if (accept_encoding_field) {
TSHandleMLocRelease(reqp, TS_NULL_MLOC, accept_encoding_field);
}
TSHttpTxnReenable(txnp, reenable);
if (!is_remap) {
TSHttpTxnReenable(txnp, reenable);
}

return 0;
}

static int
stats_origin_global_wrapper(TSCont contp, TSEvent, void *edata)
{
config_t *config = get_config(contp);
return stats_origin(config, TS_EVENT_NONE, edata, false);
}

TSReturnCode
TSRemapInit(TSRemapInterface *api_info, char *errbuf, int errbuf_size)
{
CHECK_REMAP_API_COMPATIBILITY(api_info, errbuf, errbuf_size);
return TS_SUCCESS;
}

TSReturnCode
TSRemapNewInstance(int argc, char *argv[], void **instance, char * /* errBuf ATS_UNUSED */, int /* errBufSize ATS_UNUSED */)
{
config_holder_t *config_holder;
config_holder = new_config_holder(argc > 1 ? argv[2] : nullptr);
*instance = static_cast<void *>(config_holder);
/* Path was not set during load, so the param was not a config file, we also
have an argument so it must be the path, set it here. Otherwise if no argument
then use the default _stats path */
if ((config_holder->config != nullptr) && (config_holder->config->stats_path.empty()) && (argc > 1) &&
(config_holder->config_path == nullptr)) {
config_holder->config->stats_path = argv[2] + ('/' == argv[2][0] ? 1 : 0);
} else if ((config_holder->config != nullptr) && (config_holder->config->stats_path.empty())) {
config_holder->config->stats_path = DEFAULT_URL_PATH;
Copy link
Copy Markdown
Contributor

@zwoop zwoop Jul 1, 2025

Choose a reason for hiding this comment

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

Maybe I'm not reading this right, but shouldn't the default path here be the "from_url" path in the RRI (the remap.config "from URL") ?

It kinda feels weird that you can override the path with the pparam or config file. What would happen if I do

map http://localhost/_stats_over_http http://default @plugin=stats_over_http.so @pparam=/bar

How could that ever match on the path now ?

}
return TS_SUCCESS;
}

TSRemapStatus
TSRemapDoRemap(void *id, TSHttpTxn rh, TSRemapRequestInfo * /* ATS_UNUSED */)
Copy link
Copy Markdown
Contributor

@zwoop zwoop Jul 1, 2025

Choose a reason for hiding this comment

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

Why id ? Typically we call this ih

{
config_holder_t *configh = static_cast<config_holder_t *>(id);
stats_origin(configh->config, TS_EVENT_NONE, rh, true);

return TSREMAP_NO_REMAP;
}

void
TSPluginInit(int argc, const char *argv[])
{
Expand Down Expand Up @@ -860,7 +906,7 @@ TSPluginInit(int argc, const char *argv[])

/* Create a continuation with a mutex as there is a shared global structure
containing the headers to add */
main_cont = TSContCreate(stats_origin, nullptr);
main_cont = TSContCreate(stats_origin_global_wrapper, nullptr);
TSContDataSet(main_cont, (void *)config_holder);
TSHttpHookAdd(TS_HTTP_READ_REQUEST_HDR_HOOK, main_cont);

Expand Down Expand Up @@ -971,6 +1017,13 @@ delete_config(config_t *config)
TSfree(config);
}

void
TSRemapDeleteInstance(void *ih)
{
config_holder_t *configh = static_cast<config_holder_t *>(ih);
delete_config(configh->config);
}

// standard api below...
static config_t *
get_config(TSCont cont)
Expand Down