.. _slb_rate_limit_log:

slb rate-limit-log
==================

Configure rate limit logging


rate-limit-log Specification
----------------------------

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

	 **Element Name**                      rate-limit-log

	 **Element URI**                       /axapi/v3/slb/rate-limit-log

	 **Element Attributes**                rate-limit-log_attributes

	 **Statistics Data URI**               /axapi/v3/slb/rate-limit-log/stats

	 **Operational Data URI**              /axapi/v3/slb/rate-limit-log/oper

	 **Schema**                             :download:`rate-limit-log schema <slb-rate-limit-log/slb-rate-limit-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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/slb/rate-limit-log



.. raw:: html

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


:ref:`1713_rate-limit-log_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/slb/rate-limit-log



.. raw:: html

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


:ref:`1713_rate-limit-log_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/slb/rate-limit-log



.. raw:: html

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


:ref:`1713_rate-limit-log_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/slb/rate-limit-log



.. raw:: html

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


:ref:`1713_rate-limit-log_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/slb/rate-limit-log



.. raw:: html

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


:ref:`1713_rate-limit-log_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1713_rate-limit-log_attributes:

rate-limit-log attributes
-------------------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1713_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'total_log_times': Total log times; 'total_log_msg': Total log messages; 'local_log_msg': Local log messages; 'remote_log_msg': Remote log messages; 'local_log_rate': Local rate (per sec); 'remote_log_rate': Remote rate (per sec); 'msg_too_big': Log message too big; 'buff_alloc_fail': Buffer alloc fail; 'no_route': No route; 'buff_send_fail': Buffer send fail; 'alloc_conn': Log-session alloc; 'free_conn': Log-session free; 'conn_alloc_fail': Log-session alloc fail; 'no_repeat_msg': No repeat message; 'local_log_dropped': Local log dropped due to rate-limit; 

        **Type:** string

        **Supported Values:** all, total_log_times, total_log_msg, local_log_msg, remote_log_msg, local_log_rate, remote_log_rate, msg_too_big, buff_alloc_fail, no_route, buff_send_fail, alloc_conn, free_conn, conn_alloc_fail, no_repeat_msg, local_log_dropped

.. _1713_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - msg_too_big
      - 8
      - Log message too big

   *  - 
      - buff_send_fail
      - 8
      - Buffer send fail

   *  - 
      - remote_log_rate
      - 8
      - Remote rate (per sec)

   *  - 
      - alloc_conn
      - 8
      - Log-session alloc

   *  - 
      - no_repeat_msg
      - 8
      - No repeat message

   *  - 
      - free_conn
      - 8
      - Log-session free

   *  - 
      - conn_alloc_fail
      - 8
      - Log-session alloc fail

   *  - 
      - local_log_msg
      - 8
      - Local log messages

   *  - 
      - local_log_dropped
      - 8
      - Local log dropped due to rate-limit

   *  - 
      - total_log_msg
      - 8
      - Total log messages

   *  - 
      - no_route
      - 8
      - No route

   *  - 
      - remote_log_msg
      - 8
      - Remote log messages

   *  - 
      - buff_alloc_fail
      - 8
      - Buffer alloc fail

   *  - 
      - local_log_rate
      - 8
      - Local rate (per sec)

   *  - 
      - total_log_times
      - 8
      - Total log times

.. _1713_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - cpu-count
      - number
      - cpu-count

   *  - 
      - rate-limit-log-cpu-list
      - 
      - rate-limit-log-cpu-list