Skip to main content
Sumo Logic

Netskope WebTx Source

The Netskope WebTx API integration ingests Web Transaction logs from Netskope Event Steam.

The Netskope WebTx API integration ingests Web Transaction logs from Netskope Event Steam.

States

A Netskope WebTx API Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

An Netskope WebTx API Source goes through the following states when created:

  1. Pending: Once the Source is submitted it is validated, stored, and placed in a Pending state.
  2. Started: A collection task is created on the Hosted Collector.
  3. Initialized: The task configuration is complete in Sumo Logic.
  4. Authenticated: The Source successfully authenticated with Symantec.
  5. Collecting: The Source is actively collecting data from Symantec.

If the Source has any issues during any one of these states it is placed in an Error state.

When you delete the Source it is placed in a Stopping state, when it has successfully stopped it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

clipboard_e0b01a4e39121ac482ad32c6bc9fc20f2.png

Hover your mouse over the status icon to view a tooltip with a count of the detected errors and warnings.

hover c2c error.png

You can click on the status icon to open a Health Events panel with details on each detected issue.

Data Sources

The netskope-webtx access a PubSub lite service hosted by Google to retrieve web transaction logs. Details on what is ingested can be found here

Setup and Configuration

Netskope Web Transactions integration needs to be configured using Netskope Streaming credentials. You can collect the subscription path and credentials here

Create an Netskope WebTx API Source

When you create an Netskope WebTx API Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure an Netskope WebTx API Source:

  1. In the Sumo Logic web app, select Manage Data > Collection > Collection
  1. On the Collection page, click Add Source next to a Hosted Collector.
  1. Select Netskope WebTx API.
    clipboard_e52bb96c6feb579148f3741226001fdc2.png
  1. Enter a Name to display the Source in the Sumo web application. The description is optional.
    clipboard_e81c269166e590888e01223d0b1e6b45c.png
  1. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  2. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value
_siemVendor Netskope
_siemProduct WebTx
_siemFormat JSON
_siemEventID webtx
  1. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
    • Define the fields you want to associate, each field needs a name (key) and value. 
      • green check circle.png A green circle with a check-mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped. 
  2. You will need a subscription endpoint URL and subscription key to access the streamed events. Log in to your Netskope UI and go to Settings > Tools > Event Streaming. Copy your subscription endpoint and generate your download key from the Event Streaming page. clipboard_e51845c58c0e0742ba2d4b41d701965e1.png
  3. After the transaction events feature is enabled in your account, you’ll be able to consume the data from the subscription endpoint.
  4. To receive the events from the subscription, refer to the Receiving messages from Lite subscriptions link. You can receive messages with various Client libraries. Netskope retains transaction events for seven days by default if not consumed.
  5. When you are finished configuring the file, upload the JSON file.

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type Reason Retries Retry Behavior Health Event Name
ThirdPartyConfig Normally due to an invalid configuration. You'll need to review your Source configuration and make an update. No retries are attempted until the Source is updated. Not applicable ThirdPartyConfigError
ThirdPartyGeneric Normally due to an error communicating with the third party service APIs. Yes The Source will retry for up to 90 minutes, after which it quits. ThirdPartyGenericError
FirstPartyGeneric Normally due to an error communicating with the internal Sumo Logic APIs. Yes The Source will retry for up to 90 minutes, after which it quits. FirstPartyGenericError

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter Type Required? Description Access
config JSON Object Yes Contains the configuration parameters for the Source.  
schemaRef JSON Object Yes Use {"type":"Netskope WebTx API"} for a Netskope WebTx API Source. not modifiable
sourceType String Yes Use Universal for a Netskope WebTx API Source. not modifiable

The following table shows the config parameters for a Netskope WebTx API Source.

Parameter Type Required? Default Description Access
name String Yes   Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source. modifiable
description String No null Type a description of the Source. modifiable
category String No null Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details. modifiable
fields JSON
Object
No   JSON map of key-value fields (metadata) to apply to the Collector or Source.

Use the boolean field _siemForward to enable forwarding to SIEM.
modifiable

credentialsJson

String

Yes

 

Its the authentication credentials to access Netskope webtx Event Streaming service

modifiable

subscriptionPath

String

Yes

 

A subscription path is needed for the event streaming to start.

modifiable

Netskope WebTx Source JSON example:

{
  "api.version":"v1",
  "source":{
    "state":{
    "config":{
      "name":"webtx-test",
      "subscriptionPath":"projects/webtx-test",
      "startFromBeginning":false,
      "fields":{
        "_siemForward":false
      },
      "category":"webtx",
      "credentialsJson":"********"
    },
    "schemaRef":{
      "type":"Netskope WebTx"
    },
    "sourceType":"Universal"
  }
}