Loggers - Alarming

This article covers loggers related to Alarming that were introduced in Ignition version 7.8.X.

Loggers in this article:

• Alarming.Execution

• Alarming.Manager.StateManager

• Alarming.JournalManager

  • Alarming.JournalManager[Journal[{AlarmJournalProfileName}]]

• Alarming.Notification.PipelineManager

• Alarming.Notification.EmailNotificationProfile[{AlarmNotificationProfile}]

• Alarming.Notification.Sip

• Alarming.Notification.Voice.CallManager

  • Alarming.Notification.Voice.CallManager.Agent

  • Alarming.Notification.Voice.CallManager.PhoneCall

• Alarming.Notification.Voice.ScriptDirector

Alarming.Execution

• Monitors alarm event transitions due to setpoint triggers.
  • DEBUG log capturing the event of an alarm triggered to an active state: 

    (prov:default:/tag:Testing/Alarming/Boolean Alarm Tag:/alm:Test Boolean Alarm High : 1395024449) Registered live event 'b5c2c7f8-e508-46ba-8bca-87c53bdf8609', state: Active, Unacknowledged. Outstanding events: 2

    
    
    
  • TRACE log capturing two events for a single tag alarm. Tag alarm was first set to cleared, unacknowledged due to a value change outside the alarm setpoint. Then, the same tag alarm's value was changed back to within the alarm setpoint:

    (prov:default:/tag:Testing/Alarming/Boolean Alarm Tag:/alm:Test Boolean Alarm High : 1395024449) Begin transition event to 'Clear'   (prov:default:/tag:Testing/Alarming/Boolean Alarm Tag:/alm:Test Boolean Alarm High) Continuing transition to state 'Clear', generating event data.   ...   (prov:default:/tag:Testing/Alarming/Boolean Alarm Tag:/alm:Test Boolean Alarm High : 1395024449) Begin transition event to 'Active'   (prov:default:/tag:Testing/Alarming/Boolean Alarm Tag:/alm:Test Boolean Alarm High) Continuing transition to state 'Active', generating event data.

Back to top

Alarming.Manager.StateManager

• Provides full detail of all Tag alarms and their events when they have been created, triggered, acknowledged, changed, or removed.
  • DEBUG log for created/edited alarm configuration on a Tag:
    

    Registering alarm: prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm High Updating alarm 'prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm High' with initial state from 'existing tag'. Initial events: [f296329a-4eda-4d3a-8d5a-97006310c868/Active, Unacknowledged]

• • DEBUG log for state changes in the alarm event. In this case, the state change came from triggering the alarm’s setpoint:
    

    Updating alarm event. From update: true, event: {Source: 'prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm High', Display Path: '', UUID: 'f296329a-4eda-4d3a-8d5a-97006310c868', Current State: 'Active, Unacknowledged', Priority: 'Low', Active Data: {setpointA=1.0, eventValue=true, name=Test Boolean Alarm High, eventTime=Tue Sep 07 07:27:17 PDT 2021}, Clear Data: null, Ack Data: null, Runtime Data: {isInitialEvent=true}}

• • TRACE log for alarm events that are removed from the system. Typically seen when the Live Event Limit has been exceeded:
    

    Remove event '69e8ef2d-7a2d-4e41-87ff-a3c94d5975b6'

Back to top

Alarming.JournalManager

• A series of loggers that monitor the process of inserting alarm events into an existing Alarm Journal Profile.
• JournalManager will notify the gateway when an alarm event is being stored in an existing journal.
  • TRACE log showing a notification from the gateway when an alarm event is being stored to an existing journal:
    

    Will store event '3f6bef64-7e70-4e39-889e-db32ae3703de/Active' to the configured alarm journals.

Back to top

Alarming.JournalManager[Journal[{AlarmJournalProfileName}]]

