Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
T
trackrdrd
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
uplex-varnish
trackrdrd
Commits
9520802e
Commit
9520802e
authored
Sep 26, 2012
by
Geoff Simmons
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
trackrdr: Added build instructions to README
parent
29dd8131
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
113 additions
and
1 deletion
+113
-1
README.rst
trackrdrd/README.rst
+113
-1
No files found.
trackrdrd/README.rst
View file @
9520802e
...
...
@@ -22,7 +22,7 @@ SYNOPSIS
DESCRIPTION
===========
The
trackrdrd
demon reads from the shared memory log of a running
The
``trackrdrd``
demon reads from the shared memory log of a running
instance of Varnish and collects data relevant to tracking for the
Otto project.
...
...
@@ -30,3 +30,115 @@ OPTIONS
=======
.. include:: options.txt
BUILD/INSTALL
=============
The source repository for ``trackrdrd`` is in the subdirectory
``trackrdrd/`` of::
git@repo.org:trackrdrd
The build requires a source directory for Varnish in which sources
have been compiled. Varnish sources with features added for Otto are
in::
git@repo.org:varnish-cache
Building Varnish
----------------
The Varnish build requires the following tools/packages:
* git
* autoconf
* automake
* pkg-config
* pcre-devel (so that Varnish can link to the runtime libs)
* python-docutils (for rst2man)
Check out the repository and switch to the branch ``3.0_bestats``, in
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
``trackrdrd`` needs to link with its libraries, it must be built in
64-bit mode as well. This means that the Varnish build for
``trackrdrd`` must also be 64-bit; for ``gcc``, this is accomplished
with ``CFLAGS=-m64``.
The following sequence builds Varnish as needed for the ``trackrdrd``
build::
$ ./autogen.sh
$ CFLAGS=-m64 ./configure
$ make
Building and installing trackrdrd
---------------------------------
Requirements for ``trackrdrd`` are the same as for Varnish, in
addition to the Varnish build itself. (``pcre-devel`` is not strictly
necessary for ``trackrdrd``, but since you are building ``trackrdrd``
on the same platform as the Varnish build, all requirements are
fulfilled.)
The steps to build ``trackrdrd`` are very similar to those for
building Varnish. The only difference is that in the ``configure``
step, the path to the Varnish source directory must be given in the
variable ``VARNISHSRC``::
$ git clone git@repo.org:trackrdrd
$ cd trackrdrd/trackrdrd/
$ ./autogen.sh
$ CFLAGS=-m64 ./configure VARNISHSRC=/path/to/varnish-cache
$ make
For self-tests after the build, run::
$ make check
To install ``trackrdrd``, run ``make install`` as root, for example
with ``sudo``::
$ sudo make install
Alternative configurations
--------------------------
In the ``configure`` step, a wide range of additional options may be
given to affect the configuration. Most of these are standard, and can
be shown with::
$ configure --help
For example, to specify a non-standard installation prefix, add the
``--prefix`` option::
$ CFLAGS=-m64 ./configure VARNISHSRC=/path/to/varnish-cache \\
--prefix=/path/to/varnish_tracking
Developers can add a number of options as an aid to compiling and debugging::
$ CFLAGS=-m64 ./configure VARNISHSRC=/path/to/varnish-cache \\
--enable-developer-warnings --enable-debugging-symbols \\
--enable-extra-developer-warnings --enable-werror
``--enable-werror`` activates the ``-Werror`` option for compilers,
which causes compiles to fail on any warning. ``trackrdrd`` should
*always* build successfully with this option.
``--enable-developer-warnings`` and
``--enable-extra-developer-warnings`` turn on additional compiler
switches for warnings -- ``trackrdrd`` builds should succeed with
these as well.
``--enable-debugging-symbols`` ensures that symbols and source code
file names are saved in the executable, and thus are available in core
dumps, in stack traces on assertion failures, for debuggers and so
forth. It is advisable to turn this switch on for production builds
(not just for developer builds), so that runtime errors can more
easily be debugged.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment