MonitoringFME Flowwith Notifications
FME Flowpublishes content about significant activity and events, such as when aworkspacerun fromFME Flowsucceeds or fails, or when a repository is created.
FME Flowexposes some event content without the explicit use of Notification Service topics. Other content is exposed to the user directly through topics.
MonitoringFME FlowSystem Events
FME Flowpublishes content about significant events, such as when a repository is created, or a system backup is performed. You can see all events and their descriptions on theSystem Events反对figuration page (selectSystem Events>反对figuration).
You can monitor these events in the following ways:
- On theSystem Eventspage. Use the Configuration page to send emails when events occur, and enable or disable which events are monitored. Use the History page to see a history of all enabled events.
- In anAutomationsworkflow that is initiated by one or moreFME Flow System Eventtriggers. For example, this workflow notifies an Amazon SQS queue every time a repository is created:
MonitoringFME FlowEvents from Topics
FME Flowpublishes some event content to a set of pre-existing Notification Service topics that are exposed to the user. This content includes:
- Whenworkspaces run fromFME Flowsucceed or fail.
- When a backup or restore operation succeeds or fails.
- Whenworkspaces run to generate Dashboard statistics.
You can use these topics in the following ways:
- (Preferred) In anAutomationsworkflow that is initiated by anFME Flow Topictrigger.
- InSubscriptions:FME Flowincludes a set of subscribers that are already subscribed to these topics. When configured completely, these subscribers can deliver their content over the specified protocol.
For example, this workflow can deliver an email whenever the DATADOWNLOAD_ASYNC_JOB_FAILURE topic is notified:
Pre-Configured Topics
- When you publish aworkspacetoFME Flowto the Data Download or Job Submitter services.
- In anAutomationsworkflow that contains aFME Flow Topicexternal action.
In these cases, the corresponding topics below are not notified, unless they are also explicitly specified.
Topic Name | Description |
---|---|
DATADOWNLOAD_ASYNC_JOB_FAILURE | A notification for this topic is generated following aData Download ServiceFME transformation that fails. |
DATADOWNLOAD_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a Data Download Service FME transformation that succeeds. |
JOBSUBMITTER_ASYNC_JOB_FAILURE | A notification for this topic is generated following aJob Submitter ServiceFME transformation that fails. |
JOBSUBMITTER_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a Job Submitter Service FME transformation that succeeds. |
MIGRATION_ASYNC_JOB_FAILURE | A notification for this topic is generated following abackup or restorerequest that fails. |
MIGRATION_ASYNC_JOB_SUCCESS | A notification for this topic is generated following a backup or restore request that succeeds. |
GENERATE_DASHBOARD | A notification for this topic is generated when job history statistics are available forDashboards. |
SAMPLE_TOPIC | This is a sample topic. By default, no notifications are generated for this topic. It is used for testing notifications. |
Pre-Configured Subscribers
Subscriber Name | Topic(s) Subscribed To | Protocol | Description |
---|---|---|---|
DataDownload_Email_JobFailure | DATADOWNLOAD_ASYNC_JOB_FAILURE | Email Subscriber | Sends emails to specified recipients following a Data Download FME transformation that fails. |
DataDownload_Email_JobSuccess | DATADOWNLOAD_ASYNC_JOB_SUCCESS | Email Subscriber | Sends emails to specified recipients following a Data Download Service FME transformation that succeeds. |
JobSubmitter_Email_JobFailure | JOBSUBMITTER_ASYNC_JOB_FAILURE | Email Subscriber | Sends emails to specified recipients following a Job Submitter Service FME transformation that fails. |
JobSubmitter_Email_JobSuccess | JOBSUBMITTER_ASYNC_JOB_SUCCESS | Email Subscriber | Sends emails to specified recipients following a Job Submitter Service FME transformation that succeeds. |
Logger_Default | All default topics | Logger Subscriber | Logs all notifications of the topics to which it is subscribed. |
Migration_Email_JobFailure | MIGRATION_ASYNC_JOB_FAILURE | Email Subscriber | Sends emails to specified recipients following a backup or restore operation that fails. |
Migration_Email_JobSuccess | MIGRATION_ASYNC_JOB_SUCCESS | Email Subscriber | Sends emails to specified recipients following a backup or restore operation that succeeds. |
Dashboards_AverageRunningTime | GENERATE_DASHBOARD | FME Workspace Subscriber | Runs aworkspace这写AverageRunningTime.html to the Dashboards\dashboards folder on theResourcespage. This report is then displayed on theDashboardspage. |
Dashboards_DailyTotalJobs | GENERATE_DASHBOARD | FMEWorkspaceSubscriber | Runs aworkspacethat writes DailyTotalJobs.html to the Dashboards\dashboards folder on theResourcespage. This chart is then displayed on theDashboardspage. |
Dashboards_DailyAverageQueuedTime | GENERATE_DASHBOARD | FMEWorkspaceSubscriber | Runs aworkspacethat writes DailyAverageQueuedTime.html to the Dashboards\dashboards folder on theResourcespage. This chart is then displayed on theDashboardspage. |
Dashboards_DailyTotalRunningTime | GENERATE_DASHBOARD | FMEWorkspaceSubscriber | Runs aworkspacethat writes DailyTotalRunningTime.html to the Dashboards\dashboards folder on theResourcespage. This chart is then displayed on theDashboardspage. |
Dashboards_FailuresByWorkspace | GENERATE_DASHBOARD | FMEWorkspaceSubscriber | Runs aworkspacethat writes FailuresByWorkspace.html to the Dashboards\dashboards folder on theResourcespage. This chart is then displayed on theDashboardspage. |
Attaching Log Files to Notification Emails
You can configure the following subscribers to attach anFME job logfile with each email:
- DataDownload_Email_JobFailure
- DataDownload_Email_JobSuccess
- JobSubmitter_Email_JobFailure
- JobSubmitter_Email_JobSuccess
- Open the following files:
- <FMEFlowDir>\Utilities\tomcat\webapps\fmedatadownload\WEB-INF\conf\propertiesFile.properties
- <FMEFlowDir>\Utilities\tomcat\webapps\fmejobsubmitter\WEB-INF\conf\propertiesFile.properties
- In each file, locate theATTACH_TRANSFORMATION_LOGparameter.
- To attach a job log file, set this parameter to
true
. To stop the subscribers from attaching job log files, set this parameter tofalse
. (This is the default setting.) - RestarttheFME FlowApplication Server.