Released with Varnish Custom Statistics version 4.1.3
.
Installing Varnish Custom Statistics involves:
vstatd
software on a server.vstatdprobe
on your Varnish Enterprise servers.vstatd
, and vstatdprobe
.After a successful installation vstatd
’s HTTP interface will be
listening on port 6555
on the server. It will also listen for incoming
messages from the vstatdprobe
instances on port 5558
.
In order to install VCS on either Debian/Ubuntu or Redhat Enterprise, you need access to the Varnish Enterprise software repository. Please contact support at support@varnish-software.com for help with this step.
If you are installing on Debian or Ubuntu, use the provided packages in the Varnish Enterprise software repository.
Add the Varnish Enterprise repository.
Update and install
sudo apt-get update
sudo apt-get install varnish-custom-statistics
After the Varnish Custom Statistics server is installed, you need to install the probe component on each of your Varnish servers. Add the Varnish Enterprise repository to each Varnish server and then update and install:
sudo apt-get update
sudo apt-get install varnish-custom-statistics-probe
Currently RPMs for RHEL6 and RHEL7 compatible derivatives are available.
These depend on some packages from the EPEL repository. To make the entire EPEL repository available on your host, follow the [EPEL documentation] (https://fedoraproject.org/wiki/EPEL/FAQ#How_can_I_install_the_packages_from_the_EPEL_software_repository.3F)
Once EPEL is configured add the Varnish Enterprise yum repository. Please contact support at support@varnish-software.com for help with this step.
Install VCS on a server:
sudo yum update
sudo yum install varnish-custom-statistics
In addition, you might need to configure the firewall to allow incoming traffic
to port 6555
and 5558
. This is done either by editing the
/etc/sysconfig/iptables
file or by using the system-config-securitylevel-tui
tool.
After the Varnish Custom Statistics server is installed, you need to install the probe component on each of your Varnish servers. Do this by using the same yum repo configuration as you did for the server and then do:
sudo yum update
sudo yum install varnish-custom-statistics-probe
Point the VCS probe to the VCS (vstatd) server. This requires editing the file
/etc/default/vstatdprobe
(/etc/sysconfig/vstatdprobe
for RHEL 6,
or /etc/varnish/vstatdprobe.params
for RHEL 7).
Edit the DAEMON_OPTS
environment variable with the IP address or hostname of
your vstatd
server. If needed, other options may also be set. See
the man page vstatprobe(8)
for a description of other available options.
To start vstatdprobe
, you can run the provided init script by issuing
the following command with either start
, stop
or restart
.
E.g.:
sudo service vstatdprobe restart
You can find the full set of the vstatdprobe command parameters here
For advanced VCL based key configuration, please see Use Cases
vstatd
is configured by editing the DAEMON_OPTS
environment variable found
in /etc/default/vstatd
(or /etc/sysconfig/vstatd
).
By default, vstatd
will track aggregated statistics in 30 second buckets, with
total 15 buckets of history for each key. These parameters are configurable with
the -b
and -m
parameters, respectively.
Internally, vstatd
tracks all keys in a hash table. For optimal performance,
the size of this table should be at least as large as the number of unique keys
you end up tracking. The default size is 20000
, and is configurable with the
-s
parameter.
The provided init script for vstatd
is executed in the same way as for
vstatdprobe
, e.g.:
sudo service vstatd restart
You can find the full set of the vstatd command parameters here
All inquiries can be directed to support@varnish-software.com. We’d be very happy to hear about your VCS usage and any suggestions you might have.