SWISS TXT CDN logparser for the Xtendx Simplex Media Server
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
Gemfile
LICENSE.txt
README.md
Rakefile
sms-logparser.gemspec

README.md

SMS Logparser

sms-logparser - Logparser for Simplex Media Server (SMS). Reads access logs stored in a MySQL database (coming from the SWISS TXT CDN) accumulates and sends them to the SMS API.

Gem Version

Installation

Install the sms-logpaser gem:

$ gem install sms-logparser

Setup

Create the database table to track which logs have been parsed:

$ sms-logparser setup

Make a test run:

$ sms-logparser parse --simulate

Usage

See available commands:

$ sms-logparser help

Parse logs from database and send them to the API

$ sms-logparser parse

Show the last parser runs:

$ sms-logparser history

Configuration file

sms-logparser tries to read default options from a yaml file named '.sms-logparser.yml' placed in your home directory. Using the "-c/--config" flag you can adapt the path to the configuration file.

An example configuration (~/.sms-logparser.yml) for adapting the default MySQL password and setting the api_key:

mysql_password: 'my!secret'
api_key:        'xqugl-hjh54-dr97-9kjdkjwi988d-123456'

Development

  • check out the git repo (git clone <repo>)
  • implement your changes
  • run the tests (rake test)
  • bump the version number commit your changes and release a new version of the gem (rake release)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request