Installing the Loggregator Firehose Plugin for cf CLI

Page last updated:

This topic describes how to install the Loggregator Firehose Plugin for the Cloud Foundry Command Line Interface (cf CLI).

Overview

The Loggregator Firehose plugin for the cf CLI allows Cloud Foundry Application Runtime (CFAR) admins to access the output of the Loggregator Firehose. The output of the Firehose includes logs and metrics from apps deployed on CFAR as well as metrics from CFAR 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.

Note: You can disable the Firehose. In place of the Firehose, you can configure an aggregate log and metric drain for your foundation.

Prerequisites

Before installing the Loggregator Firehose plugin, you need:

  • Admin access to the CFAR 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.

Install the Plugin

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"
    

View the Firehose

To view the streaming output of the Firehose, which includes logging events and metrics from CFAR system components, run:

cf nozzle --debug

Note: You must be logged in as a CFAR admin to access the Firehose.

For more information about logging and metrics in CFAR, see Loggregator Architecture.

Uninstall the Plugin

To uninstall the Loggregator Firehose plugin:

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

    $ 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
    

  2. Uninstall the plugin by running:

    cf uninstall-plugin FirehosePlugin
    
Create a pull request or raise an issue on the source for this page in GitHub