confluent local status

Description

View the status of services or connectors.

Important

The confluent local commands are intended for a single-node development environment and are not suitable for a production environment. The data that are produced are transient and are intended to be temporary. For production-ready workflows, see Install and Upgrade Confluent Platform.

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

Caution

You must include a double dash (--) between the topic name and your flag. For more information, see this post.

Flags

Tip

You must either specify the path for each Confluent CLI confluent local command invocation, export the path as an environment variable for each terminal session, or set the path to your Confluent Platform installation in your shell profile. For example:

cat ~/.bash_profile
export CONFLUENT_HOME=<path-to-confluent>
export PATH="${CONFLUENT_HOME}/bin:$PATH"
Name, shorthand Description
connectors Print a list of the connectors currently loaded in Connect.
--path <path-to-confluent> Path to Confluent Platform install directory.
-h, --help Print command information.

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:

    confluent local status
    

    Your output should resemble:

    connect is [UP]
    kafka-rest is [UP]
    schema-registry is [UP]
    kafka is [UP]
    zookeeper is [UP]
    
  • Print the status of the kafka service.

    confluent local status kafka
    

    Your output should resemble:

    kafka is [UP]
    zookeeper is [UP]
    
  • Print a list with the currently loaded connectors.

    confluent local status connectors
    

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

    [
      "s3-sink"
    ]
    
  • Prints the status of a connector named file-source:

    confluent local status file-source