/usr/include/sipxtapi/os/OsSysLog.h is in libsipxtapi-dev 3.3.0~test17-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 | //
// Copyright (C) 2006-2013 SIPez LLC. All rights reserved.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _OsSysLog_h_
#define _OsSysLog_h_
// SYSTEM INCLUDES
#include <stdarg.h>
// APPLICATION INCLUDES
#include <utl/UtlDefs.h>
#include <os/OsSysLogFacilities.h>
#include <os/OsSocket.h>
#include <os/OsDefs.h>
#include <os/OsStatus.h>
#include <os/OsTime.h>
#include <os/OsAtomics.h>
#include <os/OsTaskId.h>
// DEFINES
#define SYSLOG_NUM_PRIORITIES 8 // Number of OsSysLogPriority entries
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// ENUMS
// TYPEDEFS
typedef enum tagOsSysLogPriority
{
PRI_DEBUG, // debug-level message
PRI_INFO, // informational message
PRI_NOTICE, // normal, but significant, condition
PRI_WARNING, // warning conditions
PRI_ERR, // error conditions
PRI_CRIT, // critical conditions
PRI_ALERT, // action must be taken immediately
PRI_EMERG // system is unusable
// NOTE: If adding/removing priorities, please adjust static name
// initializer in OsSysLog.cpp and the SYSLOG_NUM_PRIORITIES define above.
// NOTE: The levels are listed in priority order, so they can be
// compared with "<", etc.
} OsSysLogPriority;
//:The priority of log messages ordered from lowest priority to
//:highest.
//
//!enumcode: LOG_DEBUG - Debug-level message. Debug level messages should
// be understandable by third party reviewers, however, are
// not informative/significant enought to be be an INFO. These
// messages tend to be high volume and disruptive to those who did
// not author the message.
// Example: Session reinvite received from party XXXX
//!enumcode: LOG_INFO - Informational message. Informational messages
// clearly inform the reviewer of routine and non-special event
// within the system. Generally, these events tend to only affect
// the closed system and not external systems/parties. The volume
// of INFO messages is also smaller than DEBUG messages.
// Example: Using codec XXXX for call YYYY
//!enumcode: LOG_NOTICE - Normal, but significant, condition. Notices are
// expected events, however, are significant enough to warrant
// a closer review from administrator. These events may also
// involve an external system.
// Example: Replicating data to server XXXX
// Example: New User 'XXXX' added to database YYYY
//!enumcode: LOG_WARNING - Warning conditions. Warnings tend to be minor
// expected errors that are easily recoverable. A warning does
// not result in any loss of functionality or data.
// Example: Received older form of XXXX
//!enumcode: LOG_ERR - Error conditions. Error should be used whenever an
// expected error is observed and some minor amount of
// functionality is lost.
// Example: Unknown/Invalid command received.
//!enumcode: LOG_CRIT - Critical conditions. Critial errors are errors
// where some major amount of functionality/data is lost, however,
// the system as a whole will continue to function.
// Example: Unable to commit record XXX to disk, index is invalid.
//!enumcode: LOG_ALERT - Action must be taken immediately. ALERTs are
// errors or events which require immediate action before the
// situation grows worse. There is most likely functionality
// and/or data loss, however, the entire system may also fail.
// Example: Unable to create a new file; file system full.
//!enumcode: LOG_EMERG - System is unusable. The worst possible error
// where the system will ultimately fail.
// Example: Memory corrupted; closing down.
// Signature for a callback function that takes three parameters: priority,
// source Id of the generating module, and the message itself.
typedef void (*OsSysLogCallback)(const char* szPriority,
const char* szSource,
const char* szMsg);
// FORWARD DECLARATIONS
class OsSysLogTask;
class OsTimer;
//:The OsSysLog provides a system wide logger and alternative to printf or
//:osPrintf for error/informational/debugging purposes.
//
// OsSysLog is designed to work on both the xpressa phone where fixed size
// circular buffer is needed along with server-type environments where a
// simple log is required.
//
// Daemon Setup
// ============
//
// Setting up a rolling log:
//
// To setup a rolling log, you need call the static initialize method
// followed by a call to setOutputFile. For example:
//
// OsSysLog::initialize(1024, "myXpressa3422") ;
//
// This tells OsSysLog to create log of up to 1024 entries and to use the
// string "myXpressa3422" to uniquely identify this process.
//
// OsSysLog::setOutputFile(90, "/flash0/syslog.txt") ;
//
// This tell OsSysLog to save the logged data to disk every 90 seconds into
// the file "/flash0/syslog.txt".
//
// Setting up a server-style unbounded log
//
// Like setting up a rolling log, to setup a unbounded log, you will need to
// call the static initialize method followed by a call to setOutputFile. For
// example:
//
// OsSysLog::initialize(0, "ServerXYZ") ;
//
// This instructs OsSysLog not to create an in-memory buffer and names the
// process "ServerXYZ". It is important that you specify "0" as the in-memory
// buffer size; otherwise, your log may limited in size.
//
// OsSysLog::setOutputFile(0, "/usr/var/myserverlog") ;
//
// This last statement instructs the server to write data immediately to the
// log located at "/usr/var/myserverlog".
//
// Usage
// =====
//
// Ideally, you should use the syslog method build ontop of OsTask. This will
// make sure that that task id, and task name are included as part of the
// log entry.
//
// syslog(FAC_HTTP, PRI_ERR, "The url '%s' is invalid", szUrl) ;
//
// Alternatively, you can also call static methods on OsSysLog. I would
// recommend using a OsTask if possible, however, if you are unable to
// reference an OsTask:
//
// OsSysLog::add(FAC_HTTP, PRI_ERR, "The url '%s' is invalid", szUrl) ;
//
// or
//
// OsSysLog::add("MyTaskName", taskId, FAC_HTTP, PRI_ERR,
// "The url '%s' is invalid", szUrl) ;
//
//
// The "FAC_HTTP" defines the facility or functional related to the log
// message. This helps users and reviewer filter and categorize different
// log messages. Please see OsSysLogFacilities.h for a list of available
// facilities. Please also feel free to add additional facilities.
//
// The "PRI_ERR" defines the priority of the log message. Please see the
// description above for the different priority levels.
//
class OsSysLog
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
static const char* sPriorityNames[] ;
//:List of Priority Names orders in the same order as OsSysLogPriority.
static const int sPriorityNamesNum;
//:Number of elements in sPriorityNames array;
static const char* sFacilityNames[] ;
//:List of Facility Names orders in the same order as OsSysLogFacility.
static const int sFacilityNamesNum;
//:Number of elements in sFacilityNames array;
enum OsSysLogOptions
{
OPT_NONE = 0x00000000, // No Options
OPT_SHARED_LOGFILE = 0x00000001 // Assume a shared log file
// NOTE: Options are designed to be used as bitmasks (and ORed together).
// Make sure new additions are defined as power of twos (0x01,
// 0x02, 0x04, 0x08, 0x10, 0x10, 0x20, 0x40, ...)
} ;
//:Defines the set of possible options passed to the initialize method.
//
//!enumcode: OPT_NONE - No Extra Options
//
//!enumcode: OPT_SHARED_LOGFILE - Places the OsSysLog in a mode where
// multiple loggers (processes) to write to the same log file.
// This option should only be set if required to avoid
// performance hits.
/* ============================ CREATORS ================================== */
/* ============================ MANIPULATORS ============================== */
static OsStatus initialize(const int maxInMemoryLogEntries,
const char* processId,
const int options = OPT_NONE);
//:Initialize the sys log facility and the in-memory circular buffer
//:size.
// This must be called prior to invoking any of the set, add, or enable
// manipulators defined in this class.
//
//!param maxInMemoryLogEntries - Defines the maximum number of in-memory
// log entries stored at any one point. This setting may also
// impact file based output logging. If the minFlushPeriod is
// greater than 0, the output file will never grow larger than
// this value.
//
//!param processId - This parameter represents an arbitrary identifier
// that uniquely differentiates this process from other processes.
// Examples could range from a phones mac address or server's name.
//
//!param options - This parameter defines instance specific options. See
// the OsSysLogOptions enum defined above for valid settings.
static OsStatus shutdown() ;
//:Shutdown the OsSysLog task
static OsStatus setOutputFile(const int minFlushPeriod,
const char* logfile);
//:Set an output file to collect logging results.
//
//!param minFlushPeriod - Defines the minimum amount of that that must
// pass before a log entries are flushed to the log file in
// seconds. Specifying a value of less than or equal to zero will
// force immediate writes. A positive value will limit only allow
// log writes periodically and will limit the log file size to the
// maxInMemoryLogEntries defined in the call to
// OsSysLog::initialize(maxInMemoryLogEntries).
//!param logfile - The full qualified path the the target log file.
static OsStatus setCallbackFunction(OsSysLogCallback pCallback);
//:Set a callback function to collect logging results.
//
//!param pCallback - Pointer to a callback function that takes three
// strings as parameters: Logging priority, source
// of log entry, and the entry itself
static OsStatus addOutputSocket(const char* remoteHost);
//:Add an output socket to the list of output targets.
// Log events are fired to output sockets on a low-priority thread and
// are not subject to minFlushPeriods such as file output targets.
static OsStatus enableConsoleOutput(const UtlBoolean enable);
//:Enables or Disable console output for logging events.
// Log events are displayed on a low-priority thread and are not subject
// to minFlushPeriods as file output targets are.
//
//!param enable - Specify TRUE to enable console logging or FALSE to
// disable it. The default is disabled.
static OsStatus setLoggingPriority(const OsSysLogPriority priority);
//:Sets the priority logging level.
// All log events of lesser priority are disgarded immediately. These
// events are not delievered to sockets, file logs, or the console.
//
// Resetting the global logging priority will clear any facility
// priorities.
//!param priority - Defines the minimum priority level of log events that
// should be logged.
static OsStatus setLoggingPriorityForFacility(const OsSysLogFacility facility,
const OsSysLogPriority priority);
//:Set the priority logging level for a specific facility.
// A facilities's logging level overrides the global logging level. This
// allow developers to dynamically increase verbosity for a specific
// facility.
//
// Resetting the global logging priority will clear any facility
// priorities.
//
//!param facility - Defines the facility whose logging events should be
// either promoted or demoted.
//!param priority - Defines the minimum priority level of log events that
// should be logged.
static OsStatus add(const char* taskName,
const int taskId,
const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* format,
...
)
#ifdef __GNUC__
// with the -Wformat switch, this enables format string checking
__attribute__ ((format (printf, 5, 6)))
#endif
;
//:Adds an event to the sys log. If the sys log has not been
//:initialized, the message is printed to the console.
//
//!param: taskName - The name of the task if available.
//!param: taskId - The TaskID of the task if available.
//!param: facility - Defines the facility responsible for adding the
// event. See the OsSysLogFacility for more information.
//!param: priority - Defines the priority of the event. See
// OsSysLogPriority for more information.
static OsStatus add(const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* format,
...)
#ifdef __GNUC__
// with the -Wformat switch, this enables format string checking
__attribute__ ((format (printf, 3, 4)))
#endif
;
//:Adds an event to the sys log. If the sys log has not been
//:initialized, the message is printed to the console.
//
//!param: facility - Defines the facility responsible for adding the
// event. See the OsSysLogFacility for more information.
//!param: priority - Defines the priority of the event. See
// OsSysLogPriority for more information.
static OsStatus vadd(const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* format,
va_list ap)
#ifdef __GNUC__
// with the -Wformat switch, this enables format string checking
__attribute__ ((format (printf, 3, 0)))
#endif
;
//:Adds an event to the sys log. If the sys log has not been
//:initialized, the message is printed to the console.
//
//!param: facility - Defines the facility responsible for adding the
// event. See the OsSysLogFacility for more information.
//!param: priority - Defines the priority of the event. See
// OsSysLogPriority for more information.
static OsStatus vadd(const char* taskName,
const OsTaskId_t taskId,
const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* format,
va_list ap)
#ifdef __GNUC__
// with the -Wformat switch, this enables format string checking
__attribute__ ((format (printf, 5, 0)))
#endif
;
//:Adds an event to the sys log. If the sys log has not been
//:initialized, the message is printed to the console.
//
//!param: taskName - The name of the task if available.
//!param: taskId - The TaskID of the task if available.
//!param: facility - Defines the facility responsible for adding the
// event. See the OsSysLogFacility for more information.
//!param: priority - Defines the priority of the event. See
// OsSysLogPriority for more information.
static OsStatus clearInMemoryLog() ;
//:Purges all entries from the in memory log.
// If configured to using a flush period (setOutputFile), then entries
// entries will also be flushed from the file on next flush.
static OsStatus flush(const OsTime& rTimeout = OsTime::OS_INFINITY) ;
//:Flushes the in-memory circular buffer log to disk or an unbounded
//:log file.
static void initSysLog(const OsSysLogFacility facility,
const char* processID,
const char* logname,
const char* loglevel);
// Initialize the OsSysLog priority
/* ============================ ACCESSORS ================================= */
static OsStatus getMaxInMemoryLogEntries(int& maxEntries) ;
//:Obtains the maximum number of in-memory log entries.
// This value is specified as part of initialize() process and cannot
// be changed at runtime.
//!param maxEntries - The maximum number of in-memory log entries
static OsStatus tailMemoryLog(const int numEntries) ;
//:Displays the last numEntries log entries available within the
//:in-memory log buffer.
//
//!param: numEntries - The number of log entries display starting from
// the end (or tail) of the log. Specify a value of <= 0 to
// display the entire in-memory log contents.
static OsStatus headMemoryLog(const int numEntries) ;
//:Displays the first numEntries log entries available within the
//:in-memory log buffer.
//
//!param: numEntries - The number of log entries display starting from
// the beginning (or head) of the log. Specify a value of <= 0
// to display the entire in-memory log contents.
static OsStatus getLogEntries( const int maxEntries,
char* entries[],
int& actualEntries) ;
//:Gets the last <maxEntries> log entries ordered with the most recent
//:entry first.
//!param: maxEntries - The maximum number of entries to fetch.
//!param: entries - Array of char* large enough to accommodate
// maxEntries entries. It is the caller responsibility to free
// all of the char* pointers.
//!param: actualEntries - The actual number of entries returned. This
// will always be less than or equal to maxEntries.
static OsStatus parseLogString(const char *szSource,
UtlString& date,
UtlString& eventCount,
UtlString& facility,
UtlString& priority,
UtlString& hostname,
UtlString& taskname,
UtlString& taskId,
UtlString& processId,
UtlString& content) ;
//:Parses a log string into its parts.
static OsStatus getPriorityName(OsSysLogPriority priorityId, UtlString& name);
//: Get the string name for the given priority level
static OsStatus getPriorityForName(const UtlString& name, OsSysLogPriority& priorityId);
//: Get the priority level for the given string (case sensitive)
/* ============================ INQUIRY =================================== */
static OsSysLogPriority getLoggingPriority() ;
//:Return the logging level priority.
// All log events added with a lower priority are discarded.
static OsSysLogPriority getLoggingPriorityForFacility(const OsSysLogFacility facility) ;
//:Return the logging level for a specific facility.
// A facilities's logging level overrides the global logging level. This
// allow developers to dynamically increase verbosity for a specific
// facility.
static UtlBoolean willLog(OsSysLogFacility facility, OsSysLogPriority priority) ;
//:Determine if a message of a given facility/priority will be logged or
//:digarded.
static int getNumFacilities();
//:Return the number of available facilities.
static OsTimer* getTimer();
static UtlBoolean isTaskPtrNull() { return(spOsSysLogTask.load() == NULL); };
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
static OsAtomicLightPtr<OsSysLogTask> spOsSysLogTask;
static OsAtomicULong sEventCount;
static OsSysLogPriority spPriorities[FAC_MAX_FACILITY] ;
static OsSysLogPriority sLoggingPriority;
static UtlString sProcessId;
static UtlString sHostname;
static UtlBoolean bPrioritiesInitialized;
OsSysLog(const OsSysLog& rOsSysLog);
//:Copy constructor
OsSysLog& operator=(const OsSysLog& rhs);
//:Assignment operator
OsSysLog();
//:Default constructor
virtual ~OsSysLog();
//:Destructor
static UtlString escape(const UtlString& source) ;
//:Escapes Quotes and CrLfs within a string
static UtlString unescape(const UtlString& source) ;
//:Unescapes previously escaped Quotes and CrLfs
static void getTaskInfo(UtlString& taskName, OsTaskId_t& taskId);
//:Get current task name and id
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
/** Protect against simple apps that do not call setLoggingPriority */
static void initializePriorities() ;
};
class OsStackTraceLogger
{
public:
OsStackTraceLogger(const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* methodName);
OsStackTraceLogger(const OsSysLogFacility facility,
const OsSysLogPriority priority,
const char* methodName,
const OsStackTraceLogger& oneBackInStack);
~OsStackTraceLogger();
private:
// disallow copy
OsStackTraceLogger(const OsStackTraceLogger& ref) :
mFacility(FAC_LOG),
mPriority(PRI_ERR)
{
// should never get here
}
// disallow assignment
OsStackTraceLogger& operator=(const OsStackTraceLogger& ref)
{
// should never get here
return *this; // avoid compiler warning
}
UtlString mMethodName;
const OsSysLogFacility mFacility;
const OsSysLogPriority mPriority;
int mTid;
};
/* ============================ INLINE METHODS ============================ */
#endif // _OsSysLog_h_
|