Installing and Configuring Honeycomb Nozzle for PCF

This topic describes how to install and configure Honeycomb Nozzle for Pivotal Cloud Foundry (PCF).

Create an Account on Honeycomb

Before you install the Honeycomb Nozzle for PCF tile, you need to have an account on Honeycomb. If you have an existing account, record the team Write Key for that account; no need to create a new one.

Complete the following steps to set up a Honeycomb account:

  1. Follow the instructions at https://honeycomb.io/signup to create a Honeycomb account and choose a team name.

  2. Record your team Write Key from https://ui.honeycomb.io/account.

Create PCF System Accounts

Complete the following steps to create a UAA user that gives the Nozzle access to the Firehose and Cloud Controller.

  1. Install the UAA Command Line Interface (CLI) tool, uaac:

    $ gem install cf-uaac
    
  2. Use the uaac target uaa.YOUR-SYSTEM-DOMAIN command to target your UAA server, for example:

    $ uaac target uaa.sys.example.com
    
  3. Record the uaa:admin:client_secret from either:

    • The cf deployment manifest
    • The Ops Manager Installation Dashboard, click the Pivotal Elastic Runtime tile, click Credentials, UAA > Admin Client Credentials
  4. Authenticate to UAA using the client_secret from the previous step:

    $  uaac token client get admin -s ADMIN-CLIENT-SECRET
    
  5. Create a Honeycomb Nozzle user with a password of your choice:

    $ uaac -t user add honeycomb-nozzle-user --password PASSWORD --emails na
    
  6. Add the user to the Cloud Controller Admin Read-Only group:

    $ uaac -t member add cloud_controller.admin_read_only honeycomb-nozzle-user
    
  7. Add the user to the Doppler Firehose group:

    $ uaac -t member add doppler.firehose honeycomb-nozzle-user
    

For information about creating a UAA user, see Creating and Managing Users with the UAA CLI.

Install and Configure the Tile

  1. Download the product file from Pivotal Network.

  2. Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.

  3. Under the Import a Product button, click + next to the version number of Honeycomb Nozzle for PCF. This adds the tile to your staging area.

  4. Click the newly added Honeycomb Nozzle for PCF tile.

  5. On the Settings tab of your Honeycomb Nozzle for PCF tile, click Honeycomb Nozzle for PCF.

  6. Complete the fields: Honeycomb nozzle setup

    • Write Key: See Create an Account on Honeycomb above.
    • Sample Rate: Start with the default 1. Later, if you need to reduce the amount of data sent to Honeycomb, increase this rate. For example, set to 3 to send 1 event for every 3 received.
    • Send Metrics: The PCF Firehose reports both log events and metrics:
      • Set to true to send both metrics and log events to Honeycomb.
      • Set to false to drop metrics and only send log events to Honeycomb (recommended).
    • Skip SSL Verification: Set this to true if you are not using SSL or your SSL certificates don’t have a path back to a known root authority.
    • UAA API user account name: Enter the user you added using the uaac client (honeycomb-nozzle-user in the example above).
    • UAA API user account password: Enter the password you set using the uaac client (PASSWORD in the example above).
    • API URL: Enter the API endpoint for your PCF cluster.
  7. Click Save.

  8. Return to the Ops Manager Installation Dashboard and click Apply Changes to install Honeycomb Nozzle for PCF tile.

Create a pull request or raise an issue on the source for this page in GitHub