Getting Started

Everything you need to know to get started with Formant.

    Configure events

    An event is an occurrence of something at a specific time - an incident, an interesting observation, or something that crosses a specific threshold, or meets any specific criteria or pattern, as specified by you. Any event will generate a tick mark on the timeline. Events provide an easy way to navigate along the timeline and find interesting occurrences or states along the way. Along with adding a tick on the timeline, events can also be used to trigger notifications or actions, such as commands and bandwidth management. 

    Add event

    From the burger menu  select Settings  ⇒ Events Add Event

    From Add Event interface, users can define events that are attached to a specific stream. 

    Step 1: Describe the event

    This is a short description used to define an event. This will be the primary way to distinguish the event when it is displayed on the timeline and events page.

    Step 2: Choose devices

    Choose the set of devices on which this event should apply to. The device list can be filtered using tags. If a device does not have a tag, it can be created by adding tags to devices.

    Step 3: Configure trigger

    Stream

    Choose the telemetry stream to monitor. Events defined through this interface is always associated with a stream. Pick the stream that will be used to generate the event. Currently, the product only allows you to select one stream per Event definition.

    Interval

    The interval decides how often the event will be triggered if it matches the event definition. This is important because the event could be triggered several times and this will help limit the frequency of events.

    Trigger

    The type of trigger to be used depends on the stream data type used. 

    Condition Type


    Stream Type


    Event Description


    Always (presence)

    *

    Generate an event when any datapoint arrives on a specified telemetry stream.

    threshold

    numeric

    Generate an event when a numeric datapoint exceeds a specified threshold.

    regex

    text

    Generate an event when a text datapoint matches a specified regular expression.

    bit matching

    bitset

    Generate an event when a bitset key is either true or false or both

    Step 3: Choose actions

    Notification

    Enable notifications if you want to be alerted when this event is triggered. You can also choose the severity of the alert.

    Notification Type

    Icon

    Color

    Info

    Warning

    Critical

    Error

    Commands

    One or more commands can be triggered as part of an event. See Commands for more information on how to expose commands.

    Configuration

    A configuration template can be triggered when an event occurs. This can be used to trigger ingestion of streams, pause specific streams or change the rate of ingestion of any stream.

    Slack Forwarding

    You can forward an event to Slack. To do that, first set up the Slack integration by following the docs here. Then turn ON Slack forwarding.

    PagerDuty Forwarding

    You can forward an event to PagerDuty. To do that, first set up the PagerDuty integration by following the docs here. Then turn ON PagerDuty forwarding.

    Webhook Forwarding

    You can forward an event to Webhooks. To do that, first set up the Webhooks integration by following the docs here. Then turn ON Webhooks forwarding.

    SMS Forwarding

    You can forward an event as an SMS to one or more phone numbers listed under the users or service users of your organization within Formant. The SMS message will be sent to all followers of the specific device on which the event occurs. To send SMS, first setup followers of the device and then turn ON SMS forwarding from this page.

    Delete Event

    From burger menu  select Settings  ⇒ Events ⇒ Cick onnext to the View name

    Configure Event

    From burger menu  select Settings  ⇒ Events ⇒ Click on.
    From the edit menu, change streams or actions attached to the event.


    © 2020 Formant • 1999 Bryant St · San Francisco, CA 94110