Event Data

This topic describes the application instance data fields that the Replicated vendor portal uses to generate events for the instance.

About Events

When the vendor portal receives instance data from the app manager, it evaluates each data field to determine if there was a change in its value. For each field that changes in value, the vendor portal creates an event to record the change. For example, a change from ready to degraded in the appStatus data field generates an event in the vendor portal.

In addition to creating events for changes in data fields sent by the app manager, the vendor portal also generates events for changes in the value of a computed metric. For example, the vendor portal computes a numberVersionsBehind metric that tracks the number of versions behind the latest available version for the instance. When the instance checks for updates and the vendor portal identifies a new version that is available to the instance, then the vendor portal generates an event to indicate the change in the value of the numberVersionsBehind metric. The vendor portal updates the values of computed metrics each time the app manager sends instance data.

Each event that the vendor portal generates for application instances has the following fields:

• fieldName: The instance data field that generated the event. For example, appStatus.
• previousValue: The value of the data field before the vendor portal generated the event.
• newValue: The value of the data field after the vendor portal generated the event.

The vendor portal uses events to display insights for each active application instance in a Instance details dashboard. For more information about using the vendor portal Instance details page to monitor active instances of your application, see Viewing Instance Details.

Instance Events

This section describes each type of event that the vendor portal generates for active application instances. Events in the vendor portal are grouped into the following categories:

• Application Installation and Upgrade Events
• Cluster Status Events
• Infrastructure Status Events
• KOTS Status Events
• Upstream Update Events

The tables in this section include the following details about each event type:

• Field Name: The fieldName associated with the event.
• Description: A description of the data field.
• Type: The data type of the field. Possible values are string, number, and boolean.
• Label: The label for the event that displays in the Instance Activity stream in the vendor portal Instance Details page. For more information, see Instance Activity in Viewing Instance Details.

Application Installation and Upgrade Events

Field Name	Description	Type	Label
appStatus	A string that represents the status of the application. Possible values: Ready, Updating, Degraded, Unavailable, Missing. For more information about how the app manager determines appStatus, see Resource Statuses in Viewing Status Details.	string	App Status
channelId	The ID of the channel the application instance is assigned.	string	App Channel
versionLabel	The version label of the release that the instance is currently running. The versionLabel is the version that you assigned to the release when promoting it to a channel.	string	App Version

Cluster Status Events

Field Name	Description	Type	Label
isKurl	Indicates if the cluster was provisioned by the Replicated Kubernetes installer. Possible values: kURL: The cluster is provisioned by the Kubernetes installer. Existing: The cluster is not provisioned by the Kubernetes installer. See Creating a Kubernetes Installer.	boolean	Cluster Type
k8sVersion	The version of Kubernetes running in the cluster.
k8sDistribution	The Kubernetes distribution of the cluster. Possible values: EKS GKE K3S RKE2	string	Kubernetes Distribution
kurlNodeCountTotal	Total number of nodes in the cluster. Note: Applies only to clusters provisioned by the Kubernetes installer.	number	kURL Nodes Total
kurlNodeCountReady	Number of nodes in the cluster that are in a healthy state and ready to run Pods. Note: Applies only to clusters provisioned by the Kubernetes installer.	number	kURL Nodes Ready
kurlInstallerSpecID	The ID of the Kubernetes installer specification that provisioned the cluster. An installer specification is a manifest file that has apiVersion: cluster.kurl.sh/v1beta1 and kind: Installer. A kurlInstallerSpecID event indicates that a new Installer specification was added. See Creating a Kubernetes Installer. Note: Applies only to clusters provisioned by the Kubernetes installer.	string	New kURL Installer

Infrastructure Status Events

Field Name	Description	Type	Label
cloudProvider	The cloud provider where the instance is running. cloudProvider is determined by the IP address that makes the request. Possible values: AWS GCP DigitalOcean	string	Cloud Provider
cloudProviderRegion	The cloud provider region where the instance is running. For example, us-central1-b
kurlOSFlavor*	One or more operating systems detected across cluster nodes. Note: Applies only to clusters provisioned by the Kubernetes installer.	string	Cloud Region
kurlOSVersion*	One or more operating systems detected across cluster nodes. Note: Applies only to clusters provisioned by the Kubernetes installer.	string	Operating System Version

KOTS Status Events

Field Name	Description	Type	Label
kotsVersion	The version of the Replicated app manager that the instance is running. The app manager version is displayed as a Semantic Versioning compliant string.	string	KOTS Version

Upstream Update Events

Field Name	Description	Type	Label
numberVersionsBehind	The number of versions between the version that the instance is currently running and the latest version available on the channel. The numberVersionsBehind metric is computed by the vendor portal each time the app manager sends instance data.	number	Versions Behind