VMware Tanzu Application Service
The Sumo Logic Nozzle for VMware Tanzu Firehose allows operations teams and app owners to monitor and troubleshoot the VMware Tanzu platform and apps in real time, without having to install a Sumo Logic agent in their Cloud Foundry environment.
The nozzle filters out messages per your tile configuration and securely sends those logs and metrics to an HTTP API in the Sumo Logic SaaS service. The tile allows you to configure batching intervals, toggle verbose logging mode, and add metadata to your logs and metrics.
The only configuration you need to do on the Sumo Logic platform is to enable the HTTP API (an HTTP Source) and record the URL. After you deploy the tile, you are able to query the logs and metrics and monitor the log stream using Live Tail.
The Sumo Logic nozzle is written in Go and is based on the firehose-to-syslog nozzle.
Key features of Sumo Logic Nozzle for VMware Tanzu include:
- View dashboards to monitor the overall health and security of your VMware Tanzu resources.
- Drill down from alerts to see key performance metrics and audit logs for VMware Tanzu and your custom apps.
- Store VMware Tanzu audit details in a fully secure SOC 2, HIPAA, and PCI-compliant environment.
Prerequisites
Before you install the Sumo Logic Nozzle for VMware Tanzu tile, you'll need Administrative access to your VMware Tanzu deployment.
To learn about compatible Tanzu Application Service versions, refer to the latest release.
Setup
This section has instructions for installing and configuring Sumo Logic Nozzle for VMware Tanzu.
Source configuration
Follow the below steps to configure the Hosted Collector to receive VMware Tanzu events:
- In the Sumo Logic portal, create a new Hosted Collector or use an existing one. Then add an HTTP Logs and Metrics Source.
- Configure Source Category in the HTTP Source - for example,
vmware-tanzu/logs
- for the VMware Tanzu integration. - Copy and save the endpoint URL of the source.
Vendor configuration
- Download the product file from Pivotal Network.
- Navigate to the Ops Manager Installation Dashboard and click Import a Product to upload the product file.
- Under the Import a Product button, click + next to the version number of Sumo Logic Nozzle for VMware Tanzu. This adds the tile to your staging area.
- Click the newly added Sumo Logic Nozzle for VMware Tanzu tile to access the configuration settings.
- Assign AZs and Networks.
- Choose placement.
- Click Save.
- Configure Sumo Logic Settings.
- Sumo Logic Endpoint. Click Add, then enter the endpoint that you configured when specifying VMware Tanzu as an HTTP Source for Sumo Logic.
note
You can set up multiple endpoints with different settings.
- Sumo Logic Post Minimum Delay. Enter a time in milliseconds for the post minimum delay. The default is 2000ms.
- (Optional) Sumo Logic Category. Specify a source category to call data with that specific metadata tag. For example,
MyOrg/MyCategory
. - (Optional) Sumo Logic Name. Specify a source name locally to distinguish it from the configured HTTP Source configuration and prevent metadata overwrites if you have more than one use for that source (e.g.,
MyPivotalApp
). - (Optional) Sumo Logic Host. If you have a local file source, you can specify a hostname. If you are using a Remote Host, do not use this field.
- (Optional) Custom Metadata. Add custom metadata to the JSON. For example,
key1:value1,key2:value2
. - (Optional) Include Only Matching Filter. Include only designated events.
- (Optional) Exclude Always Filter. Exclude specific events that are not pertinent to your search, such as
cf\_app\_name:sumo-logic-nozzle-0.1.0
. - Click Save.
- Sumo Logic Endpoint. Click Add, then enter the endpoint that you configured when specifying VMware Tanzu as an HTTP Source for Sumo Logic.
- Configure Cloud Foundry Settings.
- Cloud Foundry API Endpoint. Enter your API endpoint.
- Cloud Foundry User. Specify your Cloud Foundry username.
- Cloud Foundry Password. Enter Cloud Foundry password.
- Log Events Batch Size. Choose how many messages need to occur before they are sent to Sumo Logic.
- Comma-separated list of events you would like (Default is "LogMessage"). List any additional events (no spaces between events) that you want to be included, such as Error, Container Metric, HttpStart, HttpStop, HttpStartStop, LogMessage, ValueMetric, or CounterEvent.
- Skip SSL Validation. This option should only be checked if you are on a known and trusted dev environment and have expired certificates. Do not enable this option for a production system.
- Verbose in 'LogMessage' event. Enable this option if you need more detail than the default logging information,
timestamp
,cf_app_guid
,Msg
. This is what a log message looks like when you turn on verbose: - Nozzle Polling Period. Set how frequently the Nozzle polls the Cloud Foundry Nozzle for data. Sumo Logic recommends 5000ms.
- Click Save.
- Errands. Leave settings as default.
- Resource Config. For both deploy-all and delete-all, use VM Type setting the Automatic Micro.
- Stemcell. Ensure the proper stemcell is available.
- Return to the Ops Manager Installation Dashboard.
- Click Apply Changes. The installation can take a few minutes to complete. You will see a message confirming your changes have been applied.
Using Sumo Logic Nozzle for VMware Tanzu
This section describes how to use Sumo Logic Nozzle for VMware Tanzu. After installation, the Sumo Logic Nozzle is available in the Apps Manager.
- From the system drop-down menu, select sumo-logic-nozzle-org.
- Under Apps, select the name of the build you want. For example, sumo-logic-nozzle-0.1.0-build3.
- Push the Start button to begin running the nozzle.
- Cloud Foundry will provision the VMs and begin running the nozzle service.
- Verify Sumo Logic Nozzle for VMware Tanzu tile is installed and started running the nozzle service by running searches. If this is your first time using Sumo Logic, see Getting Started with Search.
Dashboards and alerts
Once the nozzle is set up, you can create dashboards and alerts from the data.
Troubleshooting
To troubleshoot the Sumo Logic Nozzle integration with VMware Tanzu:
- Log in to Apps Manager.
- Navigate to Home > ORG
<sumo-logic-nozzle-org>
> SPACE<sumo-logic-nozzle-space>
. - Click on Name.
- The app page appears. Click Logs.
- On the Logs page it will show you logs related to the Sumo Logic Nozzle integration.
More information
- For detailed version information, refer to the changelog file.
- For support, contact VMware Tanzu Feedback list or Sumo Logic Support.