Large app quotas

Qlik Analytics Applications that require Large App support consume license quotas, which are reported by quota events.

When an app in a space enabled with Large Apps support is either opened for interactive use, reloaded, or evaluated, quota events will be emitted to help you track quota consumption and usage:

When an app is opened, a consumed event will be emitted to indicate the quota consumed for this action.
When the app is unloaded, a released event will be emitted to indicate the quota released for this action.
If the app cannot be opened due to insufficient quota, an allocation-failed event will be emitted, detailing the quota that was attempted to be consumed, the current quota consumption at the time of the failure, and the quota boundary.

Each event indicates which license quota is being consumed in the quota field; either appSizeTotalDefault for interactive consumption, or appSizeTotalReloads for reload consumption and app evaluations.

These events are available for consumption via:

Audits (Events)

The quota allocation-failed event contains information of a quota allocation-failed record.

Payload

object

id string

Unique identifier for the event.
host string

The host of the event.
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

format = "date-time"
type string

Unique identifier for the event type.

default = "com.qlik.v1.quota.allocation-failed"
source string

The source of the event.

default = "com.qlik/qix-sessions"
ownerid string

The owner ID of the event.
originip string

The origin IP of the event.
specversion string

The event is compatible with the CloudEvents specification v1.0.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
reason string

The reason why the event is triggered.
userid string

Unique identifier for the user related to the event.
spaceid string

Unique identifier for the space related to the event.
authtype string

Representing the type of principal that triggered the occurrence.
clientid string

Unique identifier for the client related to the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

The session ID of the event.
authclaims string

A JSON string representing claims of the principal that triggered the event
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
toplevelresourceid string

Unique identifier for top level resource related to the event.
data object

data of a quota allocation failed event
Show data properties
- unit string
  
  Required
  
  The unit of the usage
- appId string
  
  Required
  
  The ID of the app that consumes the quota.
- quota string
  
  Required
  
  The name of a quota
- spaceId string
  
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroup string
  
  Required
  
  The appSizeQuotaGroup name of request.
- limit integer
  
  Required
  
  The limit of the quota
- consumed integer
  
  The amount of quota consumed
- requested integer
  
  Required
  
  The amount of quota requested

com.qlik.v1.quota.allocation-failed

Example payload of the "Quota Allocation Failed Event" event

{
  "id": "id123",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.quota.allocation-failed",
  "source": "com.qlik/qix-sessions",
  "ownerid": "id123",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "some reason",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "service_account",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "{ \"iss\": \"qlik.api.internal/qix-sessions\", \"sub\": \"qix-sessions\", \"subType\": \"service\" }",
  "tracestate": "b3=f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-1",
  "traceparent": "00-f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-01",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "reloads",
    "limit": 30,
    "consumed": 30,
    "requested": 30
  }
}

The quota consumption event contains information of a quota consumption.

Payload

object

id string

Unique identifier for the event.
host string

The host of the event.
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

format = "date-time"
type string

Unique identifier for the event type.

default = "com.qlik.v1.quota.consumed"
source string

The source of the event.

default = "com.qlik/qix-sessions"
ownerid string

The owner ID of the event.
originip string

The origin IP of the event.
specversion string

The event is compatible with the CloudEvents specification v1.0.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
reason string

The reason why the event is triggered.
userid string

Unique identifier for the user related to the event.
spaceid string

Unique identifier for the space related to the event.
authtype string

Representing the type of principal that triggered the occurrence.
clientid string

Unique identifier for the client related to the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

The session ID of the event.
authclaims string

A JSON string representing claims of the principal that triggered the event
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
toplevelresourceid string

Unique identifier for top level resource related to the event.
data object

data of a quota consumption event
Show data properties
- unit string
  
  Required
  
  The unit of the usage
- appId string
  
  Required
  
  The ID of the app that consumes the quota.
- quota string
  
  Required
  
  The name of a quota
- spaceId string
  
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroup string
  
  Required
  
  The appSizeQuotaGroup name of request.
- consumed integer
  
  Required
  
  The amount of quota consumed

com.qlik.v1.quota.consumed

Example payload of the "Quota Consumption Event" event

{
  "id": "id123",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.quota.consumed",
  "source": "com.qlik/qix-sessions",
  "ownerid": "id123",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "some reason",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "service_account",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "{ \"iss\": \"qlik.api.internal/qix-sessions\", \"sub\": \"qix-sessions\", \"subType\": \"service\" }",
  "tracestate": "b3=f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-1",
  "traceparent": "00-f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-01",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "reloads",
    "consumed": 42
  }
}

The quota released event contains information of a quota released record.

Payload

object

id string

Unique identifier for the event.
host string

The host of the event.
time string

Timestamp of when the occurrence happened. Must adhere to RFC 3339.

format = "date-time"
type string

Unique identifier for the event type.

default = "com.qlik.v1.quota.released"
source string

The source of the event.

default = "com.qlik/qix-sessions"
ownerid string

The owner ID of the event.
originip string

The origin IP of the event.
specversion string

The event is compatible with the CloudEvents specification v1.0.

Can be one of: "1.0"
datacontenttype string

The content type of the event payload.

default = "application/json"
reason string

The reason why the event is triggered.
userid string

Unique identifier for the user related to the event.
spaceid string

Unique identifier for the space related to the event.
authtype string

Representing the type of principal that triggered the occurrence.
clientid string

Unique identifier for the client related to the event.
tenantid string

Required

Unique identifier for the tenant related to the event.
sessionid string

The session ID of the event.
authclaims string

A JSON string representing claims of the principal that triggered the event
tracestate string

A comma-delimited list of key-value pairs.
traceparent string

Contains a version, trace ID, span ID, and trace options.
toplevelresourceid string

Unique identifier for top level resource related to the event.
data object

data of a quota released event
Show data properties
- unit string
  
  Required
  
  The unit of the usage
- appId string
  
  Required
  
  The ID of the app that consumes the quota.
- quota string
  
  Required
  
  The name of a quota
- spaceId string
  
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroup string
  
  Required
  
  The appSizeQuotaGroup name of request.
- released integer
  
  Required
  
  The amount of quota released

com.qlik.v1.quota.released

Example payload of the "Quota Released Event" event

{
  "id": "id123",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.quota.released",
  "source": "com.qlik/qix-sessions",
  "ownerid": "id123",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "some reason",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "service_account",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "{ \"iss\": \"qlik.api.internal/qix-sessions\", \"sub\": \"qix-sessions\", \"subType\": \"service\" }",
  "tracestate": "b3=f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-1",
  "traceparent": "00-f0cc846cd24db3f68e384e9ccdfbf225-226ac0c507065555-01",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "reloads",
    "released": 30
  }
}