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

idstring

Unique identifier for the event.
hoststring

The host of the event.
timestring

Timestamp of when the event happened.

format = "date-time"
typestring

Unique identifier for the event type.

default = "com.qlik.v1.quota.allocation-failed"
sourcestring

The source of the event.

default = "com.qlik/qix-sessions"
owneridstring

The owner ID of the event.
originipstring

The origin IP of the event.
specversionstring

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

Can be one of: "1.0"
datacontenttypestring

The content type of the event payload.

default = "application/json"
reasonstring

reason for why the event is triggered.
useridstring

Unique identifier for the user related to the event.
spaceidstring

Unique identifier for the space related to the event.
authtypestring

Representing the type of principal that triggered the occurrence.
clientidstring

Unique identifier for the client related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
sessionidstring

The session ID of the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
toplevelresourceidstring

Unique identifier for top level resource related to the event.
dataobject

data of a quota allocation failed event
Show data properties
- unitstring
  Required
  
  The unit of the usage
- appIdstring
  Required
  
  The ID of the app that consumes the quota.
- quotastring
  Required
  
  The name of a quota
- spaceIdstring
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroupstring
  Required
  
  The appSizeQuotaGroup name of request.
- limitinteger
  Required
  
  The limit of the quota
- consumedinteger
  
  The amount of quota consumed
- requestedinteger
  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": "string",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "string",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "string",
    "limit": 42,
    "consumed": 42,
    "requested": 42
  }
}

The quota consumption event contains information of a quota consumption.

Payload

object

idstring

Unique identifier for the event.
hoststring

The host of the event.
timestring

Timestamp of when the event happened.

format = "date-time"
typestring

Unique identifier for the event type.

default = "com.qlik.v1.quota.consumed"
sourcestring

The source of the event.

default = "com.qlik/qix-sessions"
owneridstring

The owner ID of the event.
originipstring

The origin IP of the event.
specversionstring

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

Can be one of: "1.0"
datacontenttypestring

The content type of the event payload.

default = "application/json"
reasonstring

reason for why the event is triggered.
useridstring

Unique identifier for the user related to the event.
spaceidstring

Unique identifier for the space related to the event.
authtypestring

Representing the type of principal that triggered the occurrence.
clientidstring

Unique identifier for the client related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
sessionidstring

The session ID of the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
toplevelresourceidstring

Unique identifier for top level resource related to the event.
dataobject

data of a quota consumption event
Show data properties
- unitstring
  Required
  
  The unit of the usage
- appIdstring
  Required
  
  The ID of the app that consumes the quota.
- quotastring
  Required
  
  The name of a quota
- spaceIdstring
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroupstring
  Required
  
  The appSizeQuotaGroup name of request.
- consumedinteger
  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": "string",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "string",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "string",
    "consumed": 42
  }
}

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

Payload

object

idstring

Unique identifier for the event.
hoststring

The host of the event.
timestring

Timestamp of when the event happened.

format = "date-time"
typestring

Unique identifier for the event type.

default = "com.qlik.v1.quota.released"
sourcestring

The source of the event.

default = "com.qlik/qix-sessions"
owneridstring

The owner ID of the event.
originipstring

The origin IP of the event.
specversionstring

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

Can be one of: "1.0"
datacontenttypestring

The content type of the event payload.

default = "application/json"
reasonstring

reason for why the event is triggered.
useridstring

Unique identifier for the user related to the event.
spaceidstring

Unique identifier for the space related to the event.
authtypestring

Representing the type of principal that triggered the occurrence.
clientidstring

Unique identifier for the client related to the event.
tenantidstring
Required

Unique identifier for the tenant related to the event.
sessionidstring

The session ID of the event.
authclaimsstring

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

A comma-delimited list of key-value pairs.
traceparentstring

Contains a version, trace ID, span ID, and trace options.
toplevelresourceidstring

Unique identifier for top level resource related to the event.
dataobject

data of a quota released event
Show data properties
- unitstring
  Required
  
  The unit of the usage
- appIdstring
  Required
  
  The ID of the app that consumes the quota.
- quotastring
  Required
  
  The name of a quota
- spaceIdstring
  Required
  
  The ID of the space in which app is.
- appSizeQuotaGroupstring
  Required
  
  The appSizeQuotaGroup name of request.
- releasedinteger
  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": "string",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "string",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "toplevelresourceid": "id123",
  "data": {
    "unit": "byte",
    "appId": "id123",
    "quota": "appSizeTotalDefault",
    "spaceId": "id123",
    "appSizeQuotaGroup": "string",
    "released": 42
  }
}