Kaltura Source
Kaltura is a video platform for modular systems that exposes different web services that may be deployed in several deployment modes to support different levels of scale. Kaltura’s platform comes in different editions, including the Kaltura-hosted SaaS edition, managed by Kaltura for single publishers and Value Added Resellers (VARs). Kaltura also offers several licensing modes of the self-hosted Kaltura On-Prem edition: Kaltura Community Edition, Kaltura On-Prem for Publishers, and Kaltura OnPrem for OEMs. Kaltura source collects audit trail events and base entry events data and sends it to Sumo Logic.
Data collected
Polling Interval | Data |
---|---|
5 min | Audit Trail Events |
1 hour | Base Entry Events |
Setup
Vendor configuration
In this configuration, you will create a new Kaltura App Token in the Kaltura Developer Portal or via your own hosted API portal to generate an App Token and App ID.
Create a New App Token
A Kaltura App Token with specific permissions is required for Sumo Logic to access Audit Trail and Base Entry Events from Kaltura. Follow the below instructions to create a new App Token.
- Start a Kalutra session using an admin account.
- Enter the following parameters in the body:
- secret. The API Secret Keys that are generated when you create an account.
- expiry. 86400 - KS (Kaltura Session) expiry time in seconds.
- Partnerid. A unique identifier allocated to every Kaltura account. The partner ID can be retrieved from the KMC Integration Settings tab.
- privileges. disableentitlement - Session privileges that allows you to limit the applications to perform only specific actions.
- type. ADMIN [2] - The type of Kaltura session (admin or user).
- userId. The Unique ID of the user who is performing the API call. This ID is the end-user’s ID on the publisher’s system.
- Click on the Send Request.
- Copy and save the Kaltura Session.
- Add a new App Token.
- Enter the following global parameters:
- ks. Paste the KS (Kaltura Session) copied from the previous step.
- format. JSON[1] - format of the response.
- Enter the following body appToken parameters:
- description. Provide a description to identify what the Token will be used for.
- hashType. SHA1[SHA1] - Kaltura App Token Hash Type.
- sessionType. ADMIN[2] - Type of Kaltura Session that will be created using the current token.
- Click on the Send Request.
- Copy and save the App Token, App Token ID, and Partner Id from the response.
Source configuration
When you create an Kaltura 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 a Kaltura source:
- Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection. - On the Collection page, click Add Source next to a Hosted Collector.
- Search for and select Kaltura.
- Enter a Name for the Source. The description is optional.
- (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
. - (Optional) Fields. Click the +Add Field link to 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 in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
- Base URL. Enter the API Base URL.
- Partner ID. Enter the Partner ID collected from the Vendor configuration.
- App Token ID. Enter the App Token ID collected from the Vendor configuration.
- App Token. Enter the App Token collected from the Vendor configuration.
- Select Base Entry Types for Base Entry Logs. You have the option to Collect all types or Select types, where you can specify the exact event categories you would like to collect from the base entry logs. Must select from the pre-defined list.
- Polling Interval. You have the option to select how often to poll for base entry events. Default is 24 hours.
- Base Entry Init Lookback. You have option to configure from when the integration should collect Kaltura Base Entry events. Default is 1 day.
- When you are finished configuring the Source, click Save.
Metadata fields
Field | Value | Description |
---|---|---|
_siemParser | /Parsers/System/Kaltura/Kaltura | Set when Forward To SIEM is checked. |
Base entry event logs are not supported with the SIEM forward option.
JSON schema
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See Use JSON to Configure Sources for details.
Parameter | Type | Value | Required | Description |
---|---|---|---|---|
schemaRef | JSON Object | {"type":"kaltura"} | Yes | Define the specific schema type. |
sourceType | String | "Universal" | Yes | Type of source. |
config | JSON Object | Configuration object | Yes | Source type specific values. |
Configuration Object
Parameter | Type | Required | Default | Description | Example |
---|---|---|---|---|---|
name | String | Yes | null | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source . | "mySource" |
description | String | No | null | Type a description of the source. | "Testing source" |
category | String | No | null | Type a category of the source. This value is assigned to the metadata field _sourceCategory . See best practices for details. | "mySource/test" |
fields | JSON Object | No | null | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM. | {"_siemForward": false, "fieldA": "valueA"} |
apiBaseUrl | String | Yes | null | API URL of your Kaltura environment. | |
partnerId | String | Yes | null | Partneter Id of the customers Kaltura account from where you want to collect the event from. | |
tokenId | String | Yes | null | Client ID of the Kaltura App Token created for Sumo Logic. | |
token | String | Yes | null | Client Token of the Kaltura App Token created for Sumo Logic. | |
supportedApis | Array of strings | Yes | Audit Trail | Define one or more of the available APIs to collect. Options Base Entry, Audit Trail. | |
collectAll | Boolean | Yes | True | By default, the Source will ingest all Base Entry events. If false, baseEntryTypes is required.. | |
baseEntryTypes | Array of strings | no | null | A list of Base Entry Types to collect. Required if collectAll is false. Options: DATA, PLAYLIST, MIX, MEDIA_CLIP, SIP_ENTRY_SERVER, EXTERNAL_MEDIA, CONFERENCE_ENTRY_SERVER. | |
polling_interval | Integer | No | 24 | How frequently the integration should poll to Kaltura for Base Entry Events in hours. | |
baseEntryInitLookback | Integer | No | 1 | From when the integration should collect Kaltura Base Entry Events. |
JSON example
{
"api.version":"v1",
"source":{
"schemaRef":{
"type":"Kaltura"
},
"config":{
"name":"Kaltura",
"collectAll":true,
"partnerId":"*****",
"polling_interval":24,
"supportedApis":["baseEntry","auditTrail"],
"fields":{
"_siemForward":false
},
"token":"***********",
"tokenId":"*******",
"category":"sanbox/kaltura",
"apiBaseUrl":"https://www.kaltura.com",
"baseEntryInitLookback":1
},
"state":{
"state":"Collecting"
},
"sourceType":"Universal"
}
}
Terraform example
resource "sumologic_cloud_to_cloud_source" "kaltura-source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "Kaltura"
}
config = jsonencode({
"name":"Kaltura",
"description":"",
"apiBaseUrl":"https://www.kaltura.com",
"collectAll":true,
"partnerId":"********",
"token":"***********",
"tokenId":"*******",
"supportedApis":["baseEntry","auditTrail"],
"fields":{
"_siemForward":false
},
"category":"sanbox/kaltura",
"polling_interval":24,
"baseEntryInitLookback":1
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}
FAQ
Click here for more information about Cloud-to-Cloud sources.