Knowledge
homeappabout
English
English
  • Home
  • About Ardexa
    • Our Security Principles
    • What makes us different?
    • Collecting Data
    • Device Remote Control
    • Tunnel (VPN) Access
    • File Transfers
    • Machine Plugins
  • Getting Started
    • What is Ardexa?
    • Connectivity in 60 Seconds
    • The Ardexa Data Store
  • Configure the Edge Device
    • Edge and Cloud Connect
    • Edge Device Configuration
      • ArdexaLinux Operating System
      • Approved Hardware
        • Dell Industrial Computers
          • Dell PowerEdge Installation
        • Advantech Industrial Computers
          • Configuring Advantech Devices
            • UNO-2271G, UNO-2272G
            • UNO-2362G
          • Advantech ArdexaLinux Installation
          • Advantech Serial Driver
        • Siemens Industrial Computers
          • Siemens IPC 127E Installation
          • Siemens IOT2050 ArdexaLinux Installation
        • Raspberry Pi
          • Install the Raspbian Image
          • USB On-The-Go (OTG) support
          • Raspberry Pi 4 EEPROM update
          • Display hardware version of Raspberry Pi
        • Virtual machines
      • Internet Connection
        • Connecting
        • Complex Network Management
      • Networking
        • Network Configuration Using Ardexa Cloud
        • Config Static IP - Manually
        • Add static route
        • Add secondary IP
        • Access via SSH
        • Update password
        • Test Network Access
        • Reconnecting Offline Device
        • Cisco VPN Access
        • USB Tethering
      • Using a local Network Time server (NTP)
      • Serial Communications
        • Testing the serial ports
      • Antivirus
      • Time Zone
    • Connecting to Plant Equipment
      • TCP (Ethernet)
        • Standard Industrial Protocols
        • OPC Protocols
        • Database Protocols
        • PLC Protocols
        • Miscellaneous
      • Serial (RS-485, RS-422, RS-232)
        • Standard Industrial Protocols
        • Proprietary Protocols
      • Others (Bluetooth, etc.)
    • Ardexa Agent
      • Installation (ARM64 or X86/AMD64)
      • Installation Raspberry Pi
      • Install (opkg)
      • Install on Docker
      • Check it's working
      • Increase system limits
      • Data types and formats
        • Decimal
        • CSV file format
      • Scenarios
        • Run
        • How does the UNIX_SOCKET scenario work?
      • Dynamic Configuration
      • Manual Configuration
      • Replacing a Device with a New One
      • Replacing a Device with an Existing One
      • Uninstall
    • Ardexa Machine Plugins
      • Safety & Risk Notice
      • Modbus
        • Modbus Server
        • Modbus Python Plugin
        • Modbus Plugin
      • Programmable Logic Controllers (PLCs)
        • Access to OPC DA Data
        • Installing the OpenOPC utility
        • Mitsubishi PLC Plugin
        • Siemens S7 PLC Plugin
        • Omron PLC Plugin
        • README
      • OPC Plugins
        • OPCUA Plugin
      • Solar Inverter Plugins
        • Satcon Inverters
        • Sungrow Inverters
          • Sungrow SG Grid Scale Inverters
          • Sungrow SG1000MX Inverters
          • Sungrow SG String Inverters
        • Delta Inverters
        • Connecting to Huawei
        • Huawei Logger
        • Huawei Logger
        • ABB Inverters
          • Configuring ABB Inverters
          • ABB Aurora Inverters
          • ABB PowerOne Modbus Inverters
          • ABB Pro 33 Inverters
          • ABB PVS 800 Inverters
          • ABB Trio Inverters
        • SolarEdge Inverters
        • Sunspec Inverters
        • SMA Inverters
          • Connecting SMA Inverters
          • SMA Central Inverters
          • SMA Cluster Controllers
          • SMA "YASDI" Inverters
          • SMA Sunny Tripower (non Sunspec)
          • SMA Power Plant Controllers
          • SMA Central 1850-2750 Inverters
          • SMA Sunny Webbox
        • Kostal Inverters
          • Connecting via Kostal Proprietary Protocol
          • Kostal Proprietary Plugin
          • Kostal Modbus (non Sunspec) Plugin
        • Kaco Inverters
          • Configuring Kaco Inverters
          • Kaco Inverter Plugin
        • SolarMax Inverters
          • Configuring SolarMax Inverters
          • SolarMax Inverter Plugin
        • Refusol Inverters
        • JEMA IFX Inverters
        • Ginglong Solis Inverters
        • Growatt TL3 Inverters
        • HEC Freesun Inverters
        • Next Tracker Plugin
        • Ingecon 100TL Inverters
        • Tristart MPPT Charger
        • Zenergy PID Boxes
        • Eaton Inverters
        • SolarCheck Strings
        • Soltec Trackers
        • GE Inverters
        • TMEIC Solar Ware Ninja Inverters
        • Power Electronics Inverters
        • Ingeteam Inverters
        • Delta Logger
        • FTC Trackers
        • Trina Trackers
        • Solivia Inverters
        • Dunext Inverters
      • Data Logger Plugins
        • Connecting SolarLog
        • SolarLog Logger
        • MaxWeb Logger
        • Gantner Logger
        • MeteoControl Logger
        • Bluelog Logger
        • Kaco proLOG
        • Sinapsi Logger
        • Skylog Logger
        • SMA Sunny Webbox Logger
      • Electricity Meter Plugins
        • Janitza Meters
        • Cube Meters
        • ECS Meters
        • Gavazzi Meters
          • Gavazzi EM24 Meters
          • Gavazzi WM Meters
        • KBR Meters
        • Plus ES Meters
        • RPI Current Transformers
        • Schweitzer Meters
        • Schweitzer Protection Relays
        • Schneider Electric Meters
          • Schneider ION Meters
          • Schneider Sepam Meters
        • Fanox Relay
        • Elspec Meters
        • Landis Gyr Meter
      • Wind Turbines
        • Wind Park Networks
        • Vestas Wind Turbines
          • Vestas ODBC
          • Vestas OPCUA
        • Clavis XML Server
        • Gamesa Wind Turbines
          • Gamesa ODBC Wind Turbines Plugin
          • Gamesa Windnet OPCUA
          • Gamesa Wind Turbines via Config Files
        • Nordex Wind Turbines
          • Nordex OPCXML Wind Turbines Plugin
          • Nordex Plugin ODBC with Config Files
          • Nordex Plugin OPCXML with Config Files
        • Enercon Wind Turbines
          • Enercon Wind Turbines Plugin
          • Enercon Wind Turbines Plugin with Config Files
        • GE ODBC Wind Turbines
        • Senvion Wind Turbines
          • Senvion Wind Turbines Plugin
          • Senvion Plugin with Config Files
        • Siemens Wind Turbines
          • Siemens Wind Turbines
          • Siemens Wind Turbines with Config Files
      • Weather Stations
        • Kipp and Zonen
        • IMT Si-RS485 Sensors
        • Webdom
        • Lufft Weather Stations
        • Campbell Weather Stations
        • DustIQ Soiling Sensors
        • Geonica Weather Stations
        • Groundwork Zenith Meteorological Stations
        • Hukseflux Pyranometers
      • Solar Powered Computers
      • Energy Storage
        • BYD ESS C648
        • BYD ESS
        • NetMan 204
        • Narada Batteries
      • IEC
        • IEC 61850
        • IEC 60870
      • Management Plugins
        • RESI Real Time Clock Plugin
        • Logrotate Plugin
        • Interface Manager Plugin
          • Automatic Modem Connection
          • Manual Modem Connection
          • Troubleshooting Modem Usage
        • Black Box Plugin
        • Log Rotation and Deleting Old Logs
        • Antivirus
        • Backfill
      • Computer Vision
        • Photo Capture Plugin
      • Testing Plugins
        • Dynamic Test
        • JSON Test
        • Ping Test
        • Schema Test
        • Serial Test
        • Solar Demo Plugin
        • Vestas Demo Plugin
        • Service Load Test
        • Resource Usage
        • Edge Statistics
      • Control
        • Ardexa Control Plugin
    • Variable Naming Guide
    • Communications Hardware
      • USB to WIFI Converter
      • Teltonika RUT950 router
      • Huawei E8372 (3G) Modems
      • Modems
  • Ardexa Cloud
    • Ardexa Account
      • Multi-factor Authentication
      • User profile
      • Browsers
      • Navigation
    • Ardexa Remote
      • Install Ardexa Remote
      • Using the Tunnel
      • Using the VPN
      • Troubleshooting
    • Data Access
      • KPIs
      • Users and Permissions
      • Device Groups
      • Limit user access to a subset of devices
      • Limit Access to Searches
      • API Tokens
      • Device access to the API
      • Images
      • Power BI
    • Analysis
      • View Types
      • Charts
      • Formulae
      • Device Logs
    • Searches
      • Creating Searches
      • Sharing Searches
      • CSV Downloads
      • Scheduled Search
      • Search Admin
      • Search Visualisations
      • Search Statistics
      • Search Analysis
      • Audit Logs
      • Other Resources
    • Devices
      • Edge and Cloud Devices
      • Device Summary
      • Device Bulk Actions
      • General Info
      • Remote Shell
      • File Transfer
      • Machine Plugins
      • Manual Configuration
      • Live Feed
      • Network (Edge Devices)
      • Network (Cloud Devices)
      • Discovery
        • Modbus
      • Commands
      • Tunnel (Ardexa Remote)
        • Install ArdexaRemote command line interface (CLI)
      • NAT Gateway
    • Entities
      • What is an entity
      • Create new entity
      • View entities
      • Managing entities
      • Recommendations
    • Standard UI components
    • Dashboards
      • Creating and Editing
      • Card types
        • 📈Chart Card
        • Button Stack
        • Active Incidents
        • Camera Control
        • Command Template
        • Cylinder
        • Energy Summary
        • Energy Tally
        • Gauge
        • Heat Map
        • Indicator light
        • Indicator light table
        • Inverter performance
        • KPI Chart
        • KPI Value
        • Latest Values
        • Link Stack
        • Live Calculation
        • Map
        • Metadata
        • Photo
        • Radial Histogram
        • Remote Web
        • Satellite Image
        • Scatter Plot
        • Single Value
        • Switch Toggle
        • Dynamic Text
        • Static Text
        • Value Table
        • Pie Chart
      • Lookup Table Integration
      • Timeframe and Timezone
    • Alerts
      • Incident Logs
    • Administration
      • Security Services
      • Metadata
      • Workgroup Settings
      • Labelling
      • Moving a Device Across Workgroups
      • External Sources
      • Lookup Table
      • Access Control
    • Energy Solutions
      • Energy Reports
        • Configuring the Daily Energy process
        • Configuring Meter Data
        • Configuring Performance Ratio
          • Irradiation Extract
    • Control
      • Schedules
    • Photos
  • FAQ
    • Difference between "Datetime", "event_time" and "store_time"
    • How can I manually upgrade the agent?
    • What ports does the agent require?
    • Can the agent subscribe to data streams from other agents?
  • Troubleshooting
    • ardpkg error: TypeError: 'NoneType' object is not subscriptable
    • Offline device (Ardexa agent is offline)
      • Remote checks
      • On-site checks
    • Agent continually restarts
    • Workgroup Invitations
    • Slack Invitation
    • Advantech Computer will not connect to the Internet
    • Edge Computer is not fully serviceable
    • The agent won't connect
    • My agent is online, but there is no data in the cloud
    • Agent upgrade failed: Unknown error
    • Device Config Update every log interval
    • Other Agent related issue
    • Running the agent in Debug Mode
    • Agent Maintenance on SysV
    • Connecting a device securely to a network segment that does not have Internet access
    • EXPECT_ERROR: Decimal conversion failed
    • Docker Interface Conflict
    • Failed to fetch...IP Not Found
  • Ardexa API
    • API
      • API Quick Start Guide
      • Python examples
      • Automated API Token Renewal
      • General
        • Issue API token
        • Examine API Token
        • WebSockets
      • Consumer
      • Security
      • Devices
        • Websocket
      • Search
        • API Search Functions
        • Search scrolling
        • Timeframe
        • Consuming data via the API
      • Energy
