модуль Syslog

static VALUE mSyslog_close(VALUE self)
{
    if (!syslog_opened) {
        rb_raise(rb_eRuntimeError, "syslog not opened");
    }

    closelog();

    xfree((void *)syslog_ident);
    syslog_ident = NULL;
    syslog_options = syslog_facility = syslog_mask = -1;
    syslog_opened = 0;

    return Qnil;
}

Закрывает систему ведения журналов syslog. Вызывает исключение runtime, если она не открыта.

static VALUE mSyslog_facility(VALUE self)
{
    return syslog_opened ? INT2NUM(syslog_facility) : Qnil;
}

Возвращает номер объекта facility, использованный в последнем вызове open()

static VALUE mSyslog_ident(VALUE self)
{
    return syslog_opened ? rb_str_new2(syslog_ident) : Qnil;
}

Возвращает строку идентификатора, использованную в последнем вызове open()

static VALUE mSyslog_inspect(VALUE self)
{
    Check_Type(self, T_MODULE);

    if (!syslog_opened)
        return rb_sprintf("<#%"PRIsVALUE": opened=false>", self);

    return rb_sprintf("<#%"PRIsVALUE": opened=true, ident=\"%s\", options=%d, facility=%d, mask=%d>",
                      self,
                      syslog_ident,
                      syslog_options,
                      syslog_facility,
                      syslog_mask);
}

Возвращает строку inspect(), описывающую состояние объекта.

static VALUE mSyslog_instance(VALUE self)
{
    return self;
}

Возвращает self для обратной совместимости.

static VALUE mSyslog_log(int argc, VALUE *argv, VALUE self)
{
    VALUE pri;

    rb_check_arity(argc, 2, UNLIMITED_ARGUMENTS);

    argc--;
    pri = *argv++;

    if (!FIXNUM_P(pri)) {
        rb_raise(rb_eTypeError, "type mismatch: %"PRIsVALUE" given", rb_obj_class(pri));
    }

    syslog_write(FIX2INT(pri), argc, argv);

    return self;
}

Регистрирует сообщение с указанным приоритетом. Пример:

Syslog.log(Syslog::LOG_CRIT, "Out of disk space")
Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER'])

Уровни приоритетов, в порядке убывания:

LOG_EMERG

Система непригодна для использования

LOG_ALERT

Необходимо немедленное действие

LOG_CRIT

Произошла критическая ситуация

LOG_ERR

Произошла ошибка

LOG_WARNING

Warning о возможной проблеме

LOG_NOTICE

Произошло нормальное, но существенное событие

LOG_INFO

Информационное сообщение

LOG_DEBUG

Отладочная информация

Каждый уровень приоритета также имеет сокращённый метод, который регистрирует сообщение с соответствующим приоритетом. Например, следующие два утверждения дадут одинаковый результат:

Syslog.log(Syslog::LOG_ALERT, "Out of memory")
Syslog.alert("Out of memory")

static VALUE mSyslog_get_mask(VALUE self)
{
    return syslog_opened ? INT2NUM(syslog_mask) : Qnil;
}

Возвращает маску приоритетов регистрации, которая в настоящее время используется. Маска не сбрасывается при открытии или закрытии syslog.

static VALUE mSyslog_set_mask(VALUE self, VALUE mask)
{
    if (!syslog_opened) {
        rb_raise(rb_eRuntimeError, "must open syslog before setting log mask");
    }

    setlogmask(syslog_mask = NUM2INT(mask));

    return mask;
}

Устанавливает маску приоритетов регистрации. Для удобства установки значений маски определён метод LOG_UPTO. Пример:

Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR)

В качестве альтернативы, можно выбрать и добавить определённые приоритеты, используя бинарное ИЛИ. Пример:

Syslog.mask = Syslog::LOG_MASK(Syslog::LOG_ERR) | Syslog::LOG_MASK(Syslog::LOG_CRIT)

Маска приоритетов сохраняется при вызовах open() и close().

static VALUE mSyslog_open(int argc, VALUE *argv, VALUE self)
{
    VALUE ident, opt, fac;
    const char *ident_ptr;

    if (syslog_opened) {
        rb_raise(rb_eRuntimeError, "syslog already open");
    }

    rb_scan_args(argc, argv, "03", &ident, &opt, &fac);

    if (NIL_P(ident)) {
        ident = rb_gv_get("$0");
    }
    ident_ptr = StringValueCStr(ident);
    syslog_ident = strdup(ident_ptr);

    if (NIL_P(opt)) {
        syslog_options = LOG_PID | LOG_CONS;
    } else {
        syslog_options = NUM2INT(opt);
    }

    if (NIL_P(fac)) {
        syslog_facility = LOG_USER;
    } else {
        syslog_facility = NUM2INT(fac);
    }

    openlog(syslog_ident, syslog_options, syslog_facility);

    syslog_opened = 1;

    setlogmask(syslog_mask = setlogmask(0));

    /* be like File.new.open {...} */
    if (rb_block_given_p()) {
        rb_ensure(rb_yield, self, mSyslog_close, self);
    }

    return self;
}

Открывает систему ведения журналов syslog. Вызывает исключение runtime, если она уже открыта.

Может вызываться с или без блока кода. Если вызывается с блоком, созданный объект Syslog передаётся в блок.

Если syslog уже открыт, вызывает исключение RuntimeError.

ident — это String, который идентифицирует вызывающую программу.

options — это логическое ИЛИ любого из следующих:

LOG_CONS

Если при отправке в систему ведения журналов возникает ошибка, записывать непосредственно в консоль.

LOG_NDELAY

Открыть подключение сейчас, а не ждать первого сообщения для записи.

LOG_NOWAIT

Не ждать каких-либо дочерних процессов, созданных во время записи сообщений. (Не имеет эффекта на Linux.)

LOG_ODELAY

Противоположность LOG_NDELAY; ждать, пока сообщение не будет отправлено, прежде чем открывать подключение. (Это по умолчанию.)

LOG_PERROR

Выводить сообщение также в stderr, помимо отправки в syslog. (Нет в POSIX.1-2001.)

LOG_PID

Включать текущий идентификатор процесса в каждое сообщение.

facility описывает тип программы, открывающей syslog, и является логическим ИЛИ любого из следующих, определённых для операционной системы:

LOG_AUTH

Безопасность или авторизация. Устарело, используйте LOG_AUTHPRIV вместо этого.

LOG_AUTHPRIV

Сообщения безопасности или авторизации, которые должны быть скрыты.

LOG_CONSOLE

Сообщений системной консоли.

LOG_CRON

Система планирования задач (cron или at).

LOG_DAEMON

Системный демон, у которого нет собственного значения объекта facility.

LOG_FTP

Сервер FTP.

LOG_KERN

Сообщение ядра (не отправляемое пользовательскими процессами, поэтому не очень полезно для Ruby, но включено здесь для полноты).

LOG_LPR

Подсистема принтера.

LOG_MAIL

Подсистема доставки или передачи почты.

LOG_NEWS

Система новостей Usenet.

LOG_NTP

Сервер протокола сетевого времени.

LOG_SECURITY

Общее сообщение о безопасности.

LOG_SYSLOG

Сообщения, сгенерированные внутренней системой syslog.

LOG_USER

Общее сообщение на уровне пользователя.

LOG_UUCP

Подсистема UUCP.

LOG_LOCAL0 to LOG_LOCAL7

Локально определённые объекты facility.

Пример:

Syslog.open("webrick", Syslog::LOG_PID,
            Syslog::LOG_DAEMON | Syslog::LOG_LOCAL3)

static VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self)
{
    mSyslog_close(self);

    return mSyslog_open(argc, argv, self);
}

Закрывает и затем снова открывает syslog.

Аргументы такие же, как и для open().

static VALUE mSyslog_isopen(VALUE self)
{
    return syslog_opened ? Qtrue : Qfalse;
}

Возвращает true, если syslog открыт.

static VALUE mSyslog_options(VALUE self)
{
    return syslog_opened ? INT2NUM(syslog_options) : Qnil;
}

Возвращает битовую маску опций, используемую в последнем вызове open()

static VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self)
{
    mSyslog_close(self);

    return mSyslog_open(argc, argv, self);
}

Закрывает и затем снова открывает syslog.

Аргументы такие же, как и для open().