Scheduling automated dataset updates is the best way to save time and effort while keeping your data up-to-date and accurate. Our Notifications & Alerts feature now enables you to monitor any scheduled updates configured with Socrata Gateway or Schedule from URL, as well as monitoring Socrata Gateway agent activity. These notification options are customizable so that you can decide which event types to be notified of, as well as where to receive the notifications themselves (via email, in the Socrata platform, or both).
The new notification options are:
Scheduled automation fails
Scheduled automation succeeds
Gateway agent goes offline
Gateway agent comes online
Some details to know:
Most scheduled automation failures can be attributed to a handful of common causes. We have identified many of these so that in the majority of cases you will see a descriptive error message along with your notification. If you receive a schedule failure notification without a descriptive error message, please contact Socrata Support at firstname.lastname@example.org to learn more.
The Socrata Gateway service periodically pushes updates which require Gateway agents to briefly go offline (typically for less than two minutes). To eliminate any noise related to this quick and normal online/offline activity, we queue “Agent gone offline” notifications for two minutes before sending them to you. If the agent comes back online in two minutes or less, we cancel the notification.
Here’s how to configure your notifications:
When logged in to your Socrata domain, click the bell icon at the top right to open the Notifications & Alerts feature.
Click the “Settings” button at the bottom to open your options (users with the Administrator role may see additional options on this screen):
Select the type of notifications you would like to receive. If you are enabling notifications for schedule failures, you will see an additional required field labeled “Only notify me when there are at least this many consecutive failures.” Schedule failures are often due to transient issues that go away on their own, with the first or second automatic retry succeeding normally. This field enables you to set a threshold for your alerts so that you only hear about schedules which have failed persistently. The value in this field will default to 5; we recommend setting this value no lower than 3 to avoid excess noise.
IMPORTANT: In order to receive timely notifications of these and other events, review the “Frequency” configuration and make sure you have unchecked the option to “Send notifications as a digest rather than individual emails.” If this option is selected, you will not receive notifications in real time.
Any roled user can choose to subscribe to domain-wide notifications under the “All Assets” header. Please note that a permissions check is performed on individual notifications themselves prior to sending, so that notifications will be sent according to a user’s permissions on that given schedule or agent.
When you have completed your selections, click “Save” and close the modal.
Any email notifications you have enabled will be sent to the email address associated with your user account. An email notification will look like this:
In-app notifications will be indicated by a badge on the Notifications & Alerts bell icon. In-app notifications will look like this:
Managing Gateway Agents
Each Gateway agent you provision gets a standalone page that houses plugin creation and permissions management, information on existing plugins, agent events pulled directly from your domain’s Activity Feed, and live-running agent log feeds.
To access a Gateway Agent Dashboard, begin at the Gateway Administration page, and click on the hyperlinked “Plugins” value for a given agent.
This will bring you to that agent’s dashboard page. Use the tabs on the left to navigate between your agent’s plugins, logs, and events.
This tab contains information for all plugins configured on this agent. You can use the search bar, or sort by clicking the “Type” or “Plugin Name” headers, to locate specific plugins. Create new plugins using the “Add Plugin” button on the top right.
This tab contains a live-running feed of the agent’s logs. Check the “Follow Logs” option to keep this feed focused on the most recent log lines, or navigate to previous pages to check historical logs. There is also an option to display timestamps in the user’s local time, and to downloads a copy of the logs.
This tab contains a list of all the events associated with this agent. This information is pulled directly from your domain’s Activity Feed, so you no longer need to search or filter on the Activity Feed page to get this agent-specific information.
If you have any questions, please reach out to our Support Team at email@example.com.