Key Concepts key-concepts

Understanding the core concepts of Concurrency Monitoring is essential for successful implementation. This guide explains the fundamental building blocks and how they work together.

Core Concepts core-concepts

Sessions

A session represents an active video streaming instance. Think of it as a “ticket” that allows a user to watch content.

Session Lifecycle

Session Properties

{
  "sessionId": "unique-session-identifier",
  "idp": "identity-provider",
  "subject": "user-identifier",
  "startTime": "2024-01-15T10:30:00Z",
  "expiresAt": "2024-01-15T10:40:00Z",
  "metadata": {
    "deviceId": "device-123",
    "channel": "Channel1",
    "contentType": "live"
  }
}

Policies

Policies are business rules that define limits and restrictions for concurrent streaming. They determine when users can start new streams.

Policy Components

Example Policy

{
  "name": "basic_stream_limit",
  "description": "Maximum 3 concurrent streams per user",
  "rules": [
    {
      "type": "maxstreams",
      "limit": 3,
      "message": "You have reached your maximum of 3 concurrent streams"
    }
  ]
}

Metadata

Metadata provides context about each session. It includes information about the device, content, user, and application.

Metadata Categories

Required vs Optional Metadata

Identity and Authentication identity-and-authentication

Identity Provider (IdP)

An Identity Provider is the service that authenticates users and provides their identity information. In Adobe Pass integration, this is typically an MVPD.

IdP Examples

Subject

A subject is the unique identifier for a user within an Identity Provider. This is typically the user’s account ID or subscriber ID.

Session Management session-management

Heartbeats

Heartbeats are periodic API calls that keep sessions active. They tell the system “this user is still watching.”

Heartbeat Requirements

Session Termination

Sessions can be terminated in several ways:

Policy Evaluation policy-evaluation

How Policies Work

Conflict Resolution conflict-resolution

What is a Conflict?

A conflict occurs when a user tries to start a new stream but would exceed their limits.

Conflict Response

When a conflict occurs, the system returns a 409 Conflict response with detailed information:

{
  "status": "error",
  "error": {
    "code": "POLICY_VIOLATION",
    "message": "Concurrent usage limit exceeded"
  },
  "evaluationResult": {
    "decision": "DENY",
    "associatedAdvice": [
      {
        "adviceType": "rule-violation",
        "attributes": {
          "rule": "max_streams",
          "threshold": 3,
          "current": 4,
          "conflicts": [
            {
              "sessionId": "session-123",
              "terminationCode": "term-456",
              "metadata": {...}
            }
          ]
        }
      }
    ]
  }
}

Resolution Strategies

LIFO (Last In, First Out)

FIFO (First In, First Out)

Applications and Tenants applications-and-tenants

Application

An application is a software program that integrates with Concurrency Monitoring. Each application has a unique ID and can have its own policies.

Application Examples

Tenant

A tenant is an organization that owns one or more applications. Tenants can share policies across applications.

Tenant Structure

Tenant: "Streaming Company"
├── Application: "Mobile App"
├── Application: "Web App"
└── Application: "TV App"

Environments environments

Staging Environment

Production Environment

Integration Flow integration-flow

Basic Flow

Error Handling

Common Terminology common-terminology