Installing and Configuring Microsoft Azure Log Analytics Nozzle for PCF

This topic describes how to install and configure Microsoft Azure Log Analytics Nozzle for Pivotal Cloud Foundry (PCF).

Create an OMS Workspace

Create an OMS workspace to send your PCF data to.

  1. Log into the the Azure portal.

  2. Search the list of services in the Marketplace for Log Analytics, and then select Log Analytics. Create workspace 1

  3. Click Create, then enter or select choices for the following:

    1. OMS Workspace: Enter a name for your workspace.
    2. Subscription: If you have multiple subscriptions, choose the one you want to associate with the new workspace.
    3. Resource group
    4. Location
    5. Pricing tier

      Create workspace 2

  4. Click OK to create the workspace.

  5. Find the newly-created workspace in the Azure portal, and then click OMS Portal > Settings > Connected Sources.

  6. Record the Workspace ID and Primary Key values for the workspace. Workspace key

Create a CF User Account

Create a Cloud Foundry (CF) user account with access to the Firehose and Cloud Controller. The Microsoft Azure Log Analytics Nozzle for PCF service uses this account to retrieve log data.

  1. Install the User Account and Authentication command-line interface (uaac), if you have not already:

    $ gem install cf-uaac

  2. Log into the CF Command-Line Interface (cf CLI) as user admin:

    $ cf login -a https://api.YOUR-SYSTEM-DOMAIN -u admin -p UAA-ADMIN-CREDENTIALS-SECRET

  3. Target your system with the uaac:

    $ uaac target https://uaa.YOUR-SYSTEM-DOMAIN

  4. Authenticate and obtain an access token for the admin client from the User Account and Authentication (UAA) server:

    $ uaac token client get admin -s UAA-ADMIN-CLIENT-CREDENTIALS-SECRET

  5. Create a CF user account:

    $ cf create-user FIREHOSE-USER FIREHOSE-USER-PASSWORD

  6. Add the new user to the Cloud Controller Admin Read-Only group or Cloud Controller Admin group:

    • For Elastic Runtime v1.9.x and later:
      $ uaac member add cloud_controller.admin_read_only FIREHOSE-USER
    • For Elastic Runtime v1.8.x:
      $ uaac member add cloud_controller.admin FIREHOSE-USER
  7. Add the new user to the Doppler Firehose group:

    $ uaac member add doppler.firehose FIREHOSE-USER

Install and Configure Microsoft Azure Log Analytics Nozzle for PCF

  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 Microsoft Azure Log Analytics Nozzle for PCF. This adds the tile to your staging area.

  4. Click the newly-added Microsoft Azure Log Analytics Nozzle for PCF tile.

  5. In the Nozzle Config pane, fill in configuration options as follows:

    1. OMS Workspace ID: Enter the OMS workspace ID from the Create an OMS Workspace step.
    2. OMS Workspace Key: Enter the OMS workspace key from the Create an OMS Workspace step.
    3. OMS Post Timeout: Specify the HTTP post timeout for sending events to OMS Log Analytics. Default is 10s.
    4. OMS Batch Time: Specify the interval for posting a batch of messages to OMS Log Analytics. Default is 10s.
    5. Max Event Number Per Batch: Specify the maximum number of messages in a batch. Default is 1000.
    6. Firehose Username: Enter the name of the user that you created in the Create a CF User Account step.
    7. Firehose User Password: Enter the password of the user that you created in the Create a CF User Account step.
    8. Cloud Foundry API Address: Enter the API URL of the PCF environment. e.g. https://api.203.0.113.0.xip.io.
    9. Cloud Foundry Doppler Address: Enter the URL of the Loggregator Traffic Controller. e.g. wss://doppler.203.0.113.0.xip.io:443.
    10. Cloud Foundry Environment: Enter the label to identify logs and metrics from different PCF environments.
    11. Skip SSL Validation: Enable this option only if you are on a known and trusted dev environment and have expired certificates. Do not enable this option for a production system.
    12. Event Types to be Filtered out: A comma-separated list of the event types to be filtered out. Valid event types include METRIC, LOG, and HTTP.
    13. Idle Timeout: Specify the keep-alive duration for the Firehose consumer. Default is 60s.
    14. Log Event Count: Enable this option to log the total count of events that the nozzle receives, sends and loses, to OMS Log Analytics as CounterEvents.
    15. Log Event Count Interval: The time interval for logging event count to OMS Log Analytics. Default is 60s.
    16. Log Level: Logging level of the nozzle. Options are Debug, Info, and Error. Default is Debug.
  6. In the Errands pane, leave the default settings.

  7. In the Resource Config pane, leave the default settings.

  8. In the Stemcell pane, ensure that the proper stemcell is specified.

  9. Return to the Ops Manager Installation Dashboard and click Apply Changes to install Microsoft Azure Log Analytics Nozzle for PCF tile.

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