Installing and Configuring ISS Knowtify Search Analytics

This topic describes how to install and configure ISS Knowtify Search Analytics for Pivotal Cloud Foundry (PCF).

Before installing the Knowtify Search Analytics tile, consult the ISS Knowtify Search Analytics Resource Requirements topic. After installing the tile, follow the steps in the Using the ISS Knowtify Search Analytics Dashboard topic to access the ISS Knowtify Search Analytics Dashboard.

Install and Configure the ISS Knowtify Search Analytics Tile

  1. Download the product file from Pivotal Network.

  2. Upload the product file on the Ops Manager Installation Dashboard.

  3. Click Add next to the uploaded ISS Knowtify Search Analytics tile in the Ops Manager Available Products view to add it to your staging area.

  4. Click the newly added Knowtify Search Analytics tile.

  5. From the Settings tab, click KSA-CLOUD Configuration.

    Ksa cloud config

    Complete the following fields:

    • Solr Port: The port that the Solr server runs on.
    • Logstash Listen Port: The port that Logstash listens on.
    • Custom Grok line: These five lines provide the optional ability to enter custom Grok lines that will be used by the Logstash component to parse log files. See the Grok documentation for more information.
  6. Click Save.

  7. Return to the Ops Manager Installation Dashboard and click Apply Changes to install the ISS Knowtify Search Analytics tile.

  8. Follow the steps in the Using the ISS Knowtify Search Analytics Dashboard to access the ISS Knowtify Search Analytics Dashboard.

Configure Log Data Ingestion

Operators can configure ISS Knowtify Search Analytics to ingest log data from PCF Elastic Runtime components or applications.

To configure log data ingestion, you must know your Logstash server IP address and port number. If you do not, perform the following steps to retrieve them:

  1. Navigate to the Ops Manager Installation Dashboard and click the Knowtify Search Analytics tile.

  2. From the Settings tab, click KSA-CLOUD Configuration.

  3. Record the value for the Logstash Listen Port. The default is 9514.

  4. Click the Status tab.

  5. Record the value for the Logstash Server IP address.

Ingest Log Data from Elastic Runtime Components

To configure ISS Knowtify Search Analytics to ingest log data from PCF Elastic Runtime components, perform the following steps:

  1. Return to the Ops Manager Installation Dashboard and click the Pivotal Elastic Runtime tile.

  2. From the Settings tab, click System Logging.

  3. For External Syslog Aggregator Hostname, enter the Logstash Server IP address recorded above.

  4. For External Syslog Aggregator Port, enter the Logstash Listen Port recorded above.

  5. For External Syslog Network Protocol, select TCP protocol.

  6. Enter a value for the Syslog Drain Buffer.

  7. Click Save.

  8. Return to the Ops Manager Installation Dashboard and click Apply Changes to apply the configuration settings.

Ingest Log Data from Applications

To configure ISS Knowtify Search Analytics to ingest log data from applications, perform the following steps:

  1. Download and install the Cloud Foundry Command Line Interface (cf CLI). For more information, see the Installing the cf CLI topic.

  2. Create a user-provided service instance, replacing SERVICE-INSTANCE-NAME with the name of the instance, LOGSTASH-IP with your Logstash server IP address, and LOGSTASH-PORT with your Logstash server port number:

    $ cf cups SERVICE-INSTANCE-NAME -l syslog://LOGSTASH-IP:LOGSTASH-PORT

  3. List the applications in your space:

    $ cf apps
    Getting apps in org example / space development as admin... OK name requested state instances memory disk urls spring-music started 1/1 1G 1G spring-music.example.com

  4. Bind the service instance to the application you want to ingest logs from:

    $ cf bind-service APP-NAME SERVICE-INSTANCE-NAME

    After binding the service instance, log data from the application begins to flow into the ISS Knowtify Search Analytics dashboard.

    Note: If log data from the application does not appear in the ISS Knowtify Search Analytics dashboard, restage the app with cf restage APP-NAME or repush the app with cf push APP-NAME.

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