Learn how to install the Loggregator Firehose Plug-in for the Cloud Foundry Command Line Interface (cf CLI).

The Loggregator Firehose plugin for the cf CLI allows VMware Tanzu Application Service for VMs (TAS for VMs) admins to access the output of the Loggregator Firehose. The output of the Firehose includes logs and metrics from apps deployed on TAS for VMs as well as metrics from TAS for VMs platform components. For more information about the Firehose, see the Loggregator Architecture section of the Loggregator Architecture topic.

For more information about using plugins with the cf CLI, see Using cf CLI Plugins.

If you don’t want to use the Firehose, you can configure an aggregate log and metric drain for your foundation. For more information, see Configure System Logging in Configuring TAS for VMs.


Before you install the Loggregator Firehose plug-in, you need these prerequisites:

  • Admin access to the TAS for VMs deployment that you want to monitor

  • Cloud Foundry Command Line Interface (cf CLI) v6.12.2 or later

For information about downloading, installing, and uninstalling the cf CLI, see Installing the cf CLI.

Installing the Plug-in

To install the Loggregator Firehose plugin:

  1. Add the CF Community plugin repository to your cf CLI plugins by running:

    cf add-plugin-repo CF-Community https://plugins.cloudfoundry.org
  2. Install the Firehose plugin from the CF Community plugin repository by running:

    cf install-plugin -r CF-Community "Firehose Plugin"

Viewing the Firehose

To view the streaming output of the Firehose, which includes logging events and metrics from TAS for VMs system components, run the following cf command. You must be logged in as a TAS for VMs admin to access the Firehose.

cf nozzle --debug

For more information about logging and metrics in TAS for VMs, see Loggregator Architecture.

Uninstalling the Plug-in

To uninstall the Loggregator Firehose plugin:

  1. Run cf plugins to see a list of installed plugins.

    $ cf plugins
    Listing Installed Plugins...
    Plugin Name      Version   Command Name   Command Help
    FirehosePlugin   0.6.0     nozzle         Command to print out messages from the firehose
  2. Uninstall the plugin by running:

    cf uninstall-plugin FirehosePlugin
check-circle-line exclamation-circle-line close-line
Scroll to top icon