Powered by GitBook
On this page
  • About Alerts
  • About Incidents
  • Tab: All Incidents
  • Tab: Active Incidents
  • Tab: Incidents By Chart
  • Timeframe
  • Prerequisites
  • Creating an Alert
  • 1. Device Offline Alert
  • 2. Query Alert
  • 3. Data is Absent Alert
  • Editing Alerts
  • Deleting Alerts
  • Help in Alerts
  • Incident Concepts:
  • Active Incident
  • Acknowledged & Unacknowledged Incident
  • Incident Logs
  • Viewing & Acknowledge an Alert's Active Incidents
  • Select Alerts to View their Active Incidents
  • Acknowledge an Incident
  • Email Reminders
  • Source
  • Data is Absent

Was this helpful?

  1. Ardexa Cloud

Alerts

Near Real Time Alerting is available in the Ardexa cloud.

PreviousTimeframe and TimezoneNextIncident Logs

Last updated 7 months ago

Was this helpful?

Menu -> Alerts

Near Real Time Alerting is available in the Ardexa cloud. It allows email notifications when you need to be notified about significant events or conditions from your sources and machines:

  1. Device Offline: when an agent has continuously been offline for some time

  2. Query: when a set of conditions evaluates to true over a period of time

  3. Data is Absent: when a data stream has stopped reporting, even though the agent is online

