.. _cli-confluent-status:

================
confluent status
================

Description
-----------
View the status of services or connectors.

Usage
-----

.. sourcecode:: bash

    confluent status [ <service> | connectors | <connector-name> ]

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

Options
-------


===================================  =======  ==============================================
Name, shorthand                      Default  Description
===================================  =======  ==============================================
``connectors``                                Print a list of the connectors currently
                                              loaded in Connect.
===================================  =======  ==============================================


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

====================  ==============  ========================================================
Name, shorthand       Default         Description
====================  ==============  ========================================================
``<connector-name>``                  The connector name. If only the connector name is
                                      specified, the connector status is printed.
``<service>``         All services    The service name. If specified, it provides the status
                                      of the service and all dependencies.

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

Examples
--------

- Print the status of the available services:

  .. sourcecode:: bash

    confluent status

  Your output should resemble:

  .. sourcecode:: bash

    connect is [UP]
    kafka-rest is [UP]
    schema-registry is [UP]
    kafka is [UP]
    zookeeper is [UP]

- Print the status of the ``kafka`` service.

  .. sourcecode:: bash

    confluent status kafka

  Your output should resemble:

  .. sourcecode:: bash

    kafka is [UP]
    zookeeper is [UP]

- Print a list with the currently loaded connectors.

  .. sourcecode:: bash

    confluent status connectors

  For example, if you have loaded the ``s3-sink`` connector, your output should resemble:

  .. sourcecode:: bash

    [
      "s3-sink"
    ]

- Prints the status of a connector named ``file-source``:

  .. sourcecode:: bash

    confluent status file-source