• Monitors the process of inserting alarm events into an existing Alarm Journal Profile’s database. {AlarmJournalProfileName} is denoted as the name of an existing Alarm Journal Profile.
  • TRACE log showing a successful, default insert into the alarm journal. Parameters unspecified on a Tag’s alarm properties will be mentioned:
    

    Will store event '3f6bef64-7e70-4e39-889e-db32ae3703de/Active' to the configured alarm journals. Sending log event for UUID '3f6bef64-7e70-4e39-889e-db32ae3703de' to store and forward system. Will not store event data for property 'setpointA': either the property is not the correct type, or the event type is not configured for storage. [setpointA] Will not store event data for property 'eventValue': either the property is not the correct type, or the event type is not configured for storage. [eventValue] Will not store event data for property 'activePipeline': either the property is not the correct type, or the event type is not configured for storage. [activePipeline] Will not store event data for property 'name': either the property is not the correct type, or the event type is not configured for storage. [name] Will not store event data for property 'eventTime': either the property is not the correct type, or the event type is not configured for storage. [eventTime] Stored event to alarm journal (prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm Low, , 3f6bef64-7e70-4e39-889e-db32ae3703de, 0, 0, [{eventValue=false, name=Test Boolean Alarm Low, eventTime=Tue Sep 07 07:55:05 PDT 2021}])

Back to top

Alarming.Notification.PipelineManager

• Monitors alarm pipelines that have been activated from either existing alarm Tags or pipeline tests
  • DEBUG log showing the an alarm event calling an existing alarm pipeline 'Email Pipeline':
    

    Sending alarm event '65c938f1-e15f-457d-aa51-df1f1a7a3e33' to pipeline 'Email Pipeline' (Source: prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm High) Processing alarm event 'prov:default:/tag:Boolean Alarm Tag:/alm:Test Boolean Alarm High:/almevt:65c938f1-e15f-457d-aa51-df1f1a7a3e33' against pipeline 'Email Pipeline'

• • DEBUG log showing a response to a pipeline test from the Ignition config page:
    

    Processing alarm event 'sys:configpage:/alm:**TEST:/almevt:4dae953c-142a-4f74-bd49-137a99ebc032' against pipeline 'Email Pipeline'

Back to top

Alarming.Notification.EmailNotificationProfile[{AlarmNotificationProfile}]

• Monitors the status of sending an alarm event to the defined SMTP profile or credentials under the Ignition config. Provides information of the email being sent and the smtp server being used. {AlarmNotificationProfile} is denoted at the name of your existing alarm notification profile for email notifications.
  • TRACE log of pipeline monitoring the email being sent to a defined SMTP profile. The defined Subject and Message of the email from the alarm pipeline is also being shown:
    

    Using SMTP profile, rechecking profile info. [hostname=<null>,port=25] Creating email session with SMTP profile. [hostname=<null>,port=25] Sending email to user '{schedule=Always, firstname=Aaron, notes=null, language=null, internal-db-id=3, username=apalas, lastname=Palas}'. Subject: Ignition Alarm Notification Message: At 08:47:25, alarm "Test Boolean Alarm High" at "" transitioned to Active.

• • DEBUG log that also appears during an attempt to activate the email notification pipeline. Provides details of the SMTP server defined in the Ignition config:
    

    Email settings: hostname = smtp.gmail.com, port = 465, timeout = 10000, useSSL = true, useSTARTTLS = false, userName = {gmailAddress}, password exists = true, authRequired = true

Back to top

Alarming.Notification.Sip

• Simply sends a notification to the gateway logs when a VOIP notification profile has been successfully enabled or disabled.
  • INFO log showing the enabling and disabling of a VOIP notification profile successfully:
    

    VOIP Sip notification profile started successfully. … VOIP Sip notification profile stopped successfully.

Back to top

Alarming.Notification.Voice.CallManager

• A series of loggers monitoring both registration of the VOIP notification and deployed voice notifications to a SIP server.
• Alarming.Notification.Voice.CallManager provides the most basic information of both sip registration and deployed voice notifications.
  • INFO log showing the default message for a successful registration with an available SIP server:
    

    Registration completed successfully.

• • DEBUG log showing more details regarding the SIP registration. In this example, no credentials are required:
    

    Scheduling register attempt to run in 100 ms … Password not set, will not attempt to register. Call manager event: register successful

• • DEBUG log showing details of a successful voice notification being executed from a simple alarm test, call being received, acknowledged (dtmf [1]), and ended. Call id will provide the unique voice notification event:
    

    Job 'NJob_0' has been queued. Queue length: 1 … Call manager event: ringing … Call manager event: callee pickup … Call manager event: dtmf [1] … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call thread has terminated. Call id 'oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local' finished.

• • TRACE log showing more details about the same call above. The same Call id is provided:
    

    (NJob_0) About to run job... (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call still active, will wait... … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call still active, will wait... (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call still active, will wait... (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call still active, will wait... … (NJob_0) Single job execution finished… (NJob_0) Job has finished completely.

Back to top

Alarming.Notification.Voice.CallManager.Agent

• Provides more in-depth detail on the process for both registering to the SIP server and deploying voice notifications.
  • INFO log showing details for a successful registration with an available SIP server and then later disabled:
    

    starting user agent [myAddress: 10.10.60.75, sipPort: 5060, userpart: null, domain: 10.20.4.6] added datagram socket 10.10.60.75:5060/UDP added 10.10.60.75:5060/UDP: net.sourceforge.peers.sip.transport.UdpMessageReceiver@5c4096fc to message receivers … starting user agent [myAddress: 10.10.60.75, sipPort: 5060, userpart: null, domain: 10.20.4.6] … added datagram socket 10.10.60.75:5060/UDP added 10.10.60.75:5060/UDP: net.sourceforge.peers.sip.transport.UdpMessageReceiver@36abe206 to message receivers … Message receiver closed. IsListening: false

• • DEBUG log providing detail about a deployed voice notification. Here you can see the beginning of the deployment providing all the necessary information for communicating between Ignition, SIP, and the phone number that needs to be called. We are then notified by the SIP server on it’s acknowledgment of a call request, it’s attempt to reach out to the phone number provided, and the result of call being sent to that phone number:
    

    SM z9hG4bKA5yhSj1Rh|INVITE [InviteClientTransactionStateInit -> InviteClientTransactionStateCalling] setState [network, SENT to 10.20.4.6/5060] INVITE sip:17075928027@10.20.4.6 SIP/2.0 … Via: SIP/2.0/UDP 10.10.60.75:5060;rport;branch=z9hG4bKA5yhSj1Rh Max-Forwards: 70 To: <sip:17075928027@10.20.4.6> From: <sip:null@10.20.4.6>;tag=MwB0pxMm Call-ID: oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local CSeq: 1 INVITE User-Agent: Ignition Sip 1.0.1 Content-Length: 210 Content-Type: application/sdp Contact: <sip:null@10.10.60.75:5060;transport=UDP> v=0 o=user1 1865145252 1142551944 IN IP4 10.10.60.75 s=- c=IN IP4 10.10.60.75 t=0 0 m=audio 8000 RTP/AVP 0 8 101 a=rtpmap:0 PCMU/8000 a=rtpmap:8 PCMA/8000 a=rtpmap:101 telephone-event/8000 a=sendrecv [network, RECEIVED from 10.20.4.6/5060] SIP/2.0 100 Trying Via: SIP/2.0/UDP 10.10.60.75:5060;rport=5060;branch=z9hG4bKA5yhSj1Rh From: <sip:null@10.20.4.6>;tag=MwB0pxMm To: <sip:17075928027@10.20.4.6> Call-ID: oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local CSeq: 1 INVITE Supported: replaces, path, timer, eventlist User-Agent: Grandstream HT813 1.0.13.3 Allow: INVITE, ACK, OPTIONS, CANCEL, BYE, SUBSCRIBE, NOTIFY, INFO, REFER, UPDATE Content-Length: 0 ClientTransaction = net.sourceforge.peers.sip.transaction.InviteClientTransaction@26e68a12 SM z9hG4bKA5yhSj1Rh|INVITE [InviteClientTransactionStateCalling -> InviteClientTransactionStateProceeding] setState … [network, RECEIVED from 10.20.4.6/5060] SIP/2.0 180 Ringing … ClientTransaction = net.sourceforge.peers.sip.transaction.InviteClientTransaction@26e68a12 SM z9hG4bKA5yhSj1Rh|INVITE [InviteClientTransactionStateProceeding -> InviteClientTransactionStateProceeding] setState Contact: <sip:10.20.4.6:5060> … SM oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local|MwB0pxMm|1864638822 [DialogStateInit -> DialogStateEarly] setState [network, RECEIVED from 10.20.4.6/5060] SIP/2.0 200 OK … ClientTransaction = net.sourceforge.peers.sip.transaction.InviteClientTransaction@26e68a12 SM z9hG4bKA5yhSj1Rh|INVITE [InviteClientTransactionStateProceeding -> InviteClientTransactionStateTerminated] setState Contact: <sip:10.20.4.6:5060> … Using codec: a=rtpmap:0 PCMU/8000 playback codec:a=rtpmap:0 PCMU/8000 SM oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local|MwB0pxMm|1864638822 [DialogStateEarly -> DialogStateConfirmed] setState [network, SENT to 10.20.4.6/5060] ACK sip:10.20.4.6:5060 SIP/2.0 … SM z9hG4bKyESS5m3fU|BYE [NonInviteClientTransactionStateInit -> NonInviteClientTransactionStateTrying] setState [network, SENT to 10.20.4.6/5060] BYE sip:10.20.4.6:5060 SIP/2.0 … ClientTransaction = net.sourceforge.peers.sip.transaction.NonInviteClientTransaction@d029db4 SM z9hG4bKyESS5m3fU|BYE [NonInviteClientTransactionStateTrying -> NonInviteClientTransactionStateCompleted] setState SM oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local|MwB0pxMm|1864638822 [DialogStateConfirmed -> DialogStateTerminated] setState removed dialog oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local|MwB0pxMm|1864638822 … SM z9hG4bKyESS5m3fU|BYE [NonInviteClientTransactionStateCompleted -> NonInviteClientTransactionStateTerminated] setState

• • TRACE log showing data being sent from Ignition to an answered call. This events will consistently appear during the duration of an answered phone call:
    

    Read 960 bytes from sound manager, putting it in rawData buffer 960 bytes at a time. ... Read 818 bytes from sound manager, putting it in rawData buffer 960 bytes at a time.

Back to top

Alarming.Notification.Voice.CallManager.PhoneCall

• Monitors sent phone calls and all of it's different states that occur during a deployed voice notification.
  • DEBUG log showing information about a deployed voice notification to a specific phone number. The final state of the completed call will be provided:
    

    (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Initializing call to sip:17075928027@10.20.4.6. … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Starting call to sip:17075928027@10.20.4.6. … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Answer confirmed… … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Sending termination request … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Call finished. … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) Finished with a result of 'Answered'

• • TRACE log showing more details about the sent phone call:
    

    (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) State -> Ringing … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) State -> Answered (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) State -> Talking … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) State -> Done … (oKy7ADFw-1632408749712@SU-2C8RZ12-WS.ia.local) State -> Done

Back to top

Alarming.Notification.Voice.ScriptDirector

• Monitors the scripted voice messages being sent to an answered call for a deployed voice notification.
  • DEBUG log showing the activation of scripted voice messages through an answered call. Each event is repeated either due to lack of/incorrect response or a new scripting message after the user responds:
    

    Playing phrase: PhraseGroup_283390666 … Transitioning to phrase: _repeat_ Playing phrase: PhraseGroup_283390666 … Transitioning to phrase: challengepassed Playing phrase: challengepassed Transitioning to phrase: _next_ Playing phrase: PhraseGroup_-896262343 … Transitioning to phrase: _repeat_ Playing phrase: PhraseGroup_-896262343 … Transitioning to phrase: ackconfirm Playing phrase: ackconfirm … Transitioning to phrase: _next_ Playing phrase: goodbye … Transitioning to phrase: _next_

Back to top