hcq/MaxScale
hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MXS-1220: Add back the old diagnostic entry point

Browse Source 
This makes 2.2 maxadmin backwards compatible with 2.1.
This commit is contained in:
Markus Mäkelä 2017-04-21 12:13:08 +03:00 committed by Markus Mäkelä
parent bab7957952
commit dd68069471
15 changed files with 181 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
examples/roundrobinrouter.cpp
View File

@ -572,7 +572,8 @@ static MXS_ROUTER_SESSION* newSession(MXS_ROUTER* instance, MXS_SESSION* session
static void closeSession(MXS_ROUTER* instance, MXS_ROUTER_SESSION* session);
static void freeSession(MXS_ROUTER* instance, MXS_ROUTER_SESSION* session);
static int routeQuery(MXS_ROUTER* instance, MXS_ROUTER_SESSION* session, GWBUF* querybuf);
static json_t* diagnostics(const MXS_ROUTER* instance);
static void diagnostics(MXS_ROUTER* instance, DCB* dcb);
static json_t* diagnostics_json(const MXS_ROUTER* instance);
static void clientReply(MXS_ROUTER* instance, MXS_ROUTER_SESSION* router_session,
GWBUF* resultbuf, DCB* backend_dcb);
static void handleError(MXS_ROUTER* instance, MXS_ROUTER_SESSION* router_session,
@ -600,6 +601,7 @@ MXS_MODULE* MXS_CREATE_MODULE()
freeSession,
routeQuery,
diagnostics,
diagnostics_json,
clientReply,
handleError,
getCapabilities,
@ -759,7 +761,24 @@ static int routeQuery(MXS_ROUTER* instance, MXS_ROUTER_SESSION* session, GWBUF*
* @param instance The router instance
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostics(const MXS_ROUTER* instance)
static void diagnostics(MXS_ROUTER* instance, DCB* dcb)
{
RRRouter* router = static_cast<RRRouter*>(instance);
dcb_printf(dcb, "\t\tQueries routed successfully: %lu\n", router->m_routing_s);
dcb_printf(dcb, "\t\tFailed routing attempts: %lu\n", router->m_routing_f);
dcb_printf(dcb, "\t\tClient replies routed: %lu\n", router->m_routing_c);
}
/**
* @brief Diagnostics routine (API)
*
* Print router statistics to the DCB passed in. This is usually called by the
* MaxInfo or MaxAdmin modules.
*
* @param instance The router instance
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostics_json(const MXS_ROUTER* instance)
{
const RRRouter* router = static_cast<const RRRouter*>(instance);
json_t* rval = json_object();

31
examples/testfilter.c
View File

@ -35,7 +35,8 @@ static void closeSession(MXS_FILTER *instance, MXS_FILTER_SESSION *session);
static void freeSession(MXS_FILTER *instance, MXS_FILTER_SESSION *session);
static void setDownstream(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, MXS_DOWNSTREAM *downstream);
static int routeQuery(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, GWBUF *queue);
static json_t* diagnostic(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession);
static void diagnostic(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, DCB *dcb);
static json_t* diagnostic_json(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession);
static uint64_t getCapabilities(MXS_FILTER* instance);
static void destroyInstance(MXS_FILTER *instance);
@ -78,6 +79,7 @@ MXS_MODULE* MXS_CREATE_MODULE()
routeQuery,
NULL, // No clientReply
diagnostic,
diagnostic_json,
getCapabilities,
destroyInstance,
};
@ -221,7 +223,32 @@ routeQuery(MXS_FILTER *instance, MXS_FILTER_SESSION *session, GWBUF *queue)
* @param fsession Filter session, may be NULL
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostic(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession)
static void
diagnostic(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, DCB *dcb)
{
TEST_INSTANCE *my_instance = (TEST_INSTANCE *)instance;
TEST_SESSION *my_session = (TEST_SESSION *)fsession;
if (my_session)
dcb_printf(dcb, "\t\tNo. of queries routed by filter: %d\n",
my_session->count);
else
dcb_printf(dcb, "\t\tNo. of sessions created: %d\n",
my_instance->sessions);
}
/**
* Diagnostics routine
*
* If fsession is NULL then print diagnostics on the filter
* instance as a whole, otherwise print diagnostics for the
* particular session.
*
* @param instance The filter instance
* @param fsession Filter session, may be NULL
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostic_json(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession)
{
return NULL;
}

17
examples/testroute.c
View File

@ -21,7 +21,8 @@ static void closeSession(MXS_ROUTER *instance, MXS_ROUTER_SESSION *session);
static void freeSession(MXS_ROUTER *instance, MXS_ROUTER_SESSION *session);
static int routeQuery(MXS_ROUTER *instance, MXS_ROUTER_SESSION *session, GWBUF *queue);
static void clientReply(MXS_ROUTER *instance, MXS_ROUTER_SESSION *session, GWBUF *queue, DCB*);
static json_t* diagnostic(const MXS_ROUTER *instance);
static void diagnostic(MXS_ROUTER *instance, DCB *dcb);
static json_t* diagnostic_json(const MXS_ROUTER *instance);
static uint64_t getCapabilities(MXS_ROUTER* instance);
static void handleError(MXS_ROUTER *instance,
MXS_ROUTER_SESSION *router_session,
@ -56,6 +57,7 @@ MXS_MODULE* MXS_CREATE_MODULE()
freeSession,
routeQuery,
diagnostic,
diagnostic_json,
clientReply,
handleError,
getCapabilities,
@ -145,7 +147,18 @@ void clientReply(MXS_ROUTER* instance, MXS_ROUTER_SESSION* session, GWBUF* queue
* @param instance The router instance
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostic(const MXS_ROUTER *instance)
static void
diagnostic(MXS_ROUTER *instance, DCB *dcb)
{
}
/**
* Diagnostics routine
*
* @param instance The router instance
* @param dcb The DCB for diagnostic output
*/
static json_t* diagnostic_json(const MXS_ROUTER *instance)
{
return NULL;
}

3
include/maxscale/authenticator.h
View File

@ -82,6 +82,7 @@ typedef struct mxs_authenticator
void (*free)(struct dcb *);
void (*destroy)(void *);
int (*loadusers)(struct servlistener *);
void (*diagnostic)(struct dcb*, struct servlistener *);
/**
* @brief Return diagnostic information about the authenticator
@ -95,7 +96,7 @@ typedef struct mxs_authenticator
*
* @see jansson.h
*/
json_t* (*diagnostic)(const struct servlistener *listener);
json_t* (*diagnostic_json)(const struct servlistener *listener);
/** This entry point was added to avoid calling authenticator functions
* directly when a COM_CHANGE_USER command is executed. */

11
include/maxscale/filter.h
View File

@ -170,6 +170,15 @@ typedef struct mxs_filter_object
*/
int32_t (*clientReply)(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, GWBUF *queue);
/**
* @brief Called for diagnostic output
*
* @param instance Filter instance
* @param fsession Filter session, NULL if general information about the filter is queried
* @param dcb DCB where the diagnostic information should be written
*/
void (*diagnostics)(MXS_FILTER *instance, MXS_FILTER_SESSION *fsession, DCB *dcb);
/**
* @brief Called for diagnostic output
*
@ -180,7 +189,7 @@ typedef struct mxs_filter_object
*
* @see jansson.h
*/
json_t* (*diagnostics)(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession);
json_t* (*diagnostics_json)(const MXS_FILTER *instance, const MXS_FILTER_SESSION *fsession);
/**
* @brief Called to obtain the capabilities of the filter

32
include/maxscale/filter.hh
View File

@ -144,8 +144,15 @@ public:
/**
* Called for obtaining diagnostics about the filter session.
*
* @param pDcb The dcb where the diagnostics should be written.
*/
json_t* diagnostics() const;
void diagnostics(DCB *pDcb);
/**
* Called for obtaining diagnostics about the filter session.
*/
json_t* diagnostics_json() const;
protected:
FilterSession(MXS_SESSION* pSession);
@ -272,7 +279,23 @@ public:
return rv;
}
static json_t* diagnostics(const MXS_FILTER* pInstance, const MXS_FILTER_SESSION* pData)
static void diagnostics(MXS_FILTER* pInstance, MXS_FILTER_SESSION* pData, DCB* pDcb)
{
if (pData)
{
FilterSessionType* pFilterSession = static_cast<FilterSessionType*>(pData);
MXS_EXCEPTION_GUARD(pFilterSession->diagnostics(pDcb));
}
else
{
FilterType* pFilter = static_cast<FilterType*>(pInstance);
MXS_EXCEPTION_GUARD(pFilter->diagnostics(pDcb));
}
}
static json_t* diagnostics_json(const MXS_FILTER* pInstance, const MXS_FILTER_SESSION* pData)
{
json_t* rval = NULL;
@ -280,13 +303,13 @@ public:
{
const FilterSessionType* pFilterSession = static_cast<const FilterSessionType*>(pData);
MXS_EXCEPTION_GUARD(rval = pFilterSession->diagnostics());
MXS_EXCEPTION_GUARD(rval = pFilterSession->diagnostics_json());
}
else
{
const FilterType* pFilter = static_cast<const FilterType*>(pInstance);
MXS_EXCEPTION_GUARD(rval = pFilter->diagnostics());
MXS_EXCEPTION_GUARD(rval = pFilter->diagnostics_json());
}
return rval;
@ -326,6 +349,7 @@ MXS_FILTER_OBJECT Filter<FilterType, FilterSessionType>::s_object =
&Filter<FilterType, FilterSessionType>::routeQuery,
&Filter<FilterType, FilterSessionType>::clientReply,
&Filter<FilterType, FilterSessionType>::diagnostics,
&Filter<FilterType, FilterSessionType>::diagnostics_json,
&Filter<FilterType, FilterSessionType>::getCapabilities,
&Filter<FilterType, FilterSessionType>::destroyInstance,
};

3
include/maxscale/monitor.h
View File

@ -78,6 +78,7 @@ typedef struct mxs_monitor_object
* @param monitor The monitor object
*/
void (*stopMonitor)(MXS_MONITOR *monitor);
void (*diagnostics)(DCB *, const MXS_MONITOR *);
/**
* @brief Return diagnostic information about the monitor
@ -86,7 +87,7 @@ typedef struct mxs_monitor_object
*
* @see jansson.h
*/
json_t* (*diagnostics)(const MXS_MONITOR *monitor);
json_t* (*diagnostics_json)(const MXS_MONITOR *monitor);
} MXS_MONITOR_OBJECT;
/**

11
include/maxscale/router.h
View File

@ -145,6 +145,15 @@ typedef struct mxs_router_object
*/
int32_t (*routeQuery)(MXS_ROUTER *instance, MXS_ROUTER_SESSION *router_session, GWBUF *queue);
/**
* @brief Called for diagnostic output
*
* @param instance Router instance
* @param dcb DCB where the diagnostic information should be written
*/
void (*diagnostics)(MXS_ROUTER *instance, DCB *dcb);
/**
* @brief Called for diagnostic output
*
@ -154,7 +163,7 @@ typedef struct mxs_router_object
*
* @see jansson.h
*/
json_t* (*diagnostics)(const MXS_ROUTER *instance);
json_t* (*diagnostics_json)(const MXS_ROUTER *instance);
/**
* @brief Called for each reply packet

12
include/maxscale/router.hh
View File

@ -173,13 +173,20 @@ public:
return rv;
}
static json_t* diagnostics(const MXS_ROUTER* pInstance)
static void diagnostics(MXS_ROUTER* pInstance, DCB* pDcb)
{
RouterType* pRouter = static_cast<RouterType*>(pInstance);
MXS_EXCEPTION_GUARD(pRouter->diagnostics(pDcb));
}
static json_t* diagnostics_json(const MXS_ROUTER* pInstance)
{
const RouterType* pRouter = static_cast<const RouterType*>(pInstance);
json_t* rval = NULL;
MXS_EXCEPTION_GUARD(rval = pRouter->diagnostics());
MXS_EXCEPTION_GUARD(rval = pRouter->diagnostics_json());
return rval;
}
@ -242,6 +249,7 @@ MXS_ROUTER_OBJECT Router<RouterType, RouterSessionType>::s_object =
&Router<RouterType, RouterSessionType>::freeSession,
&Router<RouterType, RouterSessionType>::routeQuery,
&Router<RouterType, RouterSessionType>::diagnostics,
&Router<RouterType, RouterSessionType>::diagnostics_json,
&Router<RouterType, RouterSessionType>::clientReply,
&Router<RouterType, RouterSessionType>::handleError,
&Router<RouterType, RouterSessionType>::getCapabilities,

10
include/maxscale/users.h
View File

@ -115,9 +115,17 @@ int users_default_loadusers(SERV_LISTENER *port);
/**
* @brief Default authenticator diagnostic function
*
* @param dcb DCB where data is printed
* @param port Port whose data is to be printed
*/
json_t* users_default_diagnostic(const SERV_LISTENER *port);
void users_default_diagnostic(DCB *dcb, SERV_LISTENER *port);
/**
* @brief Default authenticator diagnostic function
*
* @param port Port whose data is to be printed
*/
json_t* users_default_diagnostic_json(const SERV_LISTENER *port);
/**
* Print details of the users storage mechanism

22
server/core/filter.cc
View File

@ -212,12 +212,7 @@ dprintAllFilters(DCB *dcb)
}
if (ptr->obj && ptr->filter)
{
json_t* json = ptr->obj->diagnostics(ptr->filter, NULL);
if (json)
{
json_decref(json);
}
ptr->obj->diagnostics(ptr->filter, NULL, dcb);
}
else
{
@ -252,12 +247,7 @@ dprintFilter(DCB *dcb, const MXS_FILTER_DEF *filter)
}
if (filter->obj && filter->filter)
{
json_t* json = filter->obj->diagnostics(filter->filter, NULL);
if (json)
{
json_decref(json);
}
filter->obj->diagnostics(filter->filter, NULL, dcb);
}
}
@ -503,7 +493,7 @@ json_t* filter_to_json(const MXS_FILTER_DEF* filter, const char* host)
if (filter->obj && filter->filter)
{
json_t* diag = filter->obj->diagnostics(filter->filter, NULL);
json_t* diag = filter->obj->diagnostics_json(filter->filter, NULL);
if (diag)
{
@ -596,7 +586,11 @@ int FilterSession::clientReply(GWBUF* pPacket)
return m_up.clientReply(pPacket);
}
json_t* FilterSession::diagnostics() const
void FilterSession::diagnostics(DCB *pDcb)
{
}
json_t* FilterSession::diagnostics_json() const
{
return NULL;
}

9
server/core/monitor.cc
View File

@ -477,12 +477,7 @@ monitorShow(DCB *dcb, MXS_MONITOR *monitor)
{
if (monitor->module->diagnostics)
{
json_t* json = monitor->module->diagnostics(monitor);
if (json)
{
json_decref(json);
}
monitor->module->diagnostics(dcb, monitor);
}
else
{
@ -1550,7 +1545,7 @@ json_t* monitor_to_json(const MXS_MONITOR* monitor, const char* host)
if (monitor->handle && monitor->module->diagnostics)
{
json_t* diag = monitor->module->diagnostics(monitor);
json_t* diag = monitor->module->diagnostics_json(monitor);
if (diag)
{

16
server/core/service.cc
View File

@ -1415,12 +1415,7 @@ void dprintService(DCB *dcb, SERVICE *service)
}
if (service->router && service->router_instance)
{
json_t* json = service->router->diagnostics(service->router_instance);
if (json)
{
json_decref(json);
}
service->router->diagnostics(service->router_instance, dcb);
}
dcb_printf(dcb, "\tStarted: %s",
asctime_r(localtime_r(&service->stats.started, &result), timebuf));
@ -2298,12 +2293,7 @@ void service_print_users(DCB *dcb, const SERVICE *service)
{
if (port->listener && port->listener->authfunc.diagnostic)
{
json_t* json = port->listener->authfunc.diagnostic(port);
if (json)
{
json_decref(json);
}
port->listener->authfunc.diagnostic(dcb, port);
}
}
}
@ -2368,7 +2358,7 @@ json_t* service_to_json(const SERVICE* service, const char* host)
if (service->router && service->router_instance)
{
json_t* diag = service->router->diagnostics(service->router_instance);
json_t* diag = service->router->diagnostics_json(service->router_instance);
if (diag)
{

10
server/core/session.cc
View File

@ -533,13 +533,9 @@ dprintSession(DCB *dcb, MXS_SESSION *print_session)
{
dcb_printf(dcb, "\tFilter: %s\n",
print_session->filters[i].filter->name);
json_t* json = print_session->filters[i].filter->obj->diagnostics(print_session->filters[i].instance,
print_session->filters[i].session);
if (json)
{
json_decref(json);
}
print_session->filters[i].filter->obj->diagnostics(print_session->filters[i].instance,
print_session->filters[i].session,
dcb);
}
}
}

30
server/core/users.cc
View File

@ -109,7 +109,35 @@ void usersPrint(const USERS *users)
hashtable_stats(users->data);
}
json_t* users_default_diagnostic(const SERV_LISTENER *port)
void users_default_diagnostic(DCB *dcb, SERV_LISTENER *port)
{
if (port->users && port->users->data)
{
HASHITERATOR *iter = hashtable_iterator(port->users->data);
if (iter)
{
dcb_printf(dcb, "User names: ");
const char *sep = "";
void *user;
while ((user = hashtable_next(iter)) != NULL)
{
dcb_printf(dcb, "%s%s", sep, (char *)user);
sep = ", ";
}
dcb_printf(dcb, "\n");
hashtable_iterator_free(iter);
}
}
else
{
dcb_printf(dcb, "Users table is empty\n");
}
}
json_t* users_default_diagnostic_json(const SERV_LISTENER *port)
{
json_t* rval = json_array();