Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

velocity.ini [WatchdogSettings]

The settings of [WatchdogSettings] in velocity.ini: Interval, RestartTimeout, Backoff, LockFile, UnitName, UnitDir

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/velocity/WatchdogSettings.md

On this page

velocity.ini [WatchdogSettings]

The block [WatchdogSettings] of settings/velocity.ini, with 6 setting(s).

Never edit settings/velocity.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

  • settings/override/velocity.ini.append.php for every siteaccess,
  • settings/siteaccess/<siteaccess>/velocity.ini.append.php for one siteaccess,
  • extension/<extension>/settings/velocity.ini.append.php in an extension (read when the extension is active).

Interval

exp:velocity watchdog: a safety net that starts the default engine again
when it is down and nobody meant it to be (a restart whose caller was killed
between the stop and the start, a crash, an out-of-memory kill). Off until
`exp:velocity watchdog install` (root, systemd) writes <UnitName>.service
and .timer and conf-available/<name>.conf in the configuration tree, enables
that file (conf-enabled) and starts the timer. Values in the enabled file win
over these. `exp:velocity conf disable watchdog` pauses it; `watchdog remove`
takes it out; `watchdog status` and var/log/velocity-watchdog.log say what it
did. It starts the engine only when no process of it runs, nobody stopped it
(exp:velocity stop/kill leave stopped.json beside the pid file) and no
restart is under way (restart-in-progress.json); it never touches a server
that runs, whether it answers or not.

Seconds between checks (15 to 3600).

Default: 45.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
Interval=45
*/ ?>

RestartTimeout

Seconds a restart may take before its marker no longer holds the watchdog
back (a marker whose process is gone never does). Also how long a held
LockFile may keep a server that is down from being started.

Default: 300.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
RestartTimeout=300
*/ ?>

Backoff

After three starts in a row that failed, seconds to wait before the next.

Default: 600.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
Backoff=600
*/ ?>

LockFile

A lock file (flock) that, while held, means "something is deploying, wait":
a deploy queue of the installation. Empty: none.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
LockFile=
*/ ?>

UnitName

The systemd unit's name; give each installation on a host its own.

Default: vc-watchdog.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
UnitName=vc-watchdog
*/ ?>

UnitDir

Where the unit files are written.

Default: /etc/systemd/system.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[WatchdogSettings]
UnitDir=/etc/systemd/system
*/ ?>

Generated by ./console exp:help:examples from settings/velocity.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x