:hide-toc:

Welcome to Happyface's documentation!
=====================================

Happyface is a meta monitoring tool, aimed at `WLCG <https://wlcg.web.cern.ch/>`_ site
operators. It is designed to monitor services which are necessary to run a WLCG site.
For this, data is aggregated from several sources and stored in a local :doc:`database
<database>`. Calculating the status of each service and subsequently generating tables or
figures with only the most important information allows for a quick overview of the status
of the services. With traffic light colors, the status of each :doc:`analysis <analysis>`
can easily be assessed even by inexperienced shifters at a glance.

.. figure:: images/overview.png
    :width: 100%
    :alt: Happyface Overview
    :class: no-scaled-link

    The Happyface overview page.

.. admonition:: Information
   :class: seealso

   See https://hf.etp.kit.edu for a running Happyface instance operated at KIT.
   How this instance is developed and deployed is described
   :doc:`here <etp>`.

To get a general overview, please refer to :doc:`the introduction <intro>`. How to develop
an analysis for monitoring a specific service in Happyface is described in :doc:`analysis
<analysis>`. Some words on how the data and the statuses of the individual services are
stored are given in :doc:`database <database>`.

.. toctree::
   :maxdepth: 1
   :hidden:

   intro
   analysis
   database

.. toctree::
   :caption: Miscellaneous
   :hidden:

   Happyface at ETP<etp>


.. toctree::
   :maxdepth: 3
   :caption: Modules
   :hidden:

   app_configs
   Happyface4

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`