http_log.h revision 497c60d05c62d2e4a37b0a0c002f62cd5824b4e3
458N/A/* Copyright 1999-2004 Apache Software Foundation 458N/A * Licensed under the Apache License, Version 2.0 (the "License"); 458N/A * you may not use this file except in compliance with the License. 458N/A * You may obtain a copy of the License at 458N/A * Unless required by applicable law or agreed to in writing, software 458N/A * distributed under the License is distributed on an "AS IS" BASIS, 458N/A * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 458N/A * See the License for the specific language governing permissions and 458N/A * limitations under the License. 458N/A * @package Apache logging library 969N/A/* APLOG_NOERRNO is ignored and should not be used. It will be 458N/A * removed in a future release of Apache. 458N/A/* Use APLOG_TOCLIENT on ap_log_rerror() to give content 458N/A * handlers the option of including the error text in the 458N/A * ErrorDocument sent back to the client. Setting APLOG_TOCLIENT 458N/A * will cause the error text to be saved in the request_rec->notes 458N/A * table, keyed to the string "error-notes", if and only if: 458N/A * - the severity level of the message is APLOG_WARNING or greater 646N/A * - there are no other "error-notes" set in request_rec->notes 646N/A * Once error-notes is set, it is up to the content handler to 646N/A * determine whether this text should be sent back to the client. 646N/A * Note: Client generated text streams sent back to the client MUST 646N/A * be escaped to prevent CSS attacks. 646N/A/* normal but significant condition on startup, usually printed to stderr */ 458N/A * Set up for logging to stderr. 458N/A * @param p The pool to allocate out of 458N/A * Replace logging to stderr with logging to the given file. 458N/A * @param p The pool to allocate out of 969N/A * @param file Name of the file to log stderr output 458N/A * Open the error log and replace stderr with it. 458N/A * @param pconf Not used 458N/A * @param plog The pool to allocate the logs from 458N/A * @param ptemp Pool used for temporary allocations 1567N/A * @param s_main The main server 1567N/A * @tip ap_open_logs isn't expected to be used by modules, it is 1567N/A * an internal core function 1567N/A * The three primary logging functions, ap_log_error, ap_log_rerror, and 458N/A * ap_log_perror use a printf style format string to build the log message. 1699N/A * It is VERY IMPORTANT that you not include any raw data from the network, 1699N/A * such as the request-URI or request header fields, within the format 1567N/A * string. Doing so makes the server vulnerable to a denial-of-service 1567N/A * attack and other messy behavior. Instead, use a simple format string 1567N/A * like "%s", followed by the string containing the untrusted data. 1567N/A * One of the primary logging routines in Apache. This uses a printf-like 1567N/A * format to log messages to the error_log. 1567N/A * @param file The file in which this function is called 1567N/A * @param line The line number on which this function is called 1567N/A * @param level The level of this error message 1567N/A * @param status The status code from the previous command 1567N/A * @param s The server on which we are logging 1567N/A * @param fmt The format string 1567N/A * @param ... The arguments to use to fill out fmt. 1567N/A * @tip Use APLOG_MARK to fill out file and line 1567N/A * @warning It is VERY IMPORTANT that you not include any raw data from 458N/A * the network, such as the request-URI or request header fields, within 458N/A * the format string. Doing so makes the server vulnerable to a 1567N/A * denial-of-service attack and other messy behavior. Instead, use a 458N/A * simple format string like "%s", followed by the string containing the 458N/A * @deffunc void ap_log_error(const char *file, int line, int level, apr_status_t status, const server_rec *s, const char *fmt, ...) * The second of the primary logging routines in Apache. This uses * a printf-like format to log messages to the error_log. * @param file The file in which this function is called * @param line The line number on which this function is called * @param level The level of this error message * @param status The status code from the previous command * @param p The pool which we are logging for * @param fmt The format string * @param ... The arguments to use to fill out fmt. * @tip Use APLOG_MARK to fill out file and line * @warning It is VERY IMPORTANT that you not include any raw data from * the network, such as the request-URI or request header fields, within * the format string. Doing so makes the server vulnerable to a * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * @deffunc void ap_log_perror(const char *file, int line, int level, apr_status_t status, apr_pool_t *p, const char *fmt, ...) * The last of the primary logging routines in Apache. This uses * a printf-like format to log messages to the error_log. * @param file The file in which this function is called * @param line The line number on which this function is called * @param level The level of this error message * @param status The status code from the previous command * @param s The request which we are logging for * @param fmt The format string * @param ... The arguments to use to fill out fmt. * @tip Use APLOG_MARK to fill out file and line * @warning It is VERY IMPORTANT that you not include any raw data from * the network, such as the request-URI or request header fields, within * the format string. Doing so makes the server vulnerable to a * denial-of-service attack and other messy behavior. Instead, use a * simple format string like "%s", followed by the string containing the * @deffunc void ap_log_rerror(const char *file, int line, int level, apr_status_t status, request_rec *r, const char *fmt, ...) * Convert stderr to the error log * @param s The current server * @deffunc void ap_error_log2stderr(server_rec *s) * Log the current pid of the parent process * @param p The pool to use for logging * @param fname The name of the file to log to * Retrieve the pid from a pidfile. * @param p The pool to use for logging * @param filename The name of the file containing the pid * @param mypid Pointer to pid_t (valid only if return APR_SUCCESS) * The piped logging structure. Piped logs are used to move functionality * out of the main server. For example, log rotation is done with piped logs. /** The pool to use for the piped log */ /** The pipe between the server and the logging process */ /* XXX - an #ifdef that needs to be eliminated from public view. Shouldn't /** The name of the program the logging process is running */ /** The pid of the logging process */ * Open the piped log process * @param p The pool to allocate out of * @param program The program to run in the logging process * @return The piped log structure * @deffunc piped_log *ap_open_piped_log(apr_pool_t *p, const char *program) * Close the piped log and kill the logging process * @param pl The piped log structure * @deffunc void ap_close_piped_log(piped_log *pl) * A macro to access the read side of the piped log pipe * @param pl The piped log structure * @return The native file descriptor * @deffunc ap_piped_log_read_fd(pl) * A macro to access the write side of the piped log pipe * @param pl The piped log structure * @return The native file descriptor * @deffunc ap_piped_log_read_fd(pl) #
endif /* !APACHE_HTTP_LOG_H */