.. _logging_local_log:

logging local-log
=================

local log


local-log Specification
-----------------------

	===================================== ==========================================================
	 **Parameter**                         **Value** 

	===================================== ==========================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      local-log

	 **Element URI**                       /axapi/v3/logging/local-log

	 **Element Attributes**                local-log_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`local-log schema <logging-local-log/logging-local-log.txt>`
	===================================== ==========================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/logging/local-log



.. raw:: html

   </td><td valign = 'top'>


local-log_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _2259_local-log_attributes:

local-log attributes
--------------------

    **access**

        **Description:** access is a **JSON Block**.  Please see below for :ref:`2259_access` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/access <logging_local_log_access>`

    **app-fw**

        **Description:** app-fw is a **JSON Block**.  Please see below for :ref:`2259_app-fw` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/app-fw <logging_local_log_app_fw>`

    **authentication**

        **Description:** authentication is a **JSON Block**.  Please see below for :ref:`2259_authentication` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/authentication <logging_local_log_authentication>`

    **global**

        **Description:** global is a **JSON Block**.  Please see below for :ref:`2259_global` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/global <logging_local_log_global>`

.. _2259_access:

access
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`2259_access_log` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/access/log <logging_local_log_access_log>`

    **top-n**

        **Description:** top-n is a **JSON Block**.  Please see below for :ref:`2259_access_top-n` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/access/top-n <logging_local_log_access_top_n>`

.. _2259_access_top-n:

access_top-n
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_access_log:

access_log
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_authentication:

authentication
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **log**

        **Description:** log is a **JSON Block**.  Please see below for :ref:`2259_authentication_log` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/authentication/log <logging_local_log_authentication_log>`

    **top-n**

        **Description:** top-n is a **JSON Block**.  Please see below for :ref:`2259_authentication_top-n` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/authentication/top-n <logging_local_log_authentication_top_n>`

.. _2259_authentication_top-n:

authentication_top-n
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_authentication_log:

authentication_log
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_global:

global
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_global_sampling-enable:

global_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **counters1**

        **Description** 'all': all; 'enqueue': Total local-log enqueue; 'enqueue-full': Total local-log queue full; 'enqueue-error': Total local-log enqueue error; 'dequeue': Total local-log dequeue; 'dequeue-error': Total local-log dequeue processing error; 'raw-log': Total local-log raw logs; 'raw-log-error': Total raw log logging error; 'log-summarized': Total raw log summarized; 'l1-log-summarized': Total layer 1 log summarized; 'l2-log-summarized': Total layer 2 log summarized; 'log-summarized-error': Total local-log summarization error; 'aam-db': Total local-log AAM raw database; 'ep-db': Total local-log EP raw database; 'fw-db': Total local-log Firewall raw database; 'aam-top-user-db': Total local-log AAM top user summary database; 'ep-top-user-db': Total local-log EP top user summary database; 'ep-top-src-db': Total local-log EP top client summary database; 'ep-top-dst-db': Total local-log EP top destination summary database; 'ep-top-domain-db': Total local-log EP top domain summary database; 'ep-top-web-category-db': Total local-log EP top web-category summary database; 'ep-top-host-db': Total local-log EP top host summary database; 'fw-top-app-db': Total local-log Firewall top application summary database; 'fw-top-src-db': Total local-log Firewall top source summary database; 'fw-top-app-src-db': Total local-log Firewall top application and source summary database; 'fw-top-category-db': Total local-log Firewall top category summary database; 'db-erro': Total local-log database create error; 'query': Total local-log axapi query; 'response': Total local-log axapi response; 'query-error': Total local-log axapi query error; 'fw-top-thr-db': Total local-log Firewall top threat summary database; 'fw-top-thr-src-db': Total local-log Firewall top threat and source summary database; 

        **Type:** string

        **Supported Values:** all, enqueue, enqueue-full, enqueue-error, dequeue, dequeue-error, raw-log, raw-log-error, log-summarized, l1-log-summarized, l2-log-summarized, log-summarized-error, aam-db, ep-db, fw-db, aam-top-user-db, ep-top-user-db, ep-top-src-db, ep-top-dst-db, ep-top-domain-db, ep-top-web-category-db, ep-top-host-db, fw-top-app-db, fw-top-src-db, fw-top-app-src-db, fw-top-category-db, db-erro, query, response, query-error, fw-top-thr-db, fw-top-thr-src-db

.. _2259_app-fw:

app-fw
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **dot-plot**

        **Description:** dot-plot is a **JSON Block**.  Please see below for :ref:`2259_app-fw_dot-plot` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/app-fw/dot-plot <logging_local_log_app_fw_dot_plot>`

    **top-n**

        **Description:** top-n is a **JSON Block**.  Please see below for :ref:`2259_app-fw_top-n` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/logging/local-log/app-fw/top-n <logging_local_log_app_fw_top_n>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_app-fw_top-n:

app-fw_top-n
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2259_app-fw_dot-plot:

app-fw_dot-plot
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters