search

feedhenry / fh-messaging

FeedHenry Messaging Server
Apache License 2.0
1 stars 25 forks source link

readme

fh-messaging(1) -- The FeedHenry Message Server

DESCRIPTION

This contains the 2 messaging components

fh-messaging

This is the main messaging server which handles receiving messages and storing them in the database. It also has the scripts/commands for doing batch imports, and rollups for the metrics

fh-metrics

This is the metrics server which handles serving metrics data to millicore. It has been seperated from fh-messaging, so that App Studio will not be affect by slowness or downtime of the messaging server

API endpoints

fh-messaging

The express routes for fh-messaging are defined in ./fh-messaging/lib/fhsrv.js as per:

Route HTTP method Purpose
/ GET Returns all topics
/:topic GET Returns selected topic
/:topic/:md5id GET Returns a raw message based on its topic and unique hash
/:topic/:md5id HEAD Checks if the message with given hash exists
/:topic POST Creates a new topic
/daily POST Runs rollup process for the day (rollupHandler.run)
/receive/:level POST Stores the rolled-up data from mbaases (rollupHandler.storeByLevel)
/info/ping GET Returns service connectivity check result
/info/version GET Returns service version
/info/stats GET Returns service stats
/info/status GET Returns service status
/info/health GET Returns health check details (healthmonitor(config))

fh-metrics

The express routes for fh-metrics are defined in ./fh-metrics/lib/fhmetricssrv.js as per:

Route HTTP method Purpose
/:level GET Returns the rolled-up data by level - apps, projects, domains, etc. (metricsHandler.byLevel)
/:metric POST Return metrics based on the query params in the request body
/info/ping GET Returns service connectivity check
/info/version GET Returns service version
/info/stats GET Returns service stats
/info/status GET Returns service status
/info/health GET Returns health check details (healthmonitor(config))

Tests

Individual component testing

Each component has there own test suite that runs tests on the components individually. see the individual components README's for more on this.

Acceptance tests

Run the acceptance test suite

Install whiskey https://github.com/cloudkick/whiskey

npm install -g whiskey

Install any other dependancies

npm install

Run the tests

npm test

Run a single test

whiskey --dependencies tests/dependencies.json --only-essential-dependencies --real-time --report-timing --tests tests/test_fhinit.js

IMPORTANT: Timezone must be IST currently for tests to work. IMPORTANT: Mongo Auth must not be enabled for tests to work.

Manual tests

Testing Cloud Reporting Manually

For instructions how to test cloud reporting manually, refer to fh-metrics/README.md.

License

fh-messaging & fh-metrics are licensed under the Apache License, Version 2.0.