RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
haproxy/include/proto/dumpstats.h

77 lines
2.9 KiB
C
Raw Normal View History

[MEDIUM] moved stats and buffer generic functions to new files Neither the primitives used to write data to a buffer, nor the stats dump functions are HTTP-specific anymore. Move them to dedicated files
2007-10-17 15:06:05 +00:00
/*
[MEDIUM] separate protocol-level accept() from the frontend's For a long time we had two large accept() functions, one for TCP sockets instanciating proxies, and another one for UNIX sockets instanciating the stats interface. A lot of code was duplicated and both did not work exactly the same way. Now we have a stream_sock layer accept() called for either TCP or UNIX sockets, and this function calls the frontend-specific accept() function which does the rest of the frontend-specific initialisation. Some code is still duplicated (session & task allocation, stream interface initialization), and might benefit from having an intermediate session-level accept() callback to perform such initializations. Still there are some minor differences that need to be addressed first. For instance, the monitor nets should only be checked for proxies and not for other connection templates. Last, we renamed l->private as l->frontend. The "private" pointer in the listener is only used to store a frontend, so let's rename it to eliminate this ambiguity. When we later support detached listeners (eg: FTP), we'll add another field to avoid the confusion.
2010-05-28 16:46:57 +00:00
* include/proto/dumpstats.h
* This file contains definitions of some primitives to dedicated to
* statistics output.
*
[MINOR] stream_interface: make use of an applet descriptor for IO handlers I/O handlers are still delicate to manipulate. They have no type, they're just raw functions which have no knowledge of themselves. Let's have them declared as applets once for all. That way we can have multiple applets share the same handler functions and we can store their names there. When we later need to add more parameters (eg: usage stats), we'll be able to do so in the applets themselves. The CLI functions has been prefixed with "cli" instead of "stats" as it's clearly what is going on there. The applet descriptor in the stream interface should get all the applet specific data (st0, ...) but this will be done in the next patch so that we don't pollute this one too much.
2011-02-13 12:16:36 +00:00
* Copyright (C) 2000-2011 Willy Tarreau - w@1wt.eu
[MEDIUM] separate protocol-level accept() from the frontend's For a long time we had two large accept() functions, one for TCP sockets instanciating proxies, and another one for UNIX sockets instanciating the stats interface. A lot of code was duplicated and both did not work exactly the same way. Now we have a stream_sock layer accept() called for either TCP or UNIX sockets, and this function calls the frontend-specific accept() function which does the rest of the frontend-specific initialisation. Some code is still duplicated (session & task allocation, stream interface initialization), and might benefit from having an intermediate session-level accept() callback to perform such initializations. Still there are some minor differences that need to be addressed first. For instance, the monitor nets should only be checked for proxies and not for other connection templates. Last, we renamed l->private as l->frontend. The "private" pointer in the listener is only used to store a frontend, so let's rename it to eliminate this ambiguity. When we later support detached listeners (eg: FTP), we'll add another field to avoid the confusion.
2010-05-28 16:46:57 +00:00
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, version 2.1
* exclusively.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
[MEDIUM] moved stats and buffer generic functions to new files Neither the primitives used to write data to a buffer, nor the stats dump functions are HTTP-specific anymore. Move them to dedicated files
2007-10-17 15:06:05 +00:00
#ifndef _PROTO_DUMPSTATS_H
#define _PROTO_DUMPSTATS_H
#include <common/config.h>
#include <types/buffers.h>
#include <types/session.h>
[REORG] session: move the data_ctx struct to the stream interface's applet This is in fact where those parts belong to. The old data_state was replaced by applet.state and is now initialized when the applet is registered. It's worth noting that the applet does not need to know the session nor the buffer anymore since everything is brought by the stream interface. It is possible that having a separate applet struct would simplify the code but that's not a big deal.
2011-03-10 10:25:07 +00:00
/* Flags for applet.ctx.stats.flags */
[MEDIUM] fix stats socket limitation to 16 kB Due to the way the stats socket work, it was not possible to maintain the information related to the command entered, so after filling a whole buffer, the request was lost and it was considered that there was nothing to write anymore. The major reason was that some flags were passed directly during the first call to stats_dump_raw() instead of being stored persistently in the session. To definitely fix this problem, flags were added to the stats member of the session structure. A second problem appeared. When the stats were produced, a first call to client_retnclose() was performed, then one or multiple subsequent calls to buffer_write_chunks() were done. But once the stats buffer was full and a reschedule operated, the buffer was flushed, the write flag cleared from the buffer and nothing was done to re-arm it. For this reason, a check was added in the proto_uxst_stats() function in order to re-call the client FSM when data were added by stats_dump_raw(). Finally, the whole unix stats dump FSM was rewritten to avoid all the magics it depended on. It is now simpler and looks more like the HTTP one.
2008-03-17 20:38:24 +00:00
#define STAT_FMT_CSV 0x00000001 /* dump the stats in CSV format instead of HTML */
#define STAT_SHOW_STAT 0x00000002 /* dump the stats part */
#define STAT_SHOW_INFO 0x00000004 /* dump the info part */
#define STAT_HIDE_DOWN 0x00000008 /* hide 'down' servers in the stats page */
#define STAT_NO_REFRESH 0x00000010 /* do not automatically refresh the stats page */
[MEDIUM] stats: add an admin level The stats web interface must be read-only by default to prevent security holes. As it is now allowed to enable/disable servers, a new keyword "stats admin" is introduced to activate this admin level, conditioned by ACLs. (cherry picked from commit 5334bab92ca7debe36df69983c19c21b6dc63f78)
2010-10-11 22:14:36 +00:00
#define STAT_ADMIN 0x00000020 /* indicate a stats admin level */
[MEDIUM] fix stats socket limitation to 16 kB Due to the way the stats socket work, it was not possible to maintain the information related to the command entered, so after filling a whole buffer, the request was lost and it was considered that there was nothing to write anymore. The major reason was that some flags were passed directly during the first call to stats_dump_raw() instead of being stored persistently in the session. To definitely fix this problem, flags were added to the stats member of the session structure. A second problem appeared. When the stats were produced, a first call to client_retnclose() was performed, then one or multiple subsequent calls to buffer_write_chunks() were done. But once the stats buffer was full and a reschedule operated, the buffer was flushed, the write flag cleared from the buffer and nothing was done to re-arm it. For this reason, a check was added in the proto_uxst_stats() function in order to re-call the client FSM when data were added by stats_dump_raw(). Finally, the whole unix stats dump FSM was rewritten to avoid all the magics it depended on. It is now simpler and looks more like the HTTP one.
2008-03-17 20:38:24 +00:00
#define STAT_BOUND 0x00800000 /* bound statistics to selected proxies/types/services */
[MEDIUM] implement the CSV output for the statistics It is now possible to get CSV ouput from the statistics by simply appending ";csv" to the HTTP request sent to get the stats. The fields keep the same ordering as in the HTML page, and a field "pxname" has been prepended at the beginning of the line.
2007-10-17 16:44:57 +00:00
[MAJOR] proto_uxst rework -> SNMP support Currently there is a ~16KB limit for a data size passed via unix socket. It is caused by a trivial bug ttat is going to fixed soon, however in most cases there is no need to dump a full stats. This patch makes possible to select a scope of dumped data by extending current "show stat" to "show stat [<iid> <type> <sid>]": - iid is a proxy id, -1 to dump all proxies - type selects type of dumpable objects: 1 for frontend, 2 for backend, 4 for server, -1 for all types. Values can be ORed, for example: 1+2=3 -> frontend+backend. 1+2+4=7 -> frontend+backend+server. - sid is a service id, -1 to dump everything from the selected proxy. To do this I implemented a new session flag (SN_STAT_BOUND), added three variables in data_ctx.stats (iid, type, sid), modified dumpstats.c and completely revorked the process_uxst_stats: now it waits for a "\n" terminated string, splits args and uses them. BTW: It should be quite easy to add new commands, for example to enable/disable servers, the only problem I can see is a not very lucky config name (*stats* socket). :| During the work I also fixed two bug: - s->flags were not initialized for proto_uxst - missing comma if throttling not enabled (caused by a stupid change in "Implement persistent id for proxies and servers") Other changes: - No more magic type valuse, use STATS_TYPE_FE/STATS_TYPE_BE/STATS_TYPE_SV - Don't memset full s->data_ctx (it was clearing s->data_ctx.stats.{iid/type/sid}, instead initialize stats.sv & stats.sv_st (stats.px and stats.px_st were already initialized) With all that changes it was extremely easy to write a short perl plugin for a perl-enabled net-snmp (also included in this patch). 29385 is my PEN (Private Enterprise Number) and I'm willing to donate the SNMPv2-SMI::enterprises.29385.106.* OIDs for HAProxy if there is nothing assigned already.
2008-03-02 01:42:14 +00:00
#define STATS_TYPE_FE 0
#define STATS_TYPE_BE 1
#define STATS_TYPE_SV 2
[MEDIUM] Collect & provide separate statistics for sockets, v2 This patch allows to collect & provide separate statistics for each socket. It can be very useful if you would like to distinguish between traffic generate by local and remote users or between different types of remote clients (peerings, domestic, foreign). Currently no "Session rate" is supported, but adding it should be possible if we found it useful.
2009-10-04 13:43:17 +00:00
#define STATS_TYPE_SO 3
[MAJOR] proto_uxst rework -> SNMP support Currently there is a ~16KB limit for a data size passed via unix socket. It is caused by a trivial bug ttat is going to fixed soon, however in most cases there is no need to dump a full stats. This patch makes possible to select a scope of dumped data by extending current "show stat" to "show stat [<iid> <type> <sid>]": - iid is a proxy id, -1 to dump all proxies - type selects type of dumpable objects: 1 for frontend, 2 for backend, 4 for server, -1 for all types. Values can be ORed, for example: 1+2=3 -> frontend+backend. 1+2+4=7 -> frontend+backend+server. - sid is a service id, -1 to dump everything from the selected proxy. To do this I implemented a new session flag (SN_STAT_BOUND), added three variables in data_ctx.stats (iid, type, sid), modified dumpstats.c and completely revorked the process_uxst_stats: now it waits for a "\n" terminated string, splits args and uses them. BTW: It should be quite easy to add new commands, for example to enable/disable servers, the only problem I can see is a not very lucky config name (*stats* socket). :| During the work I also fixed two bug: - s->flags were not initialized for proto_uxst - missing comma if throttling not enabled (caused by a stupid change in "Implement persistent id for proxies and servers") Other changes: - No more magic type valuse, use STATS_TYPE_FE/STATS_TYPE_BE/STATS_TYPE_SV - Don't memset full s->data_ctx (it was clearing s->data_ctx.stats.{iid/type/sid}, instead initialize stats.sv & stats.sv_st (stats.px and stats.px_st were already initialized) With all that changes it was extremely easy to write a short perl plugin for a perl-enabled net-snmp (also included in this patch). 29385 is my PEN (Private Enterprise Number) and I'm willing to donate the SNMPv2-SMI::enterprises.29385.106.* OIDs for HAProxy if there is nothing assigned already.
2008-03-02 01:42:14 +00:00
[MEDIUM] stats: don't use s->ana_state anymore The stats handler used to store internal states in s->ana_state. Now we only rely on si->st0 in which we can store as many states as we have possible outputs. This cleans up the stats code a lot and makes it more maintainable. It has also reduced code size by a few hundred bytes.
2009-10-04 12:22:18 +00:00
/* unix stats socket states */
#define STAT_CLI_INIT 0 /* initial state */
#define STAT_CLI_END 1 /* final state, let's close */
#define STAT_CLI_GETREQ 2 /* wait for a request */
#define STAT_CLI_OUTPUT 3 /* all states after this one are responses */
#define STAT_CLI_PROMPT 3 /* display the prompt (first output, same code) */
[MINOR] stats: use a dedicated state to output static data It is a bit expensive and complex to use to call buffer_feed() directly from the request parser, and there are risks that some output messages are lost in case of buffer full. Since most of these messages are static, let's have a state dedicated to print these messages and store them in a specific area shared with the stats in the session. This both reduces code size and risks of losing output data.
2009-10-11 21:12:51 +00:00
#define STAT_CLI_PRINT 4 /* display message in cli->msg */
[MEDIUM] stats: don't use s->ana_state anymore The stats handler used to store internal states in s->ana_state. Now we only rely on si->st0 in which we can store as many states as we have possible outputs. This cleans up the stats code a lot and makes it more maintainable. It has also reduced code size by a few hundred bytes.
2009-10-04 12:22:18 +00:00
#define STAT_CLI_O_INFO 5 /* dump info/stats */
#define STAT_CLI_O_SESS 6 /* dump sessions */
#define STAT_CLI_O_ERR 7 /* dump errors */
[MEDIUM] stats: add "show table [<name>]" to dump a stick-table It is now possible to dump a table's contents with keys, expire, use count, and various data using the command above on the stats socket. "show table" only shows main table stats, while "show table <name>" dumps table contents, only if the socket level is admin.
2010-07-12 15:55:33 +00:00
#define STAT_CLI_O_TAB 8 /* dump tables */
[MEDIUM] stats: don't use s->ana_state anymore The stats handler used to store internal states in s->ana_state. Now we only rely on si->st0 in which we can store as many states as we have possible outputs. This cleans up the stats code a lot and makes it more maintainable. It has also reduced code size by a few hundred bytes.
2009-10-04 12:22:18 +00:00
[MEDIUM] enable/disable servers from the stats web interface Based on a patch provided by Judd Montgomery, it is now possible to enable/disable servers from the stats web interface. This allows to select several servers in a backend and apply the action to them at the same time. Currently, there are 2 known limitations : - The POST data are limited to one packet (don't alter too many servers at a time). - Expect: 100-continue is not supported. (cherry picked from commit 7693948766cb5647ac03b48e782cfee2b1f14491)
2010-10-11 22:14:35 +00:00
/* status codes (strictly 4 chars) used in the URL to display a message */
#define STAT_STATUS_UNKN "UNKN" /* an unknown error occured, shouldn't happen */
#define STAT_STATUS_DONE "DONE" /* the action is successful */
#define STAT_STATUS_NONE "NONE" /* nothing happened (no action chosen or servers state didn't change) */
#define STAT_STATUS_EXCD "EXCD" /* an error occured becayse the buffer couldn't store all data */
[MEDIUM] stats: add an admin level The stats web interface must be read-only by default to prevent security holes. As it is now allowed to enable/disable servers, a new keyword "stats admin" is introduced to activate this admin level, conditioned by ACLs. (cherry picked from commit 5334bab92ca7debe36df69983c19c21b6dc63f78)
2010-10-11 22:14:36 +00:00
#define STAT_STATUS_DENY "DENY" /* action denied */
[MEDIUM] enable/disable servers from the stats web interface Based on a patch provided by Judd Montgomery, it is now possible to enable/disable servers from the stats web interface. This allows to select several servers in a backend and apply the action to them at the same time. Currently, there are 2 known limitations : - The POST data are limited to one packet (don't alter too many servers at a time). - Expect: 100-continue is not supported. (cherry picked from commit 7693948766cb5647ac03b48e782cfee2b1f14491)
2010-10-11 22:14:35 +00:00
[MINOR] stream_interface: make use of an applet descriptor for IO handlers I/O handlers are still delicate to manipulate. They have no type, they're just raw functions which have no knowledge of themselves. Let's have them declared as applets once for all. That way we can have multiple applets share the same handler functions and we can store their names there. When we later need to add more parameters (eg: usage stats), we'll be able to do so in the applets themselves. The CLI functions has been prefixed with "cli" instead of "stats" as it's clearly what is going on there. The applet descriptor in the stream interface should get all the applet specific data (st0, ...) but this will be done in the next patch so that we don't pollute this one too much.
2011-02-13 12:16:36 +00:00
extern struct si_applet http_stats_applet;
[MAJOR] make unix sockets work again with stats The unix protocol handler had not been updated during the last stream_sock changes. This has been done now. There is still a lot of duplicated code between session.c and proto_uxst.c due to the way the session is handled. Session.c relies on the existence of a frontend while it does not exist here. It is easier to see the difference between the stats part (placed in dumpstats.c) and the unix-stream part (in proto_uxst.c). The hijacking function still needs to be dynamically set into the response buffer, and some cleanup is still required, then all those changes should be forward-ported to the HTTP part. Adding support for new keywords should not cause trouble now.
2008-12-07 15:06:43 +00:00
[MEDIUM] stats: replace the stats socket analyser with an SI applet We can get rid of the stats analyser by moving all the stats code to a stream interface applet. Above being cleaner, it provides new advantages such as the ability to process requests and responses from the same function and work only with simple state machines. There's no need for any hijack hack anymore. The direct advantage for the user are the interactive mode and the ability to chain several commands delimited by a semi-colon. Now if the user types "prompt", he gets a prompt from which he can send as many requests as he wants. All outputs are terminated by a blank line followed by a new prompt, so this can be used from external tools too. The code is not very clean, it needs some rework, but some part of the dirty parts are due to the remnants of the hijack mode used in the old functions we call. The old AN_REQ_STATS_SOCK analyser flag is now unused and has been removed.
2009-09-22 17:31:03 +00:00
void stats_io_handler(struct stream_interface *si);
[MEDIUM] moved stats and buffer generic functions to new files Neither the primitives used to write data to a buffer, nor the stats dump functions are HTTP-specific anymore. Move them to dedicated files
2007-10-17 15:06:05 +00:00
#endif /* _PROTO_DUMPSTATS_H */
/*
* Local variables:
* c-indent-level: 8
* c-basic-offset: 8
* End:
*/