.. _log:

###
Log
###

``vey-proxy`` supports multiple logging drivers. See
:ref:`log <configuration_log>` for configuration details.

All logs generated by ``vey-proxy`` are structured. This section documents the
fields used by each log type.

Shared Keys
===========

The following shared keys are present in all log records:

daemon_name
-----------

**optional**, **type**: string

  The daemon group name for the process. It can be set through command-line
  options.

pid
---

**required**, **type**: int

  The process ID.

  There may be multiple processes at the same time, with one online and others
  draining in offline mode.

log_type
--------

**required**, **type**: enum string

  The log type. The meaning of non-shared keys depends on this value.

Values are:

  * Task
  * Escape
  * Resolve

.. _log_shared_keys_report_ts:

report_ts
---------

**optional**, **type**: unix timestamp

The timestamp at which this log was generated.

This field is present only when the configured log driver is set to append it.
See :ref:`log driver <configuration_log_driver>` for details.

Log Types
=========

.. toctree::
   :maxdepth: 1

   task/index
   escape/index
   resolve/index