About Alerts

Alert records allow you to create conditional tests that will raise an Incident record when the condition is met.

About Incidents

When a predefined condition is met from your parent Alert a trigger will create an Incident entry.

  • You can be notified when an incident is raised.

  • You can view all Incidents ever raised by a particular Alert

  • You can view Active incidents and acknowledge them.

  • You can chart your incidents to visualise your running environment.

Tab: All Incidents

The default landing tab of the Alerts view is the ALL INCIDENTS tab. This view allows you to select predefined alerts in your current workgroup and retrieve all historical incidents associated to the selected alert. This is similar to running a search from the SEARCHES view over the incidents_log table.

You can apply a predfined [Timeframe] or select your own custom timeframe from the timeframe picker.

Tab: Active Incidents

The ACTIVE INCIDENTS tab displays all the current active incidents for the corresponding Alerts selected on the LHS.

In this view you may acknowledge Incidents individually or all at once.

NB. The incidents displayed in this view are a different subset of records to the historical records in ACTIVE INCIDENTS or INCIDENTS BY CHART , hence some discrepancies may be observed.

Tab: Incidents By Chart

Timeframe

Choose an appropriate period via the timeframe picker to chart incidents.

You can chart the incidents of many alerts at the same time.

Incidents are charted by predefined aggregates based on the time period you choose.

If a predefined timeframe doesn't suit your needs then you can choose a custom value.

Hint: if your alert produces no incidents, then the chart will be empty

Hint: timeframes do not apply to the Active Incidents Tab

Prerequisites

Some Alerting features depend on other configuration items being present in the workgroup.

Device Groups

Source Labelling

Admin -> Workgroup

Where you can define:

  • Rules

  • Sources

  • Dashboard settings

Permissions

Alerts can be viewed by any user in the workgroup with the 'Read' permission. In practice, this is all users in the workgroup.

Alerts can be created, updated and deleted by users with the 'Coordinate' permission.

Users attached to a specific Device Group have some additional restrictions when interacting with Alerts:

  1. Device Group users can only see Alerts configured against their Device Group

  2. Device Group users with the 'Coordinate' permission can only create, update & delete Alerts configured against their own Device Group

  3. Device Group users are unable to edit Source labelling settings. They can, however, use pre-existing source labels to configure Alerts.

Settings

  1. Severity is a pre-defined metadata field which identifies the severity of the alerts from Low - Medium - High

  1. Categories are user-defined metadata fields, similar to tags / labels, which allows zero-to-many relationship. Properties includes name and colour which can be set by clicking the gear icon (settings) beside NEW ALERT button.

Creating an Alert

To create an Alert, click on the [NEW ALERT] button toward the top of the page on the LHS. Give the Alert a descriptive, unique title.

To add a notification email address, enter the address in the email list & click the Add button. Clicking the small cross on the right of an email address will remove the address from the notification list.

Once you are satisfied with the configuration of your Alert, click the [SAVE] button to create it. This will initiate monitoring of the Alert condition in the cloud immediately.

The three alert types you may choose from:

1. Device Offline Alert

2. Query Alert

3. Data is Absent Alert

are expanded in the following:

Creating a Device Offline Alert

Device Offline Alerts will trigger when an agent has been offline (ie. unable to connect to the Ardexa Cloud) continuously for a defined period of time.

To configure a Device Offline Alert, in addition to Title & Email addresses, you will need to specify:

  1. A [Device Group] which you would like to alert on, or All Devices in the workgroup

  2. The Device Offline [Duration], with options ranging from Immediately to Offline more than 1 day

Creating a Query Alert

To create a Query Alert, you will need to have created one or more labels, and have applied them to one or more sources.

For the example used in the images, a source named 'widget-01' has been configured to collect the following fields:

Table

Field

Type

telemetry

temperature

decimal

telemetry

production

integer

telemetry

alarm

boolean

telemetry

Datetime

ISO8601 Date string: YYYY-MM-DDThh:mm:ss+xx:xx

The 'widget' label has also been created and applied to the source.

Configured as shown, this Alert will trigger when any 'widget' source, on any Device in the Workgroup reports a temperature over 35 degrees Celsius.

Conditions

Duration

By default, Query Alerts will trigger an Incident as soon as their conditions are met. In practice, this can lead to Incidents being raised prematurely. Specifying a [Duration] on an Alert forces the condition to have been met consistently for the period of time before raising an Incident.

Time box

Time boxes can be used to restrict an Alert to apply only during a set period of time in a day. To do this, a time zone needs to be selected, along with a start & end time.

Creating a "Data is Absent" Alert

Data is Absent alerts will fire when a source has not reported data to a specified table for a defined period of time.

Editing Alerts

To edit an Alert, select the pencil icon on the right side of the alert list.

Make the required changes and click [SAVE]. Clicking [CANCEL] will discard your changes.

Note: Affect on Incidents when Editing Alerts

Editing an Alert will delete any related Incidents raised by the Alert.

However, historical logs of these incidents, stored in the incidents_logs table are not deleted and will still be available from the [SEARCHES] interface.

Editing an Alert may also immediately trigger/re-trigger conditions that raise incidents, resulting in possibly in multitudes of incidents being raised at once.

Deleting Alerts

Note: Affect on Incidents when Deleting Alerts

Deleting an Alert will delete any related Incidents raised by the Alert.

However, historical logs of these incidents, stored in the incidents_logs table are not deleted and will still be available from the [SEARCHES] interface.

Help in Alerts

Incident Concepts:

Active Incident

An active incident represents a condition that is not yet resolved. When it becomes resolved it will be closed. When closed it can always be viewed as a record entry in the incidents_logs table.

A notification is set on the parent Alert of the Incident, eg. an email, then you will be advised until the Incident is Acknowledged.

Acknowledged & Unacknowledged Incident

An active incident as an acknowledge/unacknowledge status. While an incident is unacknowledged you will be notified if a notification is set on the parent Alert.

Note: Acknowledging an Active incident does NOT close the incident. It will remain open until the condition is resolved.

Incident Logs

The history of all raised incidents, active/closed/acknowledged, are stored in the incident_logs table.

These can be viewed through the [SEARCHES] view or graphed via the [INCIDENTS BY CHART] tab in the [ALERTS] view.

Viewing & Acknowledge an Alert's Active Incidents

When an Alert's conditions have been met for a particular source, the Alerter process in the Ardexa Cloud will raise an Incident for the Alert. Any single Alert may have many Incidents.

To view your active incidents navigate to the [ACTIVE INCIDENTS] tab from the [ALERTS] view.

Select Alerts to View their Active Incidents

  • Select the Alerts whose Active Incidents you wish to View

This view displays all the active incidents for every selected alert on the LHS.

Note: if your selected alert has no active incidents then the table will be empty.

Acknowledge an Incident

Email Reminders

When a near real time alert is triggered, that is to say the conditions are met for an alert, it will send an email alert to the identified recipients. A resolved email will be sent when the conditions no longer meet the alert criteria. If condition is still active, a reminder email will be sent every 2 hours, 1 day or 1 week. The default is 2 hours, but it can be changed by navigating to: Admin -> Workgroup -> Settings Tab

and changing the Alert reminder setting.

Source

For Query or Data is Absent alerts, you will need to specify a data source. Sources are 1 or many streams of information coming from 1 or more device. Labeling data sources make it much easier for someone to understand the data coming in, without having to understand the underlying data structures coming from the device. Label the source(s) of data, from the device(s), by using the settings in:

Admin -> Workgroup -> Labelling Tab

Data is Absent

This alert type reports when data is not being received by the cloud, from the device. If the device is offline, this alert will not be triggered. If an agent is offline, it is assumed that it is functioning, in which case the Ardexa agent will cache all events. When the agent comes back online, all events will be sent to the cloud. If however, when the agent comes back online, the data is not there, then an alert will be raised.

Incident concepts are further expanded in the section below, .

Create and select an Alert on the LHS selection pane to begin charting your stored in the incident_logs table.

Alerts can be applied to all devices in a workgroup, or to a specific subset of devices defined by a Device Group. See for more information, or navigate to: Admin -> Workgroup -> Device Groups Tab

Query & Absent Data alerts are applied to device sources with a specified .

Hint: is accessed from the menu:

Conditions are constructed using a similar structure to . Unlike searches, only a single filter group can be specified in a Query Alert:

See for more detail on Duration & Time boxes.

This will open the same pop-up dialogue box as used for creating a .

To delete an Alert, select the options button against the alert > Remove.

Want to know more about alerts or a particular action in general? Launch contextual help for your current action by selecting the Help menu item, or where-ever you see the button.

Click on the Acknowledge All button.

Acknowledging Incident concepts are provided .

Device Groups
[SOURCE MANAGEMENT]
Searches
here
historical Incidents
Creating a Query Alert
new alert
here
All incidents
Incident Chart
Active incidents
Alerts Timeframe
Set severity when creating / editing alerts
Defining Categories
Set categories when creating / editing alerts
A Device Offline alert, configured to trigger when any device in the workgroup is offline for more than 10 minutes.
A simple Query Alert
An alert condition that will trigger when temperature is > 35C AND an alarm has been detected
An alert condition that will trigger when temperature is > 35C, OR an alarm has been reported, OR the widget has produced zero units
Enabling a Duration on a Query Alert
A time box for an Alert that will only fire between 9AM and 4PM in Australian Eastern Standard Time
A simple absent data alert that will trigger when an inverter fails to report solar data for 30 minutes or more.
Edit / Delete Alerts
source label
Labels