https://github.com/RackHD/on-syslog

https://github.com/RackHD/on-syslog

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/RackHD/on-syslog
• Owner: RackHD
• License: apache-2.0
• Created: 2015-08-31T17:29:17.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-07-06T22:32:16.000Z (over 6 years ago)
• Last Synced: 2024-04-24T20:43:35.931Z (7 months ago)
• Language: JavaScript
• Size: 352 KB
• Stars: 5
• Watchers: 26
• Forks: 38
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# on-syslog [![Build Status](https://travis-ci.org/RackHD/on-syslog.svg?branch=master)](https://travis-ci.org/RackHD/on-syslog) [![Code Climate](https://codeclimate.com/github/RackHD/on-syslog/badges/gpa.svg)](https://codeclimate.com/github/RackHD/on-syslog) [![Coverage Status](https://coveralls.io/repos/RackHD/on-syslog/badge.svg?branch=master&service=github)](https://coveralls.io/github/RackHD/on-syslog?branch=master)

`on-syslog` provides a syslog service that routes syslog messages into the

RackHD workflow engine

Copyright 2015, EMC, Inc.

## installation

    rm -rf node_modules

    npm install

    npm run apidoc

## running

Note: requires MongoDB and RabbitMQ to be running to start correctly.

    sudo node index.js

## CI/testing

To run tests from a developer console:

    npm test

To run tests and get coverage for CI:

    # verify hint/style

    ./node_modules/.bin/jshint -c .jshintrc --reporter=checkstyle lib index.js > checkstyle-result.xml || true

    ./node_modules/.bin/istanbul cover -x "**/spec/**" _mocha -- $(find spec -name '*-spec.js') -R xunit-file --require spec/helper.js

    ./node_modules/.bin/istanbul report cobertura

    # if you want HTML reports locally

    ./node_modules/.bin/istanbul report html

## Building

Unversioned packages are built automatically from travis-ci and uploaded to bintray.com. Using

this repository is detailed in [the docs](http://rackhd.readthedocs.org/en/latest/rackhd/ubuntu_package_installation.html).

Build scripts are placed in the `extra/` directory.

  * `.travis.yml` will call the appropriate scripts in `extra/` to build an unversioned package.

  * `extra/make-sysdeps.sh` can be used to install system level packages in a Ubuntu system.

  * `extra/make-cicd.sh` will perform all the necessary build steps to generate a version package.

If you want to build your own versioned packages, you can use the Vagrantfile provided in `extra/`.  Simply perform `vagrant up` and it will run all the necessary steps.

## Licensing

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

RackHD is a Trademark of Dell EMC