Installing the Loggregator Firehose Plugin for cf CLI

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

The Loggregator Firehose plug-in 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 plug-ins 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.

Prerequisites

Before you install the Loggregator Firehose plug-in, you need the following 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 plug-in:

Add the CF Community plug-in repository to your cf CLI plug-ins by running:
```
cf add-plugin-repo CF-Community https://plugins.cloudfoundry.org
```
Install the Firehose plug-in from the CF Community plug-in 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 plug-in:

Run cf plugins to see a list of installed plug-ins.

$ cf plugins
Listing Installed Plugins...
OK
Plugin Name      Version   Command Name   Command Help
FirehosePlugin   0.6.0     nozzle         Command to print out messages from the firehose

Uninstall the plug-in by running:
```
cf uninstall-plugin FirehosePlugin
```