DataSource Logging

Macros
#define	DS_LOG_CONFIG   0
	Used for log messages that indicate a problem or feedback with library configuration. More...
#define	DS_LOG_CRIT   2
	Used for log messages that indicate a serious failure. More...
#define	DS_LOG_DEBUG   7
	Used for tracing messages. More...
#define	DS_LOG_ERROR   3
	Used for log messages that indicate a problem. More...
#define	DS_LOG_FINER   8
	Used for fairly detailed tracing messages. More...
#define	DS_LOG_FINEST   9
	Used for the most finely detailed tracing messages. More...
#define	DS_LOG_INFO   6
	Used for informational messages. More...
#define	DS_LOG_MONITOR   128
	A modifier that will send the log message to the monitoring system in addition to the event log, even if the log level is below the monitoring threshold value. More...
#define	DS_LOG_NOTIFY   4
	Used for messages of greater importance than DS_LOG_WARN that may not indicate problems. More...
#define	DS_LOG_SYSLOG   512
	A modifier which will write the log message to the system log in addition to the event log. More...
#define	DS_LOG_TERMINAL   256
	A modifier which will write the log message to the terminal in addition to the event log. More...
#define	DS_LOG_WARN   5
	Used for messages that indicate a potential problem. More...

Typedefs
typedef struct _ds_log	ds_log_t
	The log file object. More...
typedef void(*	ds_logcycled_t) (ds_log_t *log)
	Callback used when the log has cycled. More...
typedef void(*	ds_loglevelchange_t) (ds_log_t *log, int new_level)
	Callback used when the logging level of a log file is changed. More...

Variables
TRANSFORMER_EXPORT ds_log_t *	rtas_log
	Name of the Transformer's event log. More...

Detailed Description

DataSource's log files keep a record of all data and to what destinations the data was sent.

The DataSource SDK logging API permits you to create your own logging functions

Log file names can use the following abbreviations:

• %r can be used to represent the configured application-root.
• %d can be used to represent the configured log-dir.
• %a can be used to represent the configured application-name.
• %n can be used to represent the configured application-name.
• %M can be used to represent the major version of the DataSource Libraries.
• %m can be used to represent the minor version of the DataSource Libraries.
• %h can be used to represent the hostname.
• %u can be used to represent the home directory of the user running the application.

Macro Definition Documentation

#define DS_LOG_CONFIG   0

Used for log messages that indicate a problem or feedback with library configuration.

#define DS_LOG_CRIT   2

Used for log messages that indicate a serious failure.

#define DS_LOG_DEBUG   7

Used for tracing messages.

#define DS_LOG_ERROR   3

Used for log messages that indicate a problem.

#define DS_LOG_FINER   8

Used for fairly detailed tracing messages.

#define DS_LOG_FINEST   9

Used for the most finely detailed tracing messages.

#define DS_LOG_INFO   6

Used for informational messages.

#define DS_LOG_MONITOR   128

A modifier that will send the log message to the monitoring system in addition to the event log, even if the log level is below the monitoring threshold value.

#define DS_LOG_NOTIFY   4

Used for messages of greater importance than DS_LOG_WARN that may not indicate problems.

#define DS_LOG_SYSLOG   512

A modifier which will write the log message to the system log in addition to the event log.

#define DS_LOG_TERMINAL   256

A modifier which will write the log message to the terminal in addition to the event log.

#define DS_LOG_WARN   5

Used for messages that indicate a potential problem.

Typedef Documentation

typedef struct _ds_log ds_log_t

The log file object.

typedef void(* ds_logcycled_t) (ds_log_t *log)

Callback used when the log has cycled.

Parameters

log	The logfile that has cycled

typedef void(* ds_loglevelchange_t) (ds_log_t *log, int new_level)

Callback used when the logging level of a log file is changed.

Parameters

log	The logfile the change has happend to
new_level	The new debug level

Variable Documentation

TRANSFORMER_EXPORT ds_log_t* rtas_log

Name of the Transformer's event log.

Modules are permitted to write to the Transformer's main event log, this could be useful to enable data flow to be traced through the system

Examples:

demo-calcvalue.c, demo-delete.c, demo-modify.c, demo-spread.c, demo-userdata.c, and demo-userdata2.c.