.. _confluent_local_log:

=============
confluent log
=============

Description
-----------
View a snapshot or `tail <https://en.wikipedia.org/wiki/Tail_(Unix)>`_ the log of a service.


Usage
-----

.. codewithvars:: bash

    confluent log <service> [<argument>]

.. tip:: For usage information, enter ``confluent help log``.

Options
-------

None.

Positional arguments
--------------------

===============  ========  ========================================================
Name, shorthand  Default   Description
===============  ========  ========================================================
``<service>``              The service name.
``<argument>``   Snapshot  Optional: Specify a
                           `tail <https://en.wikipedia.org/wiki/Tail_(Unix)>`_
                           argument.  If no arguments are given, a snapshot of
                           the log is opened using the ``less`` command viewer.
===============  ========  ========================================================

Examples
--------

- View a snapshot of the Connect log with the ``less`` viewer.

  .. codewithvars:: bash

    confluent log connect

- Tail the |ak-tm| log and wait to print additional output until the log command is interrupted.

  .. codewithvars:: bash

    confluent log kafka -f

  .. tip::
    Type ``man tail`` to get more information about the available options.