Netskope WebTx Source

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

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.

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

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 Sumo Logic, select Manage Data > Collection > Collection.
2. On the Collection page, click Add Source next to a Hosted** **Collector.
3. Select Netskope WebTx API.
4. Enter a Name to display the Source in the Sumo web application. The description is optional.
5. (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.
6. 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.
     • A green circle with a check-mark is shown when the field exists and is enabled in the Fields table schema.
     • 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.

The REGENERATE ENDPOINT button generates a new subscription path. After a new subscription path is generated, a new subscription key must be generated by clicking on the GENERATE AND DOWNLOAD KEY button. The old subscription path and key expire. With a new subscription path, event streaming will start fresh from the beginning of the retention period which is 7 days by default.

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

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

1. Open the Collection page, and go to Manage Data > Collection > Collection.
2. Select the source and click the information icon on the right side of the row.
3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
   
4. Click Confirm to send the restart request.
   
5. The bottom left of the platform will provide a notification informing you the request was successful.
   

API

To restart your source using the Sumo Management API, follow the instructions below:

• Method: POST
• Example endpoint:

  https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

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"
  }
}