Skip to main content

Introduction

1. What is event autotagging?​

Event Autotagging is a feature of the Model-Prime platform that identifies events of interest within new and existing robologs. Each event occurrence results in the creation of one or more metadata values for the robolog being tagged. The metadata values created as a result each have a time interval corresponding to that of the event.

2. Terminology​

Event​

A time interval spanning a contiguous sequence of channel messages. The message data is used to identify the event based on a set of rules you define.

Event identification​

An event is identified when all the tagger's rules (also known as predicates) are true for a contiguous sequence of message time intervals. Message timestamps are processed and aligned by the autotagging system.

Tagger​

A resource that must have a unique name and an optional description to help you and your team understand the type of event the tagger is designed to identify. Each tagger has its own set of associated tagger versions.

Tagger definition​

A YAML file that specifies the input variables, predicate rules, and metadata outputs of a tagger.

Tagger version​

An iteration of a tagger definition used to keep track of how a tagger changes over time.

Each version begins as a draft that may be saved and worked on by you and your team before publishing it. A validation mechanism is provided while drafting a version and is intended to help catch common errors while putting together a tagger definition.

A tagger version is made usable - and its definition made immutable - by publishing it. A tagger's functionality may be changed by drafting and then publishing a new version of the tagger.

Variables​

Inputs that must each specify a data source channel and access path within that channel. Variables are used to construct predicates.

Predicates​

The rules used to identify events in the robolog based on the input variables. Multiple predicates may be defined and they must all be true for an event to be matched.

Outputs​

The metadata value(s) created for each event. Each output defined will result in the creation of a new metadata for each event identified by the tagger.

Tagger invocation​

The process of applying a tagger to one or more robologs using the definition provided by a specific tagger version. There are three types of invocations: test, normfill, and backfill.

Normfill invocations are automatically invoked for each enabled tagger whenever a new robolog is ingested, while test and backfill invocations may be manually invoked by you or your team.

Test​

Test invocations verify that a tagger version's definition is working as expected by tagging a small number of robologs. While our platform considers it a successful test if the invocation did not fail at runtime, you need to verify whether or not the test invocation produced the expected metadata values.

Tip: Run a test invocation on two robologs: one that you expect the tagger to find matching events, and one that you expect the tagger to not find matching events.

A tagger version must be successfully tested before it may be used for normfill or backfill invocations.

Normfill​

Normfill invocations are automatically kicked off for each newly ingested robolog using each enabled tagger's latest, tested version.

Backfill​

Backfill invocations may be used to retroactively tag robologs that had already been ingested before the tagger was created and enabled, or if a normfill invocation failed to tag a robolog.

Tagger definition service​

The REST service that supports the creation, management, validation, and invocation of taggers, tagger versions, and invocations.