Commit d44ccb83 authored by Geoff Simmons's avatar Geoff Simmons

update docs

parent 267905f7
...@@ -9,7 +9,7 @@ Tracking Log Reader demon ...@@ -9,7 +9,7 @@ Tracking Log Reader demon
------------------------- -------------------------
:Author: Geoffrey Simmons :Author: Geoffrey Simmons
:Date: 2014-09-04 :Date: 2015-04-26
:Version: 3.0 :Version: 3.0
:Manual section: 3 :Manual section: 3
...@@ -75,9 +75,9 @@ plugin -- a shared object that provides definitions for the functions ...@@ -75,9 +75,9 @@ plugin -- a shared object that provides definitions for the functions
declared in the MQ interface in ``include/mq.h``. See ``mq.h`` for declared in the MQ interface in ``include/mq.h``. See ``mq.h`` for
documentation of the interface. documentation of the interface.
The source distribution for ``trackrdrd`` includes an implementation The source distribution for ``trackrdrd`` includes implementations of
of the MQ interface for ActiveMQ, see libtrackrdr-activemq(3) for the MQ interface for Kafka and ActiveMQ; see libtrackrdr-activemq(3)
details. and libtrackrdr-kafka(3) for details.
EXAMPLE EXAMPLE
======= =======
...@@ -101,16 +101,10 @@ OPTIONS ...@@ -101,16 +101,10 @@ OPTIONS
BUILD/INSTALL BUILD/INSTALL
============= =============
The source repository for ``trackrdrd`` is in the subdirectory The build requires a source directory for Varnish 3.0.x in which sources
``trackrdrd/`` of:: have been compiled. It also requires the unique XID patch available at::
git@repo.org:trackrdrd https://code.uplex.de/uplex-varnish/unique-xids
The build requires a source directory for Varnish in which sources
have been compiled. Varnish sources with custom features for Otto
are in::
git@repo.org:varnish-cache
To build the messaging plugin for ActiveMQ (``libtrackrdr-activemq``) To build the messaging plugin for ActiveMQ (``libtrackrdr-activemq``)
it is neccessary to link with the CMS or ActiveMQ-CPP library it is neccessary to link with the CMS or ActiveMQ-CPP library
...@@ -118,6 +112,11 @@ it is neccessary to link with the CMS or ActiveMQ-CPP library ...@@ -118,6 +112,11 @@ it is neccessary to link with the CMS or ActiveMQ-CPP library
http://activemq.apache.org/cms/ http://activemq.apache.org/cms/
The messaging plugin for Kafka (``libtrackrdr-kafka``) requires the
rdkafka library (``librdkafka``)::
https://github.com/edenhill/librdkafka
Building Varnish Building Varnish
---------------- ----------------
...@@ -130,18 +129,15 @@ The Varnish build requires the following tools/packages: ...@@ -130,18 +129,15 @@ The Varnish build requires the following tools/packages:
* pcre-devel (so that Varnish can link to the runtime libs) * pcre-devel (so that Varnish can link to the runtime libs)
* python-docutils (for rst2man) * python-docutils (for rst2man)
Check out the repository and switch to the branch ``3.0_bestats``, in Check out the repository and apply the unique-xids patch.
which custom features for Otto are implemented::
$ git clone git@repo.org:varnish-cache
$ cd varnish-cache/
$ git checkout 3.0_bestats
Varnish as deployed for Otto is built in 64-bit mode, and since The tracking reader and the Varnish instances against which it built
``trackrdrd`` needs to link with its libraries, it must be built in and run must be built for the same architecture; in particular, they
64-bit mode as well. This means that the Varnish build for must match as to 32- or 64-bit modes (and 64-bit is strongly
``trackrdrd`` must also be 64-bit; for ``gcc``, this is accomplished recommended for Varnish). If the builds are executed on the same
with ``CFLAGS=-m64``. machine (with the same architecture on which they will run), then they
will likely match by default. When in doubt, set compile-time flags
such as ``CFLAGS=-m64`` for ``gcc``.
The following sequence builds Varnish as needed for the ``trackrdrd`` The following sequence builds Varnish as needed for the ``trackrdrd``
build:: build::
...@@ -153,9 +149,10 @@ build:: ...@@ -153,9 +149,10 @@ build::
Building and installing packaged MQ implementations Building and installing packaged MQ implementations
--------------------------------------------------- ---------------------------------------------------
The ``trackrdrd`` distribution includes an implementation of the MQ The ``trackrdrd`` distribution includes implementations of the MQ
interface for ActiveMQ message brokers. For details of the build and interface for Kafka and ActiveMQ message brokers. For details of the
its dependencies, see libtrackrdr-activemq(3) (``README.rst`` in builds and their dependencies, see libtrackrdr-kafka(3) and
libtrackrdr-activemq(3) (``README.rst`` in ``src/mq/kafka`` and
``src/mq/activemq``). ``src/mq/activemq``).
Since the global make targets for ``trackrdrd`` also build the MQ Since the global make targets for ``trackrdrd`` also build the MQ
...@@ -177,18 +174,17 @@ step: ...@@ -177,18 +174,17 @@ step:
* The path to the Varnish source directory must be given in the * The path to the Varnish source directory must be given in the
variable ``VARNISHSRC``. variable ``VARNISHSRC``.
* The flag ``CXXFLAGS``, like ``CFLAGS``, must also be set to * For ActiveMQ, the flag ``CXXFLAGS`` should be set similarly to
``-m64``, because C++ code is also compiled. It may be necessary to ``CFLAGS``, because C++ code is also compiled. Settings for
add additional ``CXXFLAGS`` to compile the ActiveMQ API calls, for ``CXXFLAGS`` can be obtained from ``pkg-config --cflags apr-1``.
example as obtained from ``pkg-config --cflags apr-1``.
At minimum, run these steps:: At minimum, run these steps::
$ git clone git@repo.org:trackrdrd $ git clone $TRACKRDRD_GIT_URL
$ cd trackrdrd/trackrdrd/ $ cd trackrdrd
$ ./autogen.sh $ ./autogen.sh
$ CXXFLAGS=-m64 CFLAGS=-m64 ./configure \\ $ CXXFLAGS=-m64 CFLAGS=-m64 ./configure \\
VARNISHSRC=/path/to/varnish-cache VARNISHSRC=/path/to/compiled/varnish-cache
$ make $ make
For self-tests after the build, run:: For self-tests after the build, run::
...@@ -213,23 +209,23 @@ For example, to specify a non-standard installation prefix, add the ...@@ -213,23 +209,23 @@ For example, to specify a non-standard installation prefix, add the
``--prefix`` option:: ``--prefix`` option::
$ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\ $ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\
VARNISHSRC=/path/to/varnish-cache \\ VARNISHSRC=/path/to/varnish_build \\
--prefix=/path/to/varnish_tracking --prefix=/path/to/trackrdrd_install
For Otto, runtime paths for Varnish libraries are at non-standard If Varnish is installed at a non-standard location, it is necessary to
locations, so it is necessary to add the option set runtime paths to the Varnish libraries with the option
``LDFLAGS=-Wl,-rpath=$LIB_PATHS``:: ``LDFLAGS=-Wl,-rpath=$LIB_PATHS``::
$ export VARNISH_PREFIX=/path/to/varnish $ export VARNISH_PREFIX=/path/to/varnish_install
$ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\ $ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\
VARNISHSRC=/path/to/varnish-cache \\ VARNISHSRC=/path/to/varnish_build \\
--prefix=/path/to/varnish_tracking \\ --prefix=/path/to/trackrdrd_install \\
LDFLAGS=-Wl,-rpath=$VARNISH_PREFIX/lib/varnish:$VARNISH_PREFIX/lib LDFLAGS=-Wl,-rpath=$VARNISH_PREFIX/lib/varnish:$VARNISH_PREFIX/lib
Developers can add a number of options as an aid to compiling and debugging:: Developers can add a number of options as an aid to compiling and debugging::
$ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\ $ CFLAGS=-m64 CXXFLAGS=-m64 ./configure \\
VARNISHSRC=/path/to/varnish-cache \\ VARNISHSRC=/path/to/varnish_build \\
--enable-debugging-symbols --enable-werror \\ --enable-debugging-symbols --enable-werror \\
--enable-developer-warnings --enable-extra-developer-warnings \\ --enable-developer-warnings --enable-extra-developer-warnings \\
--enable-diagnostics --enable-diagnostics
...@@ -436,8 +432,8 @@ For both the software and this document are governed by a BSD 2-clause ...@@ -436,8 +432,8 @@ For both the software and this document are governed by a BSD 2-clause
licence. licence.
| Copyright (c) 2012-2014 UPLEX Nils Goroll Systemoptimierung | Copyright (c) 2012-2015 UPLEX Nils Goroll Systemoptimierung
| Copyright (c) 2012-2014 Otto Gmbh & Co KG | Copyright (c) 2012-2015 Otto Gmbh & Co KG
| All rights reserved | All rights reserved
| Use only with permission | Use only with permission
......
...@@ -9,7 +9,7 @@ ActiveMQ implementation of the MQ interface for the Tracking Log Reader ...@@ -9,7 +9,7 @@ ActiveMQ implementation of the MQ interface for the Tracking Log Reader
----------------------------------------------------------------------- -----------------------------------------------------------------------
:Author: Geoffrey Simmons :Author: Geoffrey Simmons
:Date: 2014-05-20 :Date: 2015-04-26
:Version: 3.0 :Version: 3.0
:Manual section: 3 :Manual section: 3
...@@ -44,10 +44,8 @@ BUILD/INSTALL ...@@ -44,10 +44,8 @@ BUILD/INSTALL
============= =============
The sources for ``libtrackrdr-activemq`` are provided in the source The sources for ``libtrackrdr-activemq`` are provided in the source
repository for ``trackrdrd``, in the subdirectory ``src/mq/activemq/`` repository for ``trackrdrd``, in the subdirectory
of:: ``src/mq/activemq/``.
git@repo.org:trackrdrd
The sources for ActiveMQ-CPP can be obtained from:: The sources for ActiveMQ-CPP can be obtained from::
...@@ -80,7 +78,7 @@ the rest of ``trackrdrd``), it suffices to invoke ``make`` commands in ...@@ -80,7 +78,7 @@ the rest of ``trackrdrd``), it suffices to invoke ``make`` commands in
the subdirectory ``src/mq/activemq`` (after having executed the the subdirectory ``src/mq/activemq`` (after having executed the
``configure`` script for ``trackrdrd``):: ``configure`` script for ``trackrdrd``)::
# in trackrdrd/trackrdrd # in the trackrdrd repo
$ cd src/mq/activemq $ cd src/mq/activemq
$ make $ make
...@@ -145,8 +143,8 @@ COPYRIGHT AND LICENCE ...@@ -145,8 +143,8 @@ COPYRIGHT AND LICENCE
For both the software and this document are governed by a BSD 2-clause For both the software and this document are governed by a BSD 2-clause
licence. licence.
| Copyright (c) 2012-2014 UPLEX Nils Goroll Systemoptimierung | Copyright (c) 2012-2015 UPLEX Nils Goroll Systemoptimierung
| Copyright (c) 2012-2014 Otto Gmbh & Co KG | Copyright (c) 2012-2015 Otto Gmbh & Co KG
| All rights reserved | All rights reserved
| Use only with permission | Use only with permission
......
...@@ -9,7 +9,7 @@ Kafka implementation of the MQ interface for the Tracking Log Reader ...@@ -9,7 +9,7 @@ Kafka implementation of the MQ interface for the Tracking Log Reader
-------------------------------------------------------------------- --------------------------------------------------------------------
:Author: Geoffrey Simmons :Author: Geoffrey Simmons
:Date: 2014-06-01 :Date: 2015-04-26
:Version: 3.0.0 :Version: 3.0.0
:Manual section: 3 :Manual section: 3
...@@ -46,10 +46,7 @@ BUILD/INSTALL ...@@ -46,10 +46,7 @@ BUILD/INSTALL
============= =============
The sources for ``libtrackrdr-kafka`` are provided in the source The sources for ``libtrackrdr-kafka`` are provided in the source
repository for ``trackrdrd``, in the subdirectory ``src/mq/kafka/`` repository for ``trackrdrd``, in the subdirectory ``src/mq/kafka/``.
of::
git@repo.org:trackrdrd
The sources for the library dependencies can be obtained from: The sources for the library dependencies can be obtained from:
...@@ -87,7 +84,7 @@ the rest of ``trackrdrd``), it suffices to invoke ``make`` commands in ...@@ -87,7 +84,7 @@ the rest of ``trackrdrd``), it suffices to invoke ``make`` commands in
the subdirectory ``src/mq/kafka`` (after having executed the the subdirectory ``src/mq/kafka`` (after having executed the
``configure`` script for ``trackrdrd``):: ``configure`` script for ``trackrdrd``)::
# in trackrdrd/trackrdrd # in the trackrdrd repo
$ cd src/mq/kafka $ cd src/mq/kafka
$ make $ make
...@@ -347,8 +344,8 @@ COPYRIGHT AND LICENCE ...@@ -347,8 +344,8 @@ COPYRIGHT AND LICENCE
Both the software and this document are governed by a BSD 2-clause Both the software and this document are governed by a BSD 2-clause
licence. licence.
| Copyright (c) 2014 UPLEX Nils Goroll Systemoptimierung | Copyright (c) 2014-2015 UPLEX Nils Goroll Systemoptimierung
| Copyright (c) 2014 Otto Gmbh & Co KG | Copyright (c) 2014-2015 Otto Gmbh & Co KG
| All rights reserved | All rights reserved
| Use only with permission | Use only with permission
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment