suricata_check.checkers.community.best
======================================

.. py:module:: suricata_check.checkers.community.best

.. autoapi-nested-parse::

   `BestChecker`.



Classes
-------

.. autoapisummary::

   suricata_check.checkers.community.best.BestChecker


Module Contents
---------------

.. py:class:: BestChecker(include: Optional[collections.abc.Iterable[str]] = None)

   Bases: :py:obj:`suricata_check.checkers.interface.CheckerInterface`


   The `BestChecker` contains several checks for best practices to improve the experience of Suricata rules for everyone.

   Codes C100-C110 report on missing fields that should be set.

   Initializes the checker given a list of issue codes to emit.


   .. py:attribute:: codes

      A Mapping of issue codes emitted by the checker to metadata for those issue types.
      The metadata is structured in the form of a Mapping from attribute name to attribute value.
      The one mandatory metadata attribute is severity, which must be one of the levels provided by the `logging` module