.. _ddos_logging:

ddos logging
============

DDOS Logging Statistics


logging Specification
---------------------

	===================================== =====================================================
	===================================== =====================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      logging

	 **Element URI**                       /axapi/v3/ddos/logging

	 **Element Attributes**                logging_attributes

	 **Statistics Data URI**               /axapi/v3/ddos/logging/stats

	 **Schema**                             :download:`logging schema <ddos-logging/ddos-logging.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ddos/logging



.. raw:: html

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


:ref:`944_logging_attributes`



.. raw:: html

   </td><td></td></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/ddos/logging



.. raw:: html

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


:ref:`944_logging_attributes`



.. raw:: html

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




.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ddos/logging



.. raw:: html

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


:ref:`944_logging_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ddos/logging



.. raw:: html

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


:ref:`944_logging_attributes`



.. raw:: html

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




.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/ddos/logging



.. raw:: html

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


:ref:`944_logging_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _944_logging_attributes:

logging attributes
------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _944_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'log_msg_quota_exceed': Log Message Per CPU Quota Exceed; 'log_msg_oom': Log Message Out of Memory Error; 'log_queue_full': Log Message Queue Full; 'log_msg_enqueue': Log Message Enqueue; 'log_msg_enqueue_err': Log Message Enqueue Error; 'log_msg_dequeue': Log Message Dequeue; 'log_msg_dequeue_err': Log Message Dequeue Error; 'log_msg_sent': Log Message Sent; 'log_msg_send_err': Log Message Send Error; 

        **Type:** string

        **Supported Values:** all, log_msg_quota_exceed, log_msg_oom, log_queue_full, log_msg_enqueue, log_msg_enqueue_err, log_msg_dequeue, log_msg_dequeue_err, log_msg_sent, log_msg_send_err

.. _944_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - log_queue_full
      - 8
      - Log Message Queue Full

   *  - 
      - log_msg_quota_exceed
      - 8
      - Log Message Per CPU Quota Exceed

   *  - 
      - log_msg_oom
      - 8
      - Log Message Out of Memory Error

   *  - 
      - log_msg_send_err
      - 8
      - Log Message Send Error

   *  - 
      - log_msg_sent
      - 8
      - Log Message Sent