syslog.module in Drupal 10

Redirects logging messages to syslog.

File

core/modules/syslog/syslog.module

<?php

/**
 * @file
 * Redirects logging messages to syslog.
 */
use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;

/**
 * Implements hook_help().
 */
function syslog_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.syslog':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Syslog module logs events by sending messages to the logging facility of your web server\'s operating system. Syslog is an operating system administrative logging tool that provides valuable information for use in system management and security auditing. Most suited to medium and large sites, Syslog provides filtering tools that allow messages to be routed by type and severity. For more information, see the <a href=":syslog">online documentation for the Syslog module</a>, as well as PHP\'s documentation pages for the <a href="http://php.net/manual/function.openlog.php">openlog</a> and <a href="http://php.net/manual/function.syslog.php">syslog</a> functions.', [
        ':syslog' => 'https://www.drupal.org/documentation/modules/syslog',
      ]) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Logging for UNIX, Linux, and Mac OS X') . '</dt>';
      $output .= '<dd>' . t('On UNIX, Linux, and Mac OS X, you will find the configuration in the file <em>/etc/syslog.conf</em>, or in <em>/etc/rsyslog.conf</em> or in the directory <em>/etc/rsyslog.d</em>. These files define the routing configuration. Messages can be flagged with the codes <code>LOG_LOCAL0</code> through <code>LOG_LOCAL7</code>. For information on Syslog facilities, severity levels, and how to set up <em>syslog.conf</em> or <em>rsyslog.conf</em>, see the <em>syslog.conf</em> or <em>rsyslog.conf</em> manual page on your command line.') . '</dd>';
      $output .= '<dt>' . t('Logging for Microsoft Windows') . '</dt>';
      $output .= '<dd>' . t('On Microsoft Windows, messages are always sent to the Event Log using the code <code>LOG_USER</code>.') . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function syslog_form_system_logging_settings_alter(&$form, FormStateInterface $form_state) {
  $config = \Drupal::configFactory()
    ->getEditable('syslog.settings');
  $help = \Drupal::moduleHandler()
    ->moduleExists('help') ? ' ' . Link::fromTextAndUrl(t('More information'), Url::fromRoute('help.page', [
    'name' => 'syslog',
  ]))
    ->toString() . '.' : NULL;
  $form['syslog_identity'] = [
    '#type' => 'textfield',
    '#title' => t('Syslog identity'),
    '#default_value' => $config
      ->get('identity'),
    '#description' => t('A string that will be prepended to every message logged to Syslog. If you have multiple sites logging to the same Syslog log file, a unique identity per site makes it easy to tell the log entries apart.') . $help,
  ];
  if (defined('LOG_LOCAL0')) {
    $form['syslog_facility'] = [
      '#type' => 'select',
      '#title' => t('Syslog facility'),
      '#default_value' => $config
        ->get('facility'),
      '#options' => syslog_facility_list(),
      '#description' => t('Depending on the system configuration, Syslog and other logging tools use this code to identify or filter messages from within the entire system log.') . $help,
    ];
  }
  $form['syslog_format'] = [
    '#type' => 'textarea',
    '#title' => t('Syslog format'),
    '#default_value' => $config
      ->get('format'),
    '#required' => TRUE,
    '#description' => t('Specify the format of the syslog entry. Available variables are: <dl><dt><code>!base_url</code></dt><dd>Base URL of the site.</dd><dt><code>!timestamp</code></dt><dd>Unix timestamp of the log entry.</dd><dt><code>!type</code></dt><dd>The category to which this message belongs.</dd><dt><code>!ip</code></dt><dd>IP address of the user triggering the message.</dd><dt><code>!request_uri</code></dt><dd>The requested URI.</dd><dt><code>!referer</code></dt><dd>HTTP Referer if available.</dd><dt><code>!severity</code></dt><dd>The severity level of the event; ranges from 0 (Emergency) to 7 (Debug).</dd><dt><code>!uid</code></dt><dd>User ID.</dd><dt><code>!link</code></dt><dd>A link to associate with the message.</dd><dt><code>!message</code></dt><dd>The message to store in the log.</dd></dl>'),
  ];
  $form['#submit'][] = 'syslog_logging_settings_submit';
}

/**
 * Form submission handler for system_logging_settings().
 *
 * @see syslog_form_system_logging_settings_alter()
 */
function syslog_logging_settings_submit($form, FormStateInterface $form_state) {
  \Drupal::configFactory()
    ->getEditable('syslog.settings')
    ->set('identity', $form_state
    ->getValue('syslog_identity'))
    ->set('facility', $form_state
    ->getValue('syslog_facility'))
    ->set('format', $form_state
    ->getValue('syslog_format'))
    ->save();
}

/**
 * Lists all possible syslog facilities for UNIX/Linux.
 *
 * @return array
 *   An array of syslog facilities for UNIX/Linux.
 */
function syslog_facility_list() {
  return [
    LOG_LOCAL0 => 'LOG_LOCAL0',
    LOG_LOCAL1 => 'LOG_LOCAL1',
    LOG_LOCAL2 => 'LOG_LOCAL2',
    LOG_LOCAL3 => 'LOG_LOCAL3',
    LOG_LOCAL4 => 'LOG_LOCAL4',
    LOG_LOCAL5 => 'LOG_LOCAL5',
    LOG_LOCAL6 => 'LOG_LOCAL6',
    LOG_LOCAL7 => 'LOG_LOCAL7',
  ];
}

Functions

Name	Description
syslog_facility_list	Lists all possible syslog facilities for UNIX/Linux.
syslog_form_system_logging_settings_alter	Implements hook_form_FORM_ID_alter().
syslog_help	Implements hook_help().
syslog_logging_settings_submit	Form submission handler for system_logging_settings().