Project

General

Profile

Wiki » History » Version 21

Chad Trabant, 01/07/2014 04:57 PM

1 1 Chad Trabant
h1. Ringserver
2 2 Chad Trabant
3 20 Chad Trabant
Ringserver is a generic ring buffer.  The server is commonly used as a buffer for (near) real-time streaming feeds of time series data.  Each individual time series is usually identified with a stream name (for seismological data these are equivalent to unique channels).  The stream names are completely arbitrary allowing conventions to be created for specific needs.
4 16 Chad Trabant
5 20 Chad Trabant
In general, data clients connect to the server and submit a "subscription" for specific streams and as other data clients submit data into the system they are sent to clients with matching subscriptions.  By identifying each buffer packet uniquely and allowing a client to select a starting point in the buffer, clients can resume broken connections without data loss.
6 1 Chad Trabant
7 3 Chad Trabant
Communicating with a server is generally done using the DataLink protocol over TCP/IP.  A DataLink client can query the server for various server details, submit data, and subscribe to streams.  Server details can include stream lists, client lists and server statistics.  A library in C that implements the DataLink protocol is available.
8 1 Chad Trabant
9 3 Chad Trabant
The dalitool program can be used to monitor and diagnose a ringserver node.  Source code for this program and the ringserver itself is available here:
10 3 Chad Trabant
11 4 Chad Trabant
http://www.iris.edu/pub/programs/ringserver
12 3 Chad Trabant
13 1 Chad Trabant
h1. Server configuration, on-the-fly changes
14 1 Chad Trabant
15 15 Chad Trabant
The server can be configured using either command line options or a configuration file.
16 15 Chad Trabant
17 15 Chad Trabant
Most options, if specified via the configuration file, can be changed on the fly.
18 10 Chad Trabant
19 14 Chad Trabant
[[Configuring the server]]
20 2 Chad Trabant
21 21 Chad Trabant
[[ringserver manual]]
22 21 Chad Trabant
23 21 Chad Trabant
[[ringserver configuration file]] with detailed descriptions of options
24 21 Chad Trabant
25 1 Chad Trabant
h1. SeedLink support
26 1 Chad Trabant
27 18 Chad Trabant
While the architecture implemented by ringserver is completely generic some additions have been made to support the "SeedLink":http://www.iris.edu/data/dmc-seedlink.htm protocol.  In particular for packets where the data are 512-byte miniSEED records the server can be configured to serve the streams via SeedLink.  This option must be enabled, listening for SeedLink connections is not done by by default.
28 1 Chad Trabant
29 5 Chad Trabant
h1. Stand-alone SeedLink server
30 1 Chad Trabant
31 19 Chad Trabant
The ringserver software may be used to implement a stand-alone SeedLink server.  One pre-requisite to serving data via SeedLink from ringserver to is have data formatted as 512-byte miniSEED data records.  To accomplish this there are two options:
32 5 Chad Trabant
33 8 Chad Trabant
* Users that already have 512-byte miniSEED written to files may configure ringserver to continuously scan directories and files and read any newly arriving data.  Read [[How to configure ringserver as a SeedLink streaming server]] for more information.
34 5 Chad Trabant
35 5 Chad Trabant
* Users that can write a program that can submit 512-byte miniSEED data to ringserver via DataLink (TCP/IP) simply need to configure the server to listen for SeedLink connections and run their submission client.
36 1 Chad Trabant
37 1 Chad Trabant
h1. Implementation and resource requirements
38 6 Chad Trabant
39 6 Chad Trabant
The ring buffer managed by ringserver is a traditional first-in-first-out (FIFO) buffer, once the buffer is full adding new data packets pushes the oldest data packets out of the buffer.  The buffer can be run in any of these configurations:
40 6 Chad Trabant
41 9 Chad Trabant
* (Default) As a memory-mapped file.  This allows the buffer to be larger than the available memory and be stateful.  Default size is 1 Gigabyte and is only limited to machine resources, buffer sizes above 2 Gigabytes will generally require a 64-bit binary.
42 6 Chad Trabant
* Read from a file into memory on startup and written to the same file on shutdown.  Allows for a stateful buffer and for situations where memory-mapping is not possible or practical.
43 6 Chad Trabant
* As a volatile memory-only buffer.  Used in special scenarios only, the buffer is lost on shutdown.
44 1 Chad Trabant
45 1 Chad Trabant
h1. 3rd party libraries used
46 2 Chad Trabant
47 17 Chad Trabant
The ringserver program uses the following open source libraries:
48 2 Chad Trabant
* PCRE - Perl Compatible Regular Expressions (www.pcre.org)
49 2 Chad Trabant
* Mini-XML - Lightweight XML Library (www.minixml.org)