.. _visibility_stats:

visibility stats
================

Statistics for the object visibility


visibility Specification
------------------------

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

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

	 **Element Name**                      visibility

	 **Element URI**                       /axapi/v3/visibility/stats

	 **Element Attributes**                visibility_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`visibility schema <visibility-stats/visibility-stats.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/visibility/stats



.. raw:: html

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


:ref:`1674_visibility_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/visibility/stats



.. raw:: html

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


:ref:`1674_visibility_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/visibility/stats



.. raw:: html

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


:ref:`1674_visibility_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/visibility/stats



.. raw:: html

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


:ref:`1674_visibility_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/visibility/stats



.. raw:: html

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


:ref:`1674_visibility_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1674_visibility_attributes:

visibility attributes
---------------------

    **flow-collector**

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data/reporting/flow-collector <visibility_mon_entity_telemetry_data_reporting_flow_collector>`

    **mon-entity-telemetry-data**

        **Description:** mon-entity-telemetry-data is a **JSON Block**.  Please see below for :ref:`1674_mon-entity-telemetry-data` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data <visibility_mon_entity_telemetry_data>`

    **reporting**

        **Description:** reporting is a **JSON Block**.  Please see below for :ref:`1674_reporting` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data/reporting <visibility_mon_entity_telemetry_data_reporting>`

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1674_stats` 

        **Type:** Object

    **topn**

        **Description:** topn is a **JSON Block**.  Please see below for :ref:`1674_topn` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data/reporting/flow-collector/topn <visibility_mon_entity_telemetry_data_reporting_flow_collector_topn>`

.. _1674_mon-entity-telemetry-data:

mon-entity-telemetry-data
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1674_mon-entity-telemetry-data_stats` 

        **Type:** Object

.. _1674_mon-entity-telemetry-data_stats:

mon-entity-telemetry-data_stats
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **avg_data_cpu_util**

        **Description** Monitored Entity telemetry Metric Average data CPU utilization

        **Type:** number

        **Format:** counter

    **concurrent-conn**

        **Description** Monitored Entity telemtry Metric Concurrent number of connections

        **Type:** number

        **Format:** counter

    **drop_pkts_per_pkts**

        **Description** Monitored Entity telemetry Metric Drop pkts per pkts

        **Type:** number

        **Format:** counter

    **errors**

        **Description** Monitored Entity telemetry Metric ERRORS

        **Type:** number

        **Format:** counter

    **in_bytes**

        **Description** Monitored Entity telemetry Metric IN bytes

        **Type:** number

        **Format:** counter

    **in_bytes_per_out_bytes**

        **Description** Monitored Entity telemetry Metric IN bytes per OUT bytes

        **Type:** number

        **Format:** counter

    **in_frag**

        **Description** Monitored Entity telemetry Metric IN frag

        **Type:** number

        **Format:** counter

    **in_pkts**

        **Description** Monitored Entity telemetry Metric IN pkts

        **Type:** number

        **Format:** counter

    **in_small_pkt**

        **Description** Monitored Entity telemetry Metric IN SMALL pkt

        **Type:** number

        **Format:** counter

    **new-conn**

        **Description** Monitored Entity telemetry Metric New Sessions

        **Type:** number

        **Format:** counter

    **out_bytes**

        **Description** Monitored Entity telemetry Metric OUT bytes

        **Type:** number

        **Format:** counter

    **out_frag**

        **Description** Monitored Entity telemetry Metric OUT frag

        **Type:** number

        **Format:** counter

    **out_pkts**

        **Description** Monitored Entity telemetry Metric OUT pkts

        **Type:** number

        **Format:** counter

    **out_small_pkt**

        **Description** Monitored Entity telemetry Metric OUT SMALL pkt

        **Type:** number

        **Format:** counter

    **outside_intf_util**

        **Description** Monitored Entity telemetry Metric Outside interface utilization

        **Type:** number

        **Format:** counter

    **tcp_conn_miss**

        **Description** Monitored Entity telemetry Metric TCP connection miss

        **Type:** number

        **Format:** counter

    **tcp_fwd_syn_per_fin**

        **Description** Monitored Entity telemetry Metric TCP FWD SYN per FIN

        **Type:** number

        **Format:** counter

    **tcp_in_empty_ack**

        **Description** Monitored Entity telemetry Metric TCP_IN EMPTY ack

        **Type:** number

        **Format:** counter

    **tcp_in_fin**

        **Description** Monitored Entity telemetry Metric TCP IN fin

        **Type:** number

        **Format:** counter

    **tcp_in_payload**

        **Description** Monitored Entity telemetry Metric TCP IN payload

        **Type:** number

        **Format:** counter

    **tcp_in_rexmit**

        **Description** Monitored Entity telemetry Metric TCP IN rexmit

        **Type:** number

        **Format:** counter

    **tcp_in_rst**

        **Description** Monitored Entity telemetry Metric TCP IN rst

        **Type:** number

        **Format:** counter

    **tcp_in_syn**

        **Description** Monitored Entity telemetry Metric TCP IN syn

        **Type:** number

        **Format:** counter

    **tcp_in_zero_wnd**

        **Description** Monitored Entity telemetry Metric TCP IN ZERO wnd

        **Type:** number

        **Format:** counter

    **tcp_out_empty_ack**

        **Description** Monitored Entity telemetry Metric TCP OUT EMPTY ack

        **Type:** number

        **Format:** counter

    **tcp_out_fin**

        **Description** Monitored Entity telemetry Metric TCP OUT fin

        **Type:** number

        **Format:** counter

    **tcp_out_payload**

        **Description** Monitored Entity telemetry Metric TCP OUT payload

        **Type:** number

        **Format:** counter

    **tcp_out_rexmit**

        **Description** Monitored Entity telemetry Metric TCP OUT rexmit

        **Type:** number

        **Format:** counter

    **tcp_out_rst**

        **Description** Monitored Entity telemetry Metric TCP OUT rst

        **Type:** number

        **Format:** counter

    **tcp_out_syn**

        **Description** Monitored Entity telemetry Metric TCP OUT syn

        **Type:** number

        **Format:** counter

    **tcp_out_zero_wnd**

        **Description** Monitored Entity telemetry Metric TCP OUT ZERO wnd

        **Type:** number

        **Format:** counter

.. _1674_reporting:

reporting
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1674_reporting_stats` 

        **Type:** Object

    **template**

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/visibility/mon-entity-telemetry-data/reporting/template <visibility_mon_entity_telemetry_data_reporting_template>`

.. _1674_reporting_stats:

reporting_stats
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **buffer-alloc-failure**

        **Description** Total reporting buffer allocation failures

        **Type:** number

        **Format:** counter

    **dequeued**

        **Description** Total jobs dequeued

        **Type:** number

        **Format:** counter

    **enqueue-fail**

        **Description** Total enqueue jobs failed

        **Type:** number

        **Format:** counter

    **enqueue-pass**

        **Description** Total enqueue jobs passed

        **Type:** number

        **Format:** counter

    **log-transmit-failure**

        **Description** Total log transmit failures

        **Type:** number

        **Format:** counter

    **notif-jobs-in-queue**

        **Description** Total notification jobs in queue

        **Type:** number

        **Format:** counter

.. _1674_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ha-entity-anomaly-off-sent**

        **Description** Total anomaly off HA messages sent

        **Type:** number

        **Format:** counter

    **ha-entity-anomaly-on-sent**

        **Description** Total anomaly on HA messages sent

        **Type:** number

        **Format:** counter

    **ha-entity-create-sent**

        **Description** Total mon entity HA create messages sent

        **Type:** number

        **Format:** counter

    **ha-entity-delete-sent**

        **Description** Total mon entity HA delete messages sent

        **Type:** number

        **Format:** counter

    **ha-entity-periodic-sync-sent**

        **Description** Total mon entity periodic sync messages sent

        **Type:** number

        **Format:** counter

    **lw-mon-entity-created**

        **Description** Total Light-weight entities created

        **Type:** number

        **Format:** counter

    **lw-mon-entity-deleted**

        **Description** Total Light-weight entities deleted

        **Type:** number

        **Format:** counter

    **lw-mon-entity-limit-exceed**

        **Description** Total Light-weight limit exceeded errors

        **Type:** number

        **Format:** counter

    **lw-out-of-memory-alloc-failures**

        **Description** Total Light-weight Out-of-memory failures

        **Type:** number

        **Format:** counter

    **mon-entity-limit-exceed**

        **Description** Total mon entity limit exceed failures

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-file-create-err**

        **Description** Total mon entity rrd file create error

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-file-timestamp-err**

        **Description** Total mon entity rrd file timestamp errors

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-last-update-fetch-failed-err**

        **Description** Total mon entity rrd last update fetch failed errors

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-out-of-memory-err**

        **Description** Total mon entity rrd load failed, out of memory error

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-tune-err**

        **Description** Total mon entity rrd tune error

        **Type:** number

        **Format:** counter

    **mon-entity-rrd-update-err**

        **Description** Total mon entity rrd update error

        **Type:** number

        **Format:** counter

    **out-of-memory-alloc-failures**

        **Description** Total out of memory allocation failures

        **Type:** number

        **Format:** counter

.. _1674_topn:

topn
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`1674_topn_stats` 

        **Type:** Object

.. _1674_topn_stats:

topn_stats
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **heap-alloc-failed**

        **Description** Total heap node alloc failed

        **Type:** number

        **Format:** counter

    **heap-alloc-oom**

        **Description** Total heap node alloc failed Out of Memory

        **Type:** number

        **Format:** counter

    **heap-alloc-success**

        **Description** Total heap node allocated

        **Type:** number

        **Format:** counter

    **heap-deleted**

        **Description** Total Heap node deleted

        **Type:** number

        **Format:** counter

    **obj-deleted**

        **Description** Total Object node deleted

        **Type:** number

        **Format:** counter

    **obj-reg-failed**

        **Description** Total object node alloc failed

        **Type:** number

        **Format:** counter

    **obj-reg-oom**

        **Description** Total object node alloc failed Out of Memory

        **Type:** number

        **Format:** counter

    **obj-reg-success**

        **Description** Total object node allocated

        **Type:** number

        **Format:** counter