Skip to content

chapters chapter_0 section_3

Jump to bottom
Hofi edited this page Jan 15, 2024 · 1 revision

macOS

Introduction

The syslog-ng application has been resurrected on macOS by our developer team. We hope our product can be useful for Mac users who want to increase the security of their system through reliable logging.

At present we are not supporting macOS syslog-ng on our official repository on GitHub. However, you can compile syslog-ng yourself following this guide.

Note: the guide is tested on ARM macOS Ventura 13.4, and Intel macOS Monterey 12.6.6 machines, we do our bests to keep it update, but your actual system may require additional steps or slightly different settings.

Compiling from source

Like every project syslog-ng also uses different libraries and build-systems that must be installed for compiling and running properly. These dependencies can be satisfied by compiling every-each libs and tools manually, but it might be preferred to do it the easy way. Homebrew is a package manager for macOS that has great community and support. You can also use it to install the dependencies you need.

Dependencies

  1. Install Homebrew on your system.

    Hint: Don't forget to add homebrew to your path, follow the instructions in your terminal!

    Note: This will install Command Line Tools for Xcode as well if not already prresented on the system that would also be required anyway for a seamless syslog-ng build.

  2. Perform brew update if you have not done it yet.

  3. The following packages should be installed for syslog-ng:

    • automake
    • autoconf
    • autoconf-archive
    • binutils
    • bison
    • flex
    • glib
    • ivykis
    • json-c
    • libtool
    • pcre
    • pkg-config
    • openssl

  4. The following package might be needed too depending on your macOS version and architecture:

    • net-snmp

  5. The extra modules would require the following

    • hiredis
    • libdbi - See bellow!
    • libmaxminddb
    • libnet
    • librdkafka
    • mongo-c-driver
    • python3
    • rabbitmq-c
    • riemann-client
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

brew update

brew install \
    automake \
    autoconf \
    autoconf-archive \
    binutils \
    bison \
    flex \
    glib \
    ivykis \
    json-c \
    libtool \
    pcre \
    pkg-config \
    openssl \
    #
    net-snmp \
    #
    hiredis \
    # libdbi - Do not use the homebrew provided one, see bellow!
    libmaxminddb \
    libnet \
    librdkafka \
    mongo-c-driver \
    python3 \
    rabbitmq-c \
    riemann-client

Note:

  • bison is required to be installed when using homebrew, because the options provided by Apple Developer Tools are incomplete. (for example: missing -W option) The reason is why bison is required to be installed from homebrew is that the -W option is supported only after 2.3.
  • net-snmp might be needed as well when using homebrew, because the options provided by Apple Developer Tools are bogus a bit. The reason is why net-snmp might be required from homebrew is that the by default provided pkgconfig might give back bogus lib and include values.
  • openssl - since macOS provides LibreSSL by default, we need to expand the search path of pkg-config to find the freshly installed openSSL, see bellow.
  • libdbi and libdbi-drivers are maintained and updated in syslog-ng OSE repositories, use the latest master version from there
  • actual state of supported features, and the required dependencies can also be found here.

Preparations

  1. Depending your macOS architecture homebrew is using different location for storing its data, so worth using a generic reference to it

    export HOMEBREW_PREFIX=$(brew --prefix)

  2. Force the building process to use bison and net-snmp installed through homebrew instead of provided by Apple Developer Tools.

    • Option 1: add bison to $PATH 
    export PATH=${HOMEBREW_PREFIX}/opt/bison/bin:${HOMEBREW_PREFIX}/opt/net-snmp/bin:${PATH}
    • Option 2: when configuring set the environmental variable $YACC to bison
    export YACC=${HOMEBREW_PREFIX}/opt/bison

  3. Extend the search path of pkg-config to use the homebrew version of openssl and net-snmp

    export PKG_CONFIG_PATH=${HOMEBREW_PREFIX}/opt/openssl/lib/pkgconfig:${HOMEBREW_PREFIX}/opt/net-snmp/lib/pkgconfig:${PKG_CONFIG_PATH}

Getting the source

To get the latest master from syslog-ng git you can use

cd YOUR_PREFERRED_WORKING_DIR   # Replace `YOUR_PREFERRED_WORKING_DIR` with your actual preferred working dir 
git clone https://github.com/syslog-ng/syslog-ng .

Configuration

./autogen.sh
./configure --with-ivykis=system --disable-java

For a full feature set (excluded the not yet supported modules on macOS):

./autogen.sh
./configure --with-ivykis=system --enable-all-modules --disable-smtp --disable-mqtt --disable-java --enable-tests --enable-manpages

Note:

Compile and install

make -j4
make install

Optionally, you can specify the install prefix passing --prefix /example/installdir/ to the configure script.

Note: for options and more information, read the compile first guide.

Testing

In order to run the tests, you have to install the Criterion testing framework (for example: brew install snaipe/soft/criterion). Then use the command below:

make check -j4

Note: for more read compile first guide.

Run

./syslog-ng -F

Note: for more information read the run first guide and the syslog-ng documentation

Clone this wiki locally