:tocdepth: 3

base/bif/stats.bif.zeek
=======================
.. zeek:namespace:: GLOBAL


:Namespace: GLOBAL

Summary
~~~~~~~
Functions
#########
========================================================= =======================================================
:zeek:id:`get_broker_stats`: :zeek:type:`function`        Returns statistics about Broker communication.
:zeek:id:`get_conn_stats`: :zeek:type:`function`          Returns Zeek traffic statistics.
:zeek:id:`get_dns_stats`: :zeek:type:`function`           Returns statistics about DNS lookup activity.
:zeek:id:`get_event_handler_stats`: :zeek:type:`function` Returns statistics about calls to event handlers.
:zeek:id:`get_event_stats`: :zeek:type:`function`         Returns statistics about the event engine.
:zeek:id:`get_file_analysis_stats`: :zeek:type:`function` Returns statistics about file analysis.
:zeek:id:`get_gap_stats`: :zeek:type:`function`           Returns statistics about TCP gaps.
:zeek:id:`get_matcher_stats`: :zeek:type:`function`       Returns statistics about the regular expression engine.
:zeek:id:`get_net_stats`: :zeek:type:`function`           Returns packet capture statistics.
:zeek:id:`get_proc_stats`: :zeek:type:`function`          Returns Zeek process statistics.
:zeek:id:`get_reassembler_stats`: :zeek:type:`function`   Returns statistics about reassembler usage.
:zeek:id:`get_reporter_stats`: :zeek:type:`function`      Returns statistics about reporter messages and weirds.
:zeek:id:`get_thread_stats`: :zeek:type:`function`        Returns statistics about thread usage.
:zeek:id:`get_timer_stats`: :zeek:type:`function`         Returns statistics about timer usage.
========================================================= =======================================================


Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: get_broker_stats
   :source-code: base/bif/stats.bif.zeek 240 240

   :Type: :zeek:type:`function` () : :zeek:type:`BrokerStats`

   Returns statistics about Broker communication.


   :returns: A record with Broker statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_conn_stats
   :source-code: base/bif/stats.bif.zeek 45 45

   :Type: :zeek:type:`function` () : :zeek:type:`ConnStats`

   Returns Zeek traffic statistics.


   :returns: A record with connection and packet statistics.

   .. zeek:see:: get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_dns_stats
   :source-code: base/bif/stats.bif.zeek 122 122

   :Type: :zeek:type:`function` () : :zeek:type:`DNSStats`

   Returns statistics about DNS lookup activity.


   :returns: A record with DNS lookup statistics.

   .. zeek:see:: get_conn_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_event_handler_stats
   :source-code: base/bif/stats.bif.zeek 266 266

   :Type: :zeek:type:`function` () : :zeek:type:`EventNameStats`

   Returns statistics about calls to event handlers.


   :returns: A record with event call statistics.


.. zeek:id:: get_event_stats
   :source-code: base/bif/stats.bif.zeek 83 83

   :Type: :zeek:type:`function` () : :zeek:type:`EventStats`

   Returns statistics about the event engine.


   :returns: A record with event engine statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_file_analysis_stats
   :source-code: base/bif/stats.bif.zeek 160 160

   :Type: :zeek:type:`function` () : :zeek:type:`FileAnalysisStats`

   Returns statistics about file analysis.


   :returns: A record with file analysis statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_gap_stats
   :source-code: base/bif/stats.bif.zeek 198 198

   :Type: :zeek:type:`function` () : :zeek:type:`GapStats`

   Returns statistics about TCP gaps.


   :returns: A record with TCP gap statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_matcher_stats
   :source-code: base/bif/stats.bif.zeek 220 220

   :Type: :zeek:type:`function` () : :zeek:type:`MatcherStats`

   Returns statistics about the regular expression engine. Statistics include
   the number of distinct matchers, DFA states, DFA state transitions, memory
   usage of DFA states, cache hits/misses, and average number of NFA states
   across all matchers.


   :returns: A record with matcher statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_net_stats
   :source-code: base/bif/stats.bif.zeek 26 26

   :Type: :zeek:type:`function` () : :zeek:type:`NetStats`

   Returns packet capture statistics. Statistics include the number of
   packets *(i)* received by Zeek, *(ii)* dropped, and *(iii)* seen on the
   link (not always available).


   :returns: A record of packet statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_proc_stats
   :source-code: base/bif/stats.bif.zeek 64 64

   :Type: :zeek:type:`function` () : :zeek:type:`ProcStats`

   Returns Zeek process statistics.


   :returns: A record with process statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_reassembler_stats
   :source-code: base/bif/stats.bif.zeek 103 103

   :Type: :zeek:type:`function` () : :zeek:type:`ReassemblerStats`

   Returns statistics about reassembler usage.


   :returns: A record with reassembler statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

   :param TODO: this should have been deprecated before?

.. zeek:id:: get_reporter_stats
   :source-code: base/bif/stats.bif.zeek 259 259

   :Type: :zeek:type:`function` () : :zeek:type:`ReporterStats`

   Returns statistics about reporter messages and weirds.


   :returns: A record with reporter statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_timer_stats
                get_broker_stats

.. zeek:id:: get_thread_stats
   :source-code: base/bif/stats.bif.zeek 179 179

   :Type: :zeek:type:`function` () : :zeek:type:`ThreadStats`

   Returns statistics about thread usage.


   :returns: A record with thread usage statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_timer_stats
                get_broker_stats
                get_reporter_stats

.. zeek:id:: get_timer_stats
   :source-code: base/bif/stats.bif.zeek 141 141

   :Type: :zeek:type:`function` () : :zeek:type:`TimerStats`

   Returns statistics about timer usage.


   :returns: A record with timer usage statistics.

   .. zeek:see:: get_conn_stats
                get_dns_stats
                get_event_stats
                get_file_analysis_stats
                get_gap_stats
                get_matcher_stats
                get_net_stats
                get_proc_stats
                get_reassembler_stats
                get_thread_stats
                get_broker_stats
                get_reporter_stats


