..
    Warning: Do not edit this file. It is automatically generated from the
    software project's code and your changes will be overwritten.

    The tool to generate this file lives in openstack-doc-tools repository.

    Please make any changes needed in the code, then run the
    autogenerate-config-doc tool from the openstack-doc-tools repository, or
    ask for help on the documentation mailing list, IRC channel or meeting.

.. _ceilometer-collector:

.. list-table:: Description of collector configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[collector]**
     -
   * - ``batch_size`` = ``1``
     - (Integer) Number of notification messages to wait before dispatching them
   * - ``batch_timeout`` = ``None``
     - (Integer) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely)
   * - ``requeue_event_on_dispatcher_error`` = ``False``
     - (Boolean) Requeue the event on the collector event queue when the collector fails to dispatch it.
   * - ``requeue_sample_on_dispatcher_error`` = ``False``
     - (Boolean) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.
   * - ``udp_address`` = ``0.0.0.0``
     - (String) Address to which the UDP socket is bound. Set to an empty string to disable.
   * - ``udp_port`` = ``4952``
     - (Unknown) Port to which the UDP socket is bound.
   * - ``workers`` = ``1``
     - (Integer) Number of workers for collector service. default value is 1.
   * - **[dispatcher_file]**
     -
   * - ``backup_count`` = ``0``
     - (Integer) The max number of the files to keep.
   * - ``file_path`` = ``None``
     - (String) Name and the location of the file to record meters.
   * - ``max_bytes`` = ``0``
     - (Integer) The max size of the file.