AWS Product Receiver

« Back to receiving

An AWS Product Receiver connects to a web socket to receive JSON Notifications about products. In addition to the standard receiver properties, this type of receiver accepts the following specific properties:

anyMessageInterval: The interval (in milliseconds) in which any type of message is expected to be received from the socket. If no message is received in this interval, it is assumed the socket has gone stale and the connection is re-established. If set to 0 or a negative value this functionality is not enabled.; Optional, Default: 0
connectAttempts: An integer number of times to try the websocket connection.; Optional, Default: 5
productsCreatedAfterClient: The name of a separate configuration sub-section defining the products created after client that is used for catch-up processing during startup and when a missing notification is detected.; Required
initialCatchUpAge: The initial age (in decimal days) for which to initially pull products for a new receiver.; Note: Receivers that have previously started and are re-starting will catch up based on information in their tracking index rather than their configured initialCatchUpAge. To restart processing using the initialCatchUpAge property, the tracking index must be cleared as well.; Optional, Default: 7.0
pingInterval: How often to send ping in milliseconds. If you do not want to send pings set to 0 or negative value.; Optional, Default: 15000
pingWait: How long to wait, in milliseconds, before declaring socket down and closing and retrying.; Optional, Default: 4000
trackingFileName: The name of the file in which to track products.; This is a shortcut for defining the trackingIndex. Only one of trackingIndex or trackingFileName should be specified. If both are specified, the trackingIndex takes precedence.
trackingIndex: Name of a separate configuration sub-section defining a tracking index.
url: The web socket URL from which the receiver will receive notifications.; Required

Example configuration

Note: Dependent configuration sub-sections not shown in this configuration example.

1
2
3
4
5
6
7
8
9
10
receivers = receiver_aws

[receiver_aws]
type = gov.usgs.earthquake.aws.AwsProductReceiver
index = receiver_index
initialCatchUpAge = 0.25
productsCreatedAfterClient = products_created_after
storage = receiver_storage
trackingIndex = receiver_tracking
url = wss://earthquake.usgs.gov/pdl/east/subscribe

Last modified: Tue Sep 3 18:12:07 UTC 2024

AWS Product Receiver

Required