overview.rst 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. .. _monitor_overview:
  2. Monitoring Overview
  3. ===================
  4. The following diagram outlines the architecture of the monitor extension:
  5. .. figure:: images/monitor.png
  6. :align: center
  7. *Monitor extension architecture*
  8. As a request is processed the monitor inserts itself at particular points in
  9. the request life cycle to capture various information about the request. Such
  10. information includes:
  11. * Timestamp of the origin of the request
  12. * Total time it took for the request to complete
  13. * Origin of the request
  14. * HTTP information such as the body content type, header information, etc...
  15. And more. See the :ref:`monitor_reference` section for a complete list.
  16. In addition to capturing request data the monitor extension is also capable
  17. of persisting it. Two options are provided out of the box:
  18. * Persisting to a relational database, see :ref:`monitor_db` for more details
  19. * Piping to a log file, see :ref:`monitor_audit` for more details
  20. By default the extension will do neither and simply maintain data for only
  21. the most recent requests. The data is stored in memory meaning that if the
  22. server is restarted or shutdown this information is lost.The
  23. :ref:`monitor_configuration` section provides a comprehensive guide to
  24. configuring the monitor extension.
  25. Stored request information is made available through a simple
  26. :ref:`query api <monitor_query_api>` that allows clients to access
  27. request data through a HTTP interface.