logging.h File Reference

Implementation of logging methods. More...

#include <glib.h>

Include dependency graph for logging.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	LOG_REFERENCES_AVAILABLE
	for backward compatibility

Functions
GSList *	load_log_configuration (const gchar *)
	Loads parameters from a config file into a linked list.
void	free_log_configuration (GSList *)
	Frees all resources loaded by the config loader.
gchar *	get_time (gchar *)
	Returns time as specified in time_fmt strftime format.
void	gvm_log_silent (const char *, GLogLevelFlags, const char *, gpointer)
	Returns immediately.
void	gvm_log_func (const char *, GLogLevelFlags, const char *, gpointer)
	Creates the formatted string and outputs it to the log destination.
void	log_func_for_gnutls (int, const char *)
	This function logs debug messages from gnutls.
int	setup_log_handlers (GSList *)
	Sets up routing of logdomains to log handlers.
void	gvm_log_lock (void)
	Try to lock logger_mutex.
void	gvm_log_unlock (void)
	Unlock logger_mutex.
void	set_log_reference (char *)
	Set the log reference object.
char *	get_log_reference (void)
	Get the log reference object.
void	free_log_reference (void)
	Free the log reference object.
void	set_log_tz (const gchar *)
	Set the log timezone.

Detailed Description

Implementation of logging methods.

Definition in file logging.h.

Macro Definition Documentation

LOG_REFERENCES_AVAILABLE

#define LOG_REFERENCES_AVAILABLE

for backward compatibility

Definition at line 20 of file logging.h.

Function Documentation

free_log_configuration()

void free_log_configuration

(

GSList *

log_domain_list

)

Frees all resources loaded by the config loader.

Parameters

log_domain_list

Head of the link list.

Definition at line 286 of file logging.c.

{
  GSList *log_domain_list_tmp;
 
  /* Free the struct fields then the struct and then go the next
   * item in the link list.
   */
 
  /* Go to the head of the list. */
  log_domain_list_tmp = log_domain_list;
  while (log_domain_list_tmp != NULL)
    {
      gvm_logging_domain_t *log_domain_entry;
 
      /* Get the list data which is an gvm_logging_t struct. */
      log_domain_entry = log_domain_list_tmp->data;
 
      /* Free the struct contents. */
      gvm_logging_domain_free (log_domain_entry);
 
      /* Go to the next item. */
      log_domain_list_tmp = g_slist_next (log_domain_list_tmp);
    }
  /* Free the link list. */
  g_slist_free (log_domain_list);
}

References free_log_configuration(), and gvm_logging_domain_free().

Referenced by Ensure(), Ensure(), Ensure(), and free_log_configuration().

Here is the call graph for this function:

Here is the caller graph for this function:

free_log_reference()

void free_log_reference

(

void

)

Free the log reference object.

The reference object is used to detect corresponding logs.

Definition at line 411 of file logging.c.

{
  g_free (reference);
  reference = NULL;
}

References free_log_reference(), and reference.

Referenced by free_log_reference().

Here is the call graph for this function:

Here is the caller graph for this function:

get_log_reference()

char * get_log_reference

(

void

)

Get the log reference object.

This function returns the current log reference. This enables the possibility to save or modify the current reference value.

Returns

char*

Definition at line 399 of file logging.c.

{
  return (char *) reference;
}

References get_log_reference(), and reference.

Referenced by get_log_reference().

Here is the call graph for this function:

Here is the caller graph for this function:

get_time()

gchar * get_time

(

gchar *

time_fmt

)

Returns time as specified in time_fmt strftime format.

Parameters

time_fmt

ptr to the string format to use. The strftime man page documents the conversion specification. An example time_fmt string is "%Y-%m-%d %H:%M:%S".

Returns

NULL in case the format string is NULL. A ptr to a string that contains the formatted date time value. This value must be freed using glib's g_free.

Definition at line 57 of file logging.c.

{
  time_t now;
  struct tm ts;
  gchar buf[80], *original_tz;
 
  if (!time_fmt)
    return NULL;
 
  if (log_tz)
    {
      original_tz = getenv ("TZ") ? g_strdup (getenv ("TZ")) : NULL;
      setenv ("TZ", log_tz, 1);
      tzset ();
    }
 
  /* Get the current time. */
  now = time (NULL);
 
  /* Format and print the time, "ddd yyyy-mm-dd hh:mm:ss zzz." */
  localtime_r (&now, &ts);
  strftime (buf, sizeof (buf), time_fmt, &ts);
 
  if (log_tz)
    {
      /* Revert to stored TZ. */
      if (original_tz)
        {
          setenv ("TZ", original_tz, 1);
          g_free (original_tz);
          tzset ();
        }
      else
        unsetenv ("TZ");
    }
 
  return g_strdup_printf ("%s", buf);
}

References get_time(), and log_tz.

Referenced by Ensure(), get_time(), and gvm_log_func().

Here is the call graph for this function:

Here is the caller graph for this function:

gvm_log_func()

void gvm_log_func	(	const char *	log_domain,
		GLogLevelFlags	log_level,
		const char *	message,
		gpointer	gvm_log_config_list )

Creates the formatted string and outputs it to the log destination.

Parameters

log_domain	A string containing the message's log domain.
log_level	Flags defining the message's log level.
message	A string containing the log message.
gvm_log_config_list	A pointer to the configuration linked list.

Definition at line 426 of file logging.c.

{
  gchar *prepend;
  gchar *prepend_buf;
  gchar *prepend_tmp;
  gchar *prepend_tmp1;
  gchar *tmp;
  gchar *tmpstr;
  int messagelen;
 
  /* For link list operations. */
  GSList *log_domain_list_tmp;
  gvm_logging_domain_t *log_domain_entry = NULL;
 
  /* Channel to log through. */
  GIOChannel *channel = NULL;
  GError *error = NULL;
 
  /* The default parameters to be used. The group '*' will override
   * these defaults if it's found.
   */
  gchar *prepend_format = "%t %s %p - ";
  gchar *time_format = "%Y-%m-%d %Hh%M.%S %Z";
  gchar *log_separator = ":";
  gchar *log_file = "-";
  GLogLevelFlags default_level = G_LOG_LEVEL_DEBUG;
  gchar *syslog_facility = "local0";
  gchar *syslog_ident = NULL;
 
  /* Let's load the default configuration file directives from the
   * linked list. Scanning the link list twice is inefficient but
   * leaves the source cleaner.
   */
  if (gvm_log_config_list != NULL && log_domain != NULL)
    {
      /* Go to the head of the list. */
      log_domain_list_tmp = (GSList *) gvm_log_config_list;
 
      while (log_domain_list_tmp != NULL)
        {
          gvm_logging_domain_t *entry;
 
          entry = log_domain_list_tmp->data;
 
          /* Override defaults if the current linklist group name is '*'. */
          if (g_ascii_strcasecmp (gvm_logging_domain_get_log_domain (entry),
                                  "*")
              == 0)
            {
              /* Get the list data for later use. */
              log_domain_entry = entry;
 
              /* Override defaults if the group items are not null. */
              if (gvm_logging_domain_get_prepend_string (log_domain_entry))
                prepend_format =
                  gvm_logging_domain_get_prepend_string (log_domain_entry);
              if (gvm_logging_domain_get_prepend_time_format (log_domain_entry))
                time_format =
                  gvm_logging_domain_get_prepend_time_format (log_domain_entry);
              if (gvm_logging_domain_get_log_file (log_domain_entry))
                log_file = gvm_logging_domain_get_log_file (log_domain_entry);
              if (gvm_logging_domain_get_default_level (log_domain_entry))
                default_level =
                  *gvm_logging_domain_get_default_level (log_domain_entry);
              if (gvm_logging_domain_get_log_channel (log_domain_entry))
                channel = gvm_logging_domain_get_log_channel (log_domain_entry);
              if (gvm_logging_domain_get_syslog_facility (log_domain_entry))
                syslog_facility =
                  gvm_logging_domain_get_syslog_facility (log_domain_entry);
              if (gvm_logging_domain_get_prepend_separator (log_domain_entry))
                log_separator =
                  gvm_logging_domain_get_prepend_separator (log_domain_entry);
              break;
            }
 
          /* Go to the next item. */
          log_domain_list_tmp = g_slist_next (log_domain_list_tmp);
        }
    }
 
  /* Let's load the configuration file directives if a linked list item for
   * the log domain group exists.
   */
  if (gvm_log_config_list != NULL && log_domain != NULL)
    {
      /* Go to the head of the list. */
      log_domain_list_tmp = (GSList *) gvm_log_config_list;
 
      while (log_domain_list_tmp != NULL)
        {
          gvm_logging_domain_t *entry;
 
          entry = log_domain_list_tmp->data;
 
          /* Search for the log domain in the link list. */
          if (g_ascii_strcasecmp (gvm_logging_domain_get_log_domain (entry),
                                  log_domain)
              == 0)
            {
              /* Get the list data which is an gvm_logging_t struct. */
              log_domain_entry = entry;
 
              /* Get the struct contents. */
              if (gvm_logging_domain_get_prepend_string (log_domain_entry))
                prepend_format =
                  gvm_logging_domain_get_prepend_string (log_domain_entry);
              if (gvm_logging_domain_get_prepend_time_format (log_domain_entry))
                time_format =
                  gvm_logging_domain_get_prepend_time_format (log_domain_entry);
              if (gvm_logging_domain_get_log_file (log_domain_entry))
                log_file = gvm_logging_domain_get_log_file (log_domain_entry);
              if (gvm_logging_domain_get_default_level (log_domain_entry))
                default_level =
                  *gvm_logging_domain_get_default_level (log_domain_entry);
              if (gvm_logging_domain_get_log_channel (log_domain_entry))
                channel = gvm_logging_domain_get_log_channel (log_domain_entry);
              if (gvm_logging_domain_get_syslog_facility (log_domain_entry))
                syslog_facility =
                  gvm_logging_domain_get_syslog_facility (log_domain_entry);
              if (gvm_logging_domain_get_syslog_ident (log_domain_entry))
                syslog_ident =
                  gvm_logging_domain_get_syslog_ident (log_domain_entry);
              if (gvm_logging_domain_get_prepend_separator (log_domain_entry))
                log_separator =
                  gvm_logging_domain_get_prepend_separator (log_domain_entry);
              break;
            }
 
          /* Go to the next item. */
          log_domain_list_tmp = g_slist_next (log_domain_list_tmp);
        }
    }
 
  /* If the current log entry is less severe than the specified log level,
   * let's exit.
   */
  if (default_level < log_level)
    return;
 
  /* Prepend buf is a newly allocated empty string. Makes life easier. */
  prepend_buf = g_strdup ("");
 
  /* Make the tmp pointer (for iteration) point to the format string. */
  tmp = prepend_format;
 
  while (*tmp != '\0')
    {
      /* If the current char is a % and the next one is a p, get the pid. */
      if ((*tmp == '%') && (*(tmp + 1) == 'p'))
        {
          if (reference)
            {
              prepend_tmp =
                g_strdup_printf ("%s%d%s%s", prepend_buf, (int) getpid (),
                                 log_separator, reference);
            }
          else
            {
              /* Use g_strdup, a new string returned. Store it in a tmp var
               * until we free the old one. */
              prepend_tmp =
                g_strdup_printf ("%s%d", prepend_buf, (int) getpid ());
            }
          /* Free the old string. */
          g_free (prepend_buf);
          /* Point the buf ptr to the new string. */
          prepend_buf = prepend_tmp;
          /* Skip over the two chars we've processed '%p'. */
          tmp += 2;
        }
      else if ((*tmp == '%') && (*(tmp + 1) == 't'))
        {
          /* Get time returns a newly allocated string.
           * Store it in a tmp var.
           */
          prepend_tmp1 = get_time (time_format);
          if (!prepend_tmp1)
            {
              prepend_tmp1 = g_strdup ("");
            }
          /* Use g_strdup. New string returned. Store it in a tmp var until
           * we free the old one.
           */
          prepend_tmp = g_strdup_printf ("%s%s", prepend_buf, prepend_tmp1);
          /* Free the time tmp var. */
          g_free (prepend_tmp1);
          /* Free the old string. */
          g_free (prepend_buf);
          /* Point the buf ptr to the new string. */
          prepend_buf = prepend_tmp;
          /* Skip over the two chars we've processed '%t.' */
          tmp += 2;
        }
      else if ((*tmp == '%') && (*(tmp + 1) == 's'))
        {
          /* Use g_strdup. New string returned. Store it in a tmp var until
           * we free the old one.
           */
          prepend_tmp = g_strdup_printf ("%s%s", prepend_buf, log_separator);
          /* Free the old string. */
          g_free (prepend_buf);
          /* Point the buf ptr to the new string. */
          prepend_buf = prepend_tmp;
          /* Skip over the two chars we've processed '%s.' */
          tmp += 2;
        }
      else
        {
          /* Jump to the next character. */
          tmp++;
        }
    }
 
  /* Step through all possible messages prefixing them with an appropriate
   * tag.
   */
  switch (log_level)
    {
    case G_LOG_FLAG_RECURSION:
      prepend = g_strdup_printf ("RECURSION%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_FLAG_FATAL:
      prepend = g_strdup_printf ("FATAL%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_ERROR:
      prepend = g_strdup_printf ("ERROR%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_CRITICAL:
      prepend = g_strdup_printf ("CRITICAL%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_WARNING:
      prepend = g_strdup_printf ("WARNING%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_MESSAGE:
      prepend = g_strdup_printf ("MESSAGE%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_INFO:
      prepend = g_strdup_printf ("   INFO%s%s", log_separator, prepend_buf);
      break;
 
    case G_LOG_LEVEL_DEBUG:
      prepend = g_strdup_printf ("  DEBUG%s%s", log_separator, prepend_buf);
      break;
 
    default:
      prepend = g_strdup_printf ("UNKNOWN%s%s", log_separator, prepend_buf);
      break;
    }
 
  /* If the current log entry is more severe than the specified log
   * level, print out the message.  In case MESSAGE already ends in a
   * LF and there is not only the LF, remove the LF to avoid empty
   * lines in the log.
   */
  messagelen = message ? strlen (message) : 0;
  if (messagelen > 1 && message[messagelen - 1] == '\n')
    messagelen--;
  tmpstr = g_strdup_printf ("%s%s%s%s %.*s\n", log_domain ? log_domain : "",
                            log_separator, prepend, log_separator, messagelen,
                            message);
  g_free (prepend);
 
  if (log_level <= G_LOG_LEVEL_WARNING)
    gvm_sentry_log (message);
 
  gvm_log_lock ();
  /* Output everything to stderr if logfile is NULL, an empty string or "-". */
  if (!log_file || g_ascii_strcasecmp (log_file, "-") == 0
      || !g_strcmp0 (log_file, ""))
    {
      fprintf (stderr, "%s", tmpstr);
      fflush (stderr);
    }
  /* Output everything to syslog if logfile is "syslog" */
  else if (g_ascii_strcasecmp (log_file, "syslog") == 0)
    {
      int facility = facility_int_from_string (syslog_facility);
      int syslog_level = LOG_INFO;
 
      openlog (syslog_ident, LOG_CONS | LOG_PID | LOG_NDELAY, facility);
 
      switch (log_level)
        {
        case G_LOG_FLAG_FATAL:
          syslog_level = LOG_ALERT;
          break;
        case G_LOG_LEVEL_ERROR:
          syslog_level = LOG_ERR;
          break;
        case G_LOG_LEVEL_CRITICAL:
          syslog_level = LOG_CRIT;
          break;
        case G_LOG_LEVEL_WARNING:
          syslog_level = LOG_WARNING;
          break;
        case G_LOG_LEVEL_MESSAGE:
          syslog_level = LOG_NOTICE;
          break;
        case G_LOG_LEVEL_INFO:
          syslog_level = LOG_INFO;
          break;
        case G_LOG_LEVEL_DEBUG:
          syslog_level = LOG_DEBUG;
          break;
        default:
          syslog_level = LOG_INFO;
          break;
        }
 
      /* Syslog doesn't support messages longer than 1kb. The overflow data
         will not be logged or will be shown in the hypervisor console
         if it runs on a virtual machine. */
      if (messagelen > 1000)
        {
          int pos;
          char *message_aux, *message_aux2;
          char buffer[1000];
 
          message_aux2 = g_strdup (message);
          message_aux = message_aux2;
          for (pos = 0; pos <= messagelen; pos = pos + sizeof (buffer) - 1)
            {
              memcpy (buffer, message_aux, sizeof (buffer) - 1);
              buffer[sizeof (buffer) - 1] = '\0';
              message_aux = &(message_aux[sizeof (buffer) - 1]);
              syslog (syslog_level, "%s", buffer);
            }
          g_free (message_aux2);
        }
      else
        syslog (syslog_level, "%s", message);
 
      closelog ();
    }
  else
    {
      /* Open a channel and store it in the struct or
       * retrieve and use an already existing channel.
       */
      if (channel == NULL)
        {
          channel = g_io_channel_new_file (log_file, "a", &error);
          if (!channel)
            {
              gchar *log = g_strdup (log_file);
              gchar *dir = dirname (log);
 
              /* Check error. In case of the directory does not exist, it will
               * be handle below. In other case a message is printed to the
               * stderr since the channel is still not created/accessible.
               */
              if (error->code != G_FILE_ERROR_NOENT)
                fprintf (stderr, "Can not open '%s' logfile: %s\n", log_file,
                         error->message);
              g_error_free (error);
 
              /* Ensure directory exists. */
              if (g_mkdir_with_parents (dir, 0755)) /* "rwxr-xr-x" */
                {
                  g_warning ("Failed to create log file directory %s: %s", dir,
                             strerror (errno));
                  g_free (log);
                  g_free (tmpstr);
                  g_free (prepend_buf);
                  return;
                }
              g_free (log);
 
              /* Try again. */
              error = NULL;
              channel = g_io_channel_new_file (log_file, "a", &error);
              if (!channel)
                {
                  g_error ("Can not open '%s' logfile: %s", log_file,
                           error->message);
                }
            }
 
          /* Store it in the struct for later use. */
          if (log_domain_entry != NULL)
            gvm_logging_domain_set_log_channel (log_domain_entry, channel);
        }
      g_io_channel_write_chars (channel, (const gchar *) tmpstr, -1, NULL,
                                &error);
      g_io_channel_flush (channel, NULL);
    }
  gvm_log_unlock ();
  g_free (tmpstr);
  g_free (prepend_buf);
}

References facility_int_from_string(), get_time(), gvm_log_func(), gvm_log_lock(), gvm_log_unlock(), gvm_logging_domain_get_default_level(), gvm_logging_domain_get_log_channel(), gvm_logging_domain_get_log_domain(), gvm_logging_domain_get_log_file(), gvm_logging_domain_get_prepend_separator(), gvm_logging_domain_get_prepend_string(), gvm_logging_domain_get_prepend_time_format(), gvm_logging_domain_get_syslog_facility(), gvm_logging_domain_get_syslog_ident(), gvm_logging_domain_set_log_channel(), gvm_sentry_log(), and reference.

Referenced by gvm_log_func(), and setup_log_handlers().

Here is the call graph for this function:

Here is the caller graph for this function:

gvm_log_lock()

void gvm_log_lock

(

void

)

Try to lock logger_mutex.

Definition at line 351 of file logging.c.

{
  /* Initialize logger lock if not done already. */
  gvm_log_lock_init ();
 
  g_mutex_lock (logger_mutex);
}

References gvm_log_lock(), gvm_log_lock_init(), and logger_mutex.

Referenced by gvm_log_func(), and gvm_log_lock().

Here is the call graph for this function:

Here is the caller graph for this function:

gvm_log_silent()

void gvm_log_silent	(	const char *	log_domain,
		GLogLevelFlags	log_level,
		const char *	message,
		gpointer	gvm_log_config_list )

Returns immediately.

Parameters

log_domain	A string containing the message's log domain.
log_level	Flags defining the message's log level.
message	A string containing the log message.
gvm_log_config_list	A pointer to the configuration linked list.

Definition at line 322 of file logging.c.

{
  (void) log_domain;
  (void) log_level;
  (void) message;
  (void) gvm_log_config_list;
  return;
}

References gvm_log_silent().

Referenced by gvm_log_silent().

Here is the call graph for this function:

Here is the caller graph for this function:

gvm_log_unlock()

void gvm_log_unlock

(

void

)

Unlock logger_mutex.

Definition at line 363 of file logging.c.

{
  g_mutex_unlock (logger_mutex);
}

References gvm_log_unlock(), and logger_mutex.

Referenced by gvm_log_func(), and gvm_log_unlock().

Here is the call graph for this function:

Here is the caller graph for this function:

load_log_configuration()

GSList * load_log_configuration

(

const gchar *

config_file

)

Loads parameters from a config file into a linked list.

Parameters

config_file

A string containing the path to the configuration file to load.

Returns

NULL in case the config file could not be loaded or an error occurred otherwise, a singly linked list of parameter groups is returned.

Definition at line 161 of file logging.c.

{
  GKeyFile *key_file;
  GKeyFileFlags flags;
  GError *error = NULL;
  /* key_file *_has_* functions requires this. */
 
  // FIXME: If a g_* function that takes error fails, then free error.
 
  /* Groups found in the conf file. */
  gchar **groups;
  /* Temp variable to iterate over groups. */
  gchar **group;
 
  /* The link list for the structure above and it's tmp helper */
  GSList *log_domain_list = NULL;
 
  /* Create a new GKeyFile object and a bitwise list of flags. */
  key_file = g_key_file_new ();
  flags = G_KEY_FILE_KEEP_COMMENTS | G_KEY_FILE_KEEP_TRANSLATIONS;
 
  /* Load the GKeyFile from conf or return. */
  if (!g_key_file_load_from_file (key_file, config_file, flags, &error))
    {
      g_error ("%s:  %s", config_file, error->message);
    }
 
  /* Get all the groups available. */
  groups = g_key_file_get_groups (key_file, NULL);
 
  /* Point to the group head. */
  group = groups;
  /* Iterate till we get to the end of the array. */
  while (*group != NULL)
    {
      /* Structure to hold per group settings. */
      gvm_logging_domain_t *log_domain_entry =
        gvm_logging_domain_new (g_strdup (*group));
 
      /* Look for the prepend string. */
      if (g_key_file_has_key (key_file, *group, "prepend", &error))
        {
          gvm_logging_domain_set_prepend_string (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "prepend", &error));
        }
 
      /* Look for the log_separator string. */
      if (g_key_file_has_key (key_file, *group, "separator", &error))
        {
          gvm_logging_domain_set_prepend_separator (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "separator", &error));
        }
 
      /* Look for the prepend time format string. */
      if (g_key_file_has_key (key_file, *group, "prepend_time_format", &error))
        {
          gvm_logging_domain_set_prepend_time_format (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "prepend_time_format",
                                  &error));
        }
 
      /* Look for the log file string. */
      if (g_key_file_has_key (key_file, *group, "file", &error))
        {
          gvm_logging_domain_set_log_file (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "file", &error));
        }
 
      /* Look for the prepend log level string. */
      if (g_key_file_has_key (key_file, *group, "level", &error))
        {
          gchar *level;
 
          level = g_key_file_get_value (key_file, *group, "level", &error);
          level = g_strchug (level);
          gvm_logging_domain_set_default_level (log_domain_entry,
                                                level_int_from_string (level));
          g_free (level);
        }
 
      /* Look for the syslog_facility string. */
      if (g_key_file_has_key (key_file, *group, "syslog_facility", &error))
        {
          gvm_logging_domain_set_syslog_facility (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "syslog_facility", &error));
        }
      else
        gvm_logging_domain_set_syslog_facility (log_domain_entry,
                                                g_strdup ("local0"));
 
      /* Look for the syslog_ident string. */
      if (g_key_file_has_key (key_file, *group, "syslog_ident", &error))
        {
          gvm_logging_domain_set_syslog_ident (
            log_domain_entry,
            g_key_file_get_value (key_file, *group, "syslog_ident", &error));
        }
      else
        gvm_logging_domain_set_syslog_ident (log_domain_entry,
                                             g_strdup (*group));
 
      /* Attach the struct to the list. */
      log_domain_list = g_slist_prepend (log_domain_list, log_domain_entry);
      group++;
    }
  /* Free the groups array. */
  g_strfreev (groups);
 
  /* Free the key file. */
  g_key_file_free (key_file);
 
  return log_domain_list;
}

References gvm_logging_domain_new(), gvm_logging_domain_set_default_level(), gvm_logging_domain_set_log_file(), gvm_logging_domain_set_prepend_separator(), gvm_logging_domain_set_prepend_string(), gvm_logging_domain_set_prepend_time_format(), gvm_logging_domain_set_syslog_facility(), gvm_logging_domain_set_syslog_ident(), level_int_from_string(), and load_log_configuration().

Referenced by Ensure(), Ensure(), Ensure(), and load_log_configuration().

Here is the call graph for this function:

Here is the caller graph for this function:

log_func_for_gnutls()

void log_func_for_gnutls	(	int	level,
		const char *	message )

This function logs debug messages from gnutls.

Parameters

level	GnuTLS log level (integer from 0 to 99 according to GnuTLS documentation.
message	GnuTLS log message.

To enable GNUTLS debug messages, the environment variable OPENVAS_GNUTLS_DEBUG is to be set to the desired log level as described in the GNUTLS manual.

Definition at line 836 of file logging.c.

{
  g_log ("x  gnutls", G_LOG_LEVEL_INFO, "tls(%d): %s", level, message);
}

References log_func_for_gnutls().

Referenced by log_func_for_gnutls().

Here is the call graph for this function:

Here is the caller graph for this function:

set_log_reference()

void set_log_reference

(

char *

ref

)

Set the log reference object.

In order to be able to see which logs are related to each other, we define a common reference for them. E.g. when multiple scans in OpenVAS are running simultaniousely it is possible to detect all log corresponding to the same scan. The log reference is optional and must be set before calling setup_log_handlers. The data given must be freed by calling free_log_reference(). If called multiple times the old reference gets freed and the new one is set instead.

Parameters

ref

Definition at line 384 of file logging.c.

{
  g_free (reference);
  reference = ref;
}

References reference, and set_log_reference().

Referenced by set_log_reference().

Here is the call graph for this function:

Here is the caller graph for this function:

set_log_tz()

void set_log_tz

(

const gchar *

tz

)

Set the log timezone.

This is the timezone used for dates in log messages. If NULL then the current timezone is used.

Parameters

tz

Timezone.

Definition at line 901 of file logging.c.

{
  g_free (log_tz);
  log_tz = tz ? g_strdup (tz) : NULL;
}

References log_tz, and set_log_tz().

Referenced by set_log_tz().

Here is the call graph for this function:

Here is the caller graph for this function:

setup_log_handlers()

int setup_log_handlers

(

GSList *

gvm_log_config_list

)

Sets up routing of logdomains to log handlers.

Iterates over the link list and adds the groups to the handler.

Parameters

gvm_log_config_list

A pointer to the configuration linked list.

Returns

0 on success, -1 if not able to create log file directory or open log file for some domain.

Definition at line 979 of file logging.c.

{
  return setup_log_handlers_internal (gvm_log_config_list, gvm_log_func,
                                      gvm_log_func, gvm_log_func);
}

References gvm_log_func(), setup_log_handlers(), and setup_log_handlers_internal().

Referenced by setup_log_handlers().

Here is the call graph for this function:

Here is the caller graph for this function: