One Level Up Top Level

src/core/ngx_syslog.c - nginx-1.7.10

Global variables defined

Functions defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Nginx, Inc.
  4. */


  7. #include <ngx_config.h>
  8. #include <ngx_core.h>
  9. #include <ngx_event.h>


  12. ‌#define NGX_SYSLOG_MAX_STR                                                    \
  13.      NGX_MAX_ERROR_STR + sizeof("<255>Jan 01 00:00:00 ") - 1                  \
  14.      + (NGX_MAXHOSTNAMELEN - 1) + 1 /* space */                               \
  15.      + 32 /* tag */ + 2 /* colon, space */


  18. static char *ngx_syslog_parse_args(ngx_conf_t *cf, ngx_syslog_peer_t *peer);
  19. static ngx_int_t ngx_syslog_init_peer(ngx_syslog_peer_t *peer);
  20. static void ngx_syslog_cleanup(void *data);


  23. ‌static char  *facilities[] = {
  24.     "kern", "user", "mail", "daemon", "auth", "intern", "lpr", "news", "uucp",
  25.     "clock", "authpriv", "ftp", "ntp", "audit", "alert", "cron", "local0",
  26.     "local1", "local2", "local3", "local4", "local5", "local6", "local7",
  27.     NULL
  28. };

  30. /* note 'error/warn' like in nginx.conf, not 'err/warning' */
  31. ‌static char  *severities[] = {
  32.     "emerg", "alert", "crit", "error", "warn", "notice", "info", "debug", NULL
  33. };

  35. ‌static ngx_log_t    ngx_syslog_dummy_log;
  36. ‌static ngx_event_t  ngx_syslog_dummy_event;


  39. char *
  40. ‌ngx_syslog_process_conf(ngx_conf_t *cf, ngx_syslog_peer_t *peer)
  41. {
  42.     peer->pool = cf->pool;
  43.     peer->facility = NGX_CONF_UNSET_UINT;
  44.     peer->severity = NGX_CONF_UNSET_UINT;

  46.     if (ngx_syslog_parse_args(cf, peer) != NGX_CONF_OK) {
  47.         return NGX_CONF_ERROR;
  48.     }

  50.     if (peer->server.sockaddr == NULL) {
  51.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  52.                            "no syslog server specified");
  53.         return NGX_CONF_ERROR;
  54.     }

  56.     if (peer->facility == NGX_CONF_UNSET_UINT) {
  57.         peer->facility = 23; /* local7 */
  58.     }

  60.     if (peer->severity == NGX_CONF_UNSET_UINT) {
  61.         peer->severity = 6; /* info */
  62.     }

  64.     if (peer->tag.data == NULL) {
  65.         ngx_str_set(&peer->tag, "nginx");
  66.     }

  68.     peer->conn.fd = (ngx_socket_t) -1;

  70.     return NGX_CONF_OK;
  71. }


  74. static char *
  75. ‌ngx_syslog_parse_args(ngx_conf_t *cf, ngx_syslog_peer_t *peer)
  76. {
  77.     u_char      *p, *comma, c;
  78.     size_t       len;
  79.     ngx_str_t   *value;
  80.     ngx_url_t    u;
  81.     ngx_uint_t   i;

  83.     value = cf->args->elts;

  85.     p = value[1].data + sizeof("syslog:") - 1;

  87.     for ( ;; ) {
  88.         comma = (u_char *) ngx_strchr(p, ',');

  90.         if (comma != NULL) {
  91.             len = comma - p;
  92.             *comma = '\0';

  94.         } else {
  95.             len = value[1].data + value[1].len - p;
  96.         }

  98.         if (ngx_strncmp(p, "server=", 7) == 0) {

  100.             if (peer->server.sockaddr != NULL) {
  101.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  102.                                    "duplicate syslog \"server\"");
  103.                 return NGX_CONF_ERROR;
  104.             }

  106.             ngx_memzero(&u, sizeof(ngx_url_t));

  108.             u.url.data = p + 7;
  109.             u.url.len = len - 7;
  110.             u.default_port = 514;

  112.             if (ngx_parse_url(cf->pool, &u) != NGX_OK) {
  113.                 if (u.err) {
  114.                     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  115.                                        "%s in syslog server \"%V\"",
  116.                                        u.err, &u.url);
  117.                 }

  119.                 return NGX_CONF_ERROR;
  120.             }

  122.             peer->server = u.addrs[0];

  124.         } else if (ngx_strncmp(p, "facility=", 9) == 0) {

  126.             if (peer->facility != NGX_CONF_UNSET_UINT) {
  127.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  128.                                    "duplicate syslog \"facility\"");
  129.                 return NGX_CONF_ERROR;
  130.             }

  132.             for (i = 0; facilities[i] != NULL; i++) {

  134.                 if (ngx_strcmp(p + 9, facilities[i]) == 0) {
  135.                     peer->facility = i;
  136.                     goto next;
  137.                 }
  138.             }

  140.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  141.                                "unknown syslog facility \"%s\"", p + 9);
  142.             return NGX_CONF_ERROR;

  144.         } else if (ngx_strncmp(p, "severity=", 9) == 0) {

  146.             if (peer->severity != NGX_CONF_UNSET_UINT) {
  147.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  148.                                    "duplicate syslog \"severity\"");
  149.                 return NGX_CONF_ERROR;
  150.             }

  152.             for (i = 0; severities[i] != NULL; i++) {

  154.                 if (ngx_strcmp(p + 9, severities[i]) == 0) {
  155.                     peer->severity = i;
  156.                     goto next;
  157.                 }
  158.             }

  160.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  161.                                "unknown syslog severity \"%s\"", p + 9);
  162.             return NGX_CONF_ERROR;

  164.         } else if (ngx_strncmp(p, "tag=", 4) == 0) {

  166.             if (peer->tag.data != NULL) {
  167.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  168.                                    "duplicate syslog \"tag\"");
  169.                 return NGX_CONF_ERROR;
  170.             }

  172.             /*
  173.              * RFC 3164: the TAG is a string of ABNF alphanumeric characters
  174.              * that MUST NOT exceed 32 characters.
  175.              */
  176.             if (len - 4 > 32) {
  177.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  178.                                    "syslog tag length exceeds 32");
  179.                 return NGX_CONF_ERROR;
  180.             }

  182.             for (i = 4; i < len; i++) {
  183.                 c = ngx_tolower(p[i]);

  185.                 if (c < '0' || (c > '9' && c < 'a' && c != '_') || c > 'z') {
  186.                     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  187.                                        "syslog \"tag\" only allows "
  188.                                        "alphanumeric characters "
  189.                                        "and underscore");
  190.                     return NGX_CONF_ERROR;
  191.                 }
  192.             }

  194.             peer->tag.data = p + 4;
  195.             peer->tag.len = len - 4;

  197.         } else {
  198.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  199.                                "unknown syslog parameter \"%s\"", p);
  200.             return NGX_CONF_ERROR;
  201.         }

  203.     next:

  205.         if (comma == NULL) {
  206.             break;
  207.         }

  209.         p = comma + 1;
  210.     }

  212.     return NGX_CONF_OK;
  213. }


  216. u_char *
  217. ‌ngx_syslog_add_header(ngx_syslog_peer_t *peer, u_char *buf)
  218. {
  219.     ngx_uint_t  pri;

  221.     pri = peer->facility * 8 + peer->severity;

  223.     return ngx_sprintf(buf, "<%ui>%V %V %V: ", pri, &ngx_cached_syslog_time,
  224.                        &ngx_cycle->hostname, &peer->tag);
  225. }


  228. void
  229. ‌ngx_syslog_writer(ngx_log_t *log, ngx_uint_t level, u_char *buf,
  230.     size_t len)
  231. {
  232.     u_char             *p, msg[NGX_SYSLOG_MAX_STR];
  233.     ngx_uint_t          head_len;
  234.     ngx_syslog_peer_t  *peer;

  236.     peer = log->wdata;

  238.     if (peer->busy) {
  239.         return;
  240.     }

  242.     peer->busy = 1;
  243.     peer->severity = level - 1;

  245.     p = ngx_syslog_add_header(peer, msg);
  246.     head_len = p - msg;

  248.     len -= NGX_LINEFEED_SIZE;

  250.     if (len > NGX_SYSLOG_MAX_STR - head_len) {
  251.         len = NGX_SYSLOG_MAX_STR - head_len;
  252.     }

  254.     p = ngx_snprintf(p, len, "%s", buf);

  256.     (void) ngx_syslog_send(peer, msg, p - msg);

  258.     peer->busy = 0;
  259. }


  262. ssize_t
  263. ‌ngx_syslog_send(ngx_syslog_peer_t *peer, u_char *buf, size_t len)
  264. {
  265.     ssize_t  n;

  267.     if (peer->conn.fd == (ngx_socket_t) -1) {
  268.         if (ngx_syslog_init_peer(peer) != NGX_OK) {
  269.             return NGX_ERROR;
  270.         }
  271.     }

  273.     /* log syslog socket events with valid log */
  274.     peer->conn.log = ngx_cycle->log;

  276.     if (ngx_send) {
  277.         n = ngx_send(&peer->conn, buf, len);

  279.     } else {
  280.         /* event module has not yet set ngx_io */
  281.         n = ngx_os_io.send(&peer->conn, buf, len);
  282.     }

  284. #if (NGX_HAVE_UNIX_DOMAIN)

  286.     if (n == NGX_ERROR && peer->server.sockaddr->sa_family == AF_UNIX) {

  288.         if (ngx_close_socket(peer->conn.fd) == -1) {
  289.             ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  290.                           ngx_close_socket_n " failed");
  291.         }

  293.         peer->conn.fd = (ngx_socket_t) -1;
  294.     }

  296. #endif

  298.     return n;
  299. }


  302. static ngx_int_t
  303. ‌ngx_syslog_init_peer(ngx_syslog_peer_t *peer)
  304. {
  305.     ngx_socket_t         fd;
  306.     ngx_pool_cleanup_t  *cln;

  308.     peer->conn.read = &ngx_syslog_dummy_event;
  309.     peer->conn.write = &ngx_syslog_dummy_event;

  311.     ngx_syslog_dummy_event.log = &ngx_syslog_dummy_log;

  313.     fd = ngx_socket(peer->server.sockaddr->sa_family, SOCK_DGRAM, 0);
  314.     if (fd == (ngx_socket_t) -1) {
  315.         ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  316.                       ngx_socket_n " failed");
  317.         return NGX_ERROR;
  318.     }

  320.     if (ngx_nonblocking(fd) == -1) {
  321.         ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  322.                       ngx_nonblocking_n " failed");
  323.         goto failed;
  324.     }

  326.     if (connect(fd, peer->server.sockaddr, peer->server.socklen) == -1) {
  327.         ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  328.                       "connect() failed");
  329.         goto failed;
  330.     }

  332.     cln = ngx_pool_cleanup_add(peer->pool, 0);
  333.     if (cln == NULL) {
  334.         goto failed;
  335.     }

  337.     cln->data = peer;
  338.     cln->handler = ngx_syslog_cleanup;

  340.     peer->conn.fd = fd;

  342.     /* UDP sockets are always ready to write */
  343.     peer->conn.write->ready = 1;

  345.     return NGX_OK;

  347. failed:

  349.     if (ngx_close_socket(fd) == -1) {
  350.         ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  351.                       ngx_close_socket_n " failed");
  352.     }

  354.     return NGX_ERROR;
  355. }


  358. static void
  359. ‌ngx_syslog_cleanup(void *data)
  360. {
  361.     ngx_syslog_peer_t  *peer = data;

  363.     /* prevents further use of this peer */
  364.     peer->busy = 1;

  366.     if (peer->conn.fd == (ngx_socket_t) -1) {
  367.         return;
  368.     }

  370.     if (ngx_close_socket(peer->conn.fd) == -1) {
  371.         ngx_log_error(NGX_LOG_ALERT, ngx_cycle->log, ngx_socket_errno,
  372.                       ngx_close_socket_n " failed");
  373.     }
  374. }

One Level Up Top Level