This HowTo describe the how add the monitoring stack to a software release using html5as-base as an example.

Here is the commit introducing this functionality to html5as Software release: commit diff.

The monitor stack is used in all productions instance. It is an essential component to monitor the internal of a service with the necessary granularity.

In the monitor app that uses the monitor webservices to aggregate data, you can see the history of failing services.

The Monitor stack needs to be extended in software.cfg.

Additionally the instance template for monitor needs to be provided to html5as instance. So it needs to be passed to the local instance template

[buildout]
extends =
  ...
# Extend monitoring stack to provide necessary tools for monitoring
  ../../stack/monitor/buildout.cfg

...
[template-cfg]
...
context =
...
# Monitor stack also provides a template for the instance
  key template_monitor monitor2-template:rendered

In instance.cfg.in, add the monitor instance template to [profile-common].

[profile-common]
...
template_monitor = {{ template_monitor }}

In instance_html5as.cfg.in extend the monitor instance template to include monitor sections.

[buildout]
...
# Instance profile extends monitoring stack
extends = {{ parameter_list['template_monitor'] }}

Refer How To Move to md5sum automatic update to update md5sum:

$ cd ~/srv/project/slapos/software/html5as-base
$ ../../update-hash