1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/*
* Written by Bojan Smojver <bojan rexursive.com>.
*/
#include "apr_strings.h"
#include "apr_lib.h"
#include "apr_hash.h"
#include "apr_optional.h"
#define APR_WANT_STRFUNC
#include "apr_want.h"
#include "ap_config.h"
#include "mod_log_config.h"
#include "httpd.h"
#include "http_core.h"
#include "http_config.h"
#include "http_connection.h"
#include "http_protocol.h"
#include "http_request.h"
module AP_MODULE_DECLARE_DATA logio_module;
static const char logio_filter_name[] = "LOG_INPUT_OUTPUT";
static const char logio_ttfb_filter_name[] = "LOGIO_TTFB_OUT";
/*
* Logging of input and output config...
*/
typedef struct logio_config_t {
apr_off_t bytes_in;
apr_off_t bytes_out;
apr_off_t bytes_last_request;
} logio_config_t;
typedef struct logio_dirconf_t {
unsigned int track_ttfb:1;
} logio_dirconf_t;
typedef struct logio_req_t {
apr_time_t ttfb;
} logio_req_t;
/*
* Optional function for the core to add to bytes_out
*/
static void ap_logio_add_bytes_out(conn_rec *c, apr_off_t bytes)
{
logio_config_t *cf = ap_get_module_config(c->conn_config, &logio_module);
cf->bytes_out += bytes;
}
/*
* Optional function for modules to adjust bytes_in
*/
static void ap_logio_add_bytes_in(conn_rec *c, apr_off_t bytes)
{
logio_config_t *cf = ap_get_module_config(c->conn_config, &logio_module);
cf->bytes_in += bytes;
}
/*
* Optional function to get total byte count of last request for
* ap_increment_counts.
*/
static apr_off_t ap_logio_get_last_bytes(conn_rec *c)
{
logio_config_t *cf = ap_get_module_config(c->conn_config, &logio_module);
return cf->bytes_last_request;
}
/*
* Format items...
*/
static const char *log_bytes_in(request_rec *r, char *a)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
return apr_off_t_toa(r->pool, cf->bytes_in);
}
static const char *log_bytes_out(request_rec *r, char *a)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
return apr_off_t_toa(r->pool, cf->bytes_out);
}
static const char *log_bytes_combined(request_rec *r, char *a)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
return apr_off_t_toa(r->pool, cf->bytes_out + cf->bytes_in);
}
static const char *log_ttfb(request_rec *r, char *a)
{
logio_req_t *rconf = ap_get_module_config(r->request_config,
&logio_module);
if (!rconf || !rconf->ttfb) {
return "-";
}
return apr_psprintf(r->pool, "%" APR_TIME_T_FMT, rconf->ttfb);
}
/*
* Reset counters after logging...
*/
static int logio_transaction(request_rec *r)
{
logio_config_t *cf = ap_get_module_config(r->connection->conn_config,
&logio_module);
/* need to save byte count of last request for ap_increment_counts */
cf->bytes_last_request = cf->bytes_in + cf->bytes_out;
cf->bytes_in = cf->bytes_out = 0;
return OK;
}
/*
* Logging of input filter...
*/
static apr_status_t logio_in_filter(ap_filter_t *f,
apr_bucket_brigade *bb,
ap_input_mode_t mode,
apr_read_type_e block,
apr_off_t readbytes)
{
apr_off_t length;
apr_status_t status;
logio_config_t *cf = ap_get_module_config(f->c->conn_config, &logio_module);
status = ap_get_brigade(f->next, bb, mode, block, readbytes);
apr_brigade_length (bb, 0, &length);
if (length > 0)
cf->bytes_in += length;
return status;
}
/*
* The hooks...
*/
static int logio_pre_conn(conn_rec *c, void *csd)
{
logio_config_t *cf = apr_pcalloc(c->pool, sizeof(*cf));
ap_set_module_config(c->conn_config, &logio_module, cf);
ap_add_input_filter(logio_filter_name, NULL, NULL, c);
return OK;
}
static int logio_pre_config(apr_pool_t *p, apr_pool_t *plog, apr_pool_t *ptemp)
{
APR_OPTIONAL_FN_TYPE(ap_register_log_handler) *log_pfn_register;
log_pfn_register = APR_RETRIEVE_OPTIONAL_FN(ap_register_log_handler);
if (log_pfn_register) {
log_pfn_register(p, "I", log_bytes_in, 0);
log_pfn_register(p, "O", log_bytes_out, 0);
log_pfn_register(p, "S", log_bytes_combined, 0);
log_pfn_register(p, "^FB", log_ttfb, 0);
}
return OK;
}
static apr_status_t logio_ttfb_filter(ap_filter_t *f, apr_bucket_brigade *b)
{
request_rec *r = f->r;
logio_dirconf_t *conf = ap_get_module_config(r->per_dir_config,
&logio_module);
if (conf && conf->track_ttfb) {
logio_req_t *rconf = ap_get_module_config(r->request_config,
&logio_module);
if (rconf == NULL) {
rconf = apr_pcalloc(r->pool, sizeof(logio_req_t));
rconf->ttfb = apr_time_now() - r->request_time;
ap_set_module_config(r->request_config, &logio_module, rconf);
}
}
ap_remove_output_filter(f);
return ap_pass_brigade(f->next, b);
}
static void logio_insert_filter(request_rec * r)
{
logio_dirconf_t *conf = ap_get_module_config(r->per_dir_config,
&logio_module);
if (conf->track_ttfb) {
ap_add_output_filter(logio_ttfb_filter_name, NULL, r, r->connection);
}
}
static const char *logio_track_ttfb(cmd_parms *cmd, void *in_dir_config, int arg)
{
logio_dirconf_t *dir_config = in_dir_config;
dir_config->track_ttfb = arg;
return NULL;
}
static void *create_logio_dirconf (apr_pool_t *p, char *dummy)
{
logio_dirconf_t *new =
(logio_dirconf_t *) apr_pcalloc(p, sizeof(logio_dirconf_t));
return (void *) new;
}
static const command_rec logio_cmds[] = {
AP_INIT_FLAG ("LogIOTrackTTFB", logio_track_ttfb, NULL, OR_ALL,
"Set to 'ON' to enable tracking time to first byte"),
{NULL}
};
static void register_hooks(apr_pool_t *p)
{
static const char *pre[] = { "mod_log_config.c", NULL };
ap_hook_pre_connection(logio_pre_conn, NULL, NULL, APR_HOOK_MIDDLE);
ap_hook_pre_config(logio_pre_config, NULL, NULL, APR_HOOK_REALLY_FIRST);
ap_hook_log_transaction(logio_transaction, pre, NULL, APR_HOOK_MIDDLE);
ap_register_input_filter(logio_filter_name, logio_in_filter, NULL,
AP_FTYPE_NETWORK - 1);
ap_hook_insert_filter(logio_insert_filter, NULL, NULL, APR_HOOK_LAST);
ap_register_output_filter(logio_ttfb_filter_name, logio_ttfb_filter, NULL,
AP_FTYPE_RESOURCE);
APR_REGISTER_OPTIONAL_FN(ap_logio_add_bytes_out);
APR_REGISTER_OPTIONAL_FN(ap_logio_add_bytes_in);
APR_REGISTER_OPTIONAL_FN(ap_logio_get_last_bytes);
}
AP_DECLARE_MODULE(logio) =
{
STANDARD20_MODULE_STUFF,
create_logio_dirconf, /* create per-dir config */
NULL, /* merge per-dir config */
NULL, /* server config */
NULL, /* merge server config */
logio_cmds, /* command apr_table_t */
register_hooks /* register hooks */
};
|