All notable changes to CAPS will be documented in this file.
- Don’t modify stream start time if the assoicated data file couldn’t deleted while purge run. This approach makes sure that stream start time and the data files are kept in sync.
- Extended purge log. The extended purge log can be enabled with
the config option
AS.logPurge. This feature is not enabled by default.
- Log maximum number of days to keep data per stream at start
Added new command line option
configtestthat runs a configuration file syntax check. It parses the configuration files and either reports Syntax OK or detailed information about the particular syntax error.
Added Websocket interface which accepts HTTP connections (e.g. from a web browser) and provides the CAPS protocol via Websockets. An additional configuration will be necessary:
AS.WS.port = 18006 # Provides the Websocket interface via secure sockets layer. # The certificate and key used will be read from # AS.SSL.certificate and AS.SSL.key. AS.WS.SSL.port = 18007
Simplified the authorization configuration. Instead of using one login file for each CAPS interface we read the authentication information from a shadow file. The file contains one line per user where each line is of format "username:encrypted_pwd". To encrypt a password mkpasswd can be used. It is recommended to apply a strong algorithm such as sha-256 or sha-512. The command "user=sysop pw=
mkpasswd -m sha-512&& echo $user:$pw" would generate a line for e.g. user "sysop". The shadow file can be configured with the config option
# The username is equal to the password test:$6$jHt4SqxUerU$pFTb6Q9wDsEKN5yHisPN4g2PPlZlYnVjqKFl5aIR14lryuODLUgVdt6aJ.2NqaphlEz3ZXS/HD3NL8f2vdlmm0 user1:$6$mZM8gpmKdF9D$wqJo1HgGInLr1Tmk6kDrCCt1dY06Xr/luyQrlH0sXbXzSIVd63wglJqzX4nxHRTt/I6y9BjM5X4JJ.Tb7XY.d0 user2:$6$zE77VXo7CRLev9ly$F8kg.MC8eLz.DHR2IWREGrSwPyLaxObyfUgwpeJdQfasD8L/pBTgJhyGYtMjUR6IONL6E6lQN.2QLqZ5O5atO/
In addition to user authentication user access control properties are defined in a passwd file. It can be configured with the config option
AS.users.passwd. Each line of the file contains a user name or a group id and a list of properties in format "username:prop1,prop2,prop3".Those properties are used to grant access to certain functionalities. Currently the following properties are supported by CAPS: read, write.: "read and write.". By default a anonymous user with read and write permissions exists. Groups use the prefix % so that they are clearly different from users.
user1: read,write %test: read
The group file maps users to different groups. Each line of the file maps a group id to a list of user names. It can be configured with the config option
With the reserved keyword ALL a rule will be applied to all users.
STATIONS.DENY = all STATIONS.AM.ALLOW = user1
We no longer watch the status of the inventory and the access file with Inotify because it could be dangerous in case of an incomplete saved configuration. A reload of the configuration can be triggered by sending a SIGUSR1 signal to the CAPS process. Example:
kill -SIGUSR1 <pid>
CAPS reloads the following files, if necessary:
- access list
- Improved plugin data scheduling which could have caused increased delays of data if one plugin transmits big amounts of data through a low latency network connection, e.g. localhost
- Added new config option
AS.filebase.purge.initIdleTimethat allows to postpone the initial purge process up to n seconds. Normally after a start the server tries to catch up all data which might be an IO intensive operation. In case of a huge archive the purge operation slow downs the read/write performace of the system too. To reduce the load at start it is a good idea to postpone this operation.
- Added index file check during archive scan and rebuild them if corrupt. The lack of a check sometimes caused CAPS to freeze while starting up.
- Spin up threads correctly in case of erroneous configuration during life reconfiguration
- Reinitalize server ports correctly after reloading the access list. This was not a functional bug, only a small memory leak.
- High IO usage while data storage purge. In worst case the purge operation could slow down the complete system so that incoming packets could not be handled anymore.
- Assigned human readable descriptions to threads. Process information tools like top or htop can display this information.
- Improved handling of incoming packets to prevent packet loss to subscribed sessions in case of heavy load.
- Fixed access list evaluator. Rather than replacing general rules with concrete rules they are now merged hierarchically.
- CAPS archive log will be removed at startup and written at shutdown. With this approach we want to force a rescan of the complete archive in case of an unexpected server crash.
- Fixed parameter name if HTTP SSL port, which should be
- Fixed caps protocol real time handler bug which caused gaps on client-side when retrieving real time data
- Log requests per CAPS server instance
- Improved data scheduler to hopefully prevent clients from stalling the plugin input connections
- Fixed bug in combination with SSL connections that caused CAPS to not accept any incoming connections after some time
- Added option
AS.inventorywhich lets CAPS read an SC3 inventory XML file to be used together with WWS requests to populate channel geo locations which will enable e.g. the map feature in Swarm.
- data store start time calculation in case of the first record start time is greater than the requested one
- segmentation fault caused by invalid FDSN request
- timing bug in the CAPS WWS protocol implementation
AS.minDelaywhich delays time window requests for the specified number of seconds. This parameter is only effective with FDSNWS and WWS.
- Add experimental Winston Wave Server(WWS) support. This feature is disabled by default.
- Add FDSNWS dataselect support for archives miniSEED records. This support is implicitely enabled if HTTP is activated
- Moved log output that the index was reset and that an incoming record has not ignored to debug channel
- Added option
AS.clientBufferSizeto configure the buffer size for each client connection. The higher the buffer size the better the request performance
- Added out-of-order requests for clients. The rsas plugin with
version >= 0.6.0 supports requesting out-of-order packets with
- Improved record insertion speed with out-of-order records