https://github.com/robertklep/homey-syslog

Remote syslog logging for Homey apps
https://github.com/robertklep/homey-syslog

athom athom-homey home-automation homey ios syslog

Last synced: 11 days ago
JSON representation

Remote syslog logging for Homey apps

• Host: GitHub
• URL: https://github.com/robertklep/homey-syslog
• Owner: robertklep
• Created: 2017-12-08T07:53:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-08T15:38:15.000Z (about 7 years ago)
• Last Synced: 2024-12-23T17:15:47.624Z (15 days ago)
• Topics: athom, athom-homey, home-automation, homey, ios, syslog
• Language: JavaScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# homey-syslog

A simple library to enable [Homey](https://www.athom.com/) apps to log to a remote syslog server. This requires that you have a syslog server running somewhere in your network, configured to accept external connections from syslog clients.

This library patches the built-in Homey logging code so anything that gets logged will _also_ be logged to the syslog server.

## Installation

```

$ npm i homey-syslog

```

## Usage

In your apps `app.js`:

```

require('homey-syslog')([ SYSLOG_SERVER ][, opts]);

```

`SYSLOG_SERVER` is the name or IP-address of your syslog server.

It's optional iff you provide `Homey.env.SYSLOG_HOST`, i.e. if you have a file `env.json` that defines it:

```

{ "SYSLOG_HOST" : "11.22.33.44" }

```

Valid options:

* `port` : TCP/UDP port for the syslog server. Defaults to `Homey.env.SYSLOG_PORT`, or `514` otherwise.

* `transport`: either `tcp` or `udp` (the default)

* `globalHandlers`: when `true`, will hook `uncaughtException` and `unhandledRejection` to log these errors over syslog. Defaults to `Homey.env.SYSLOG_GLOBALHANDLERS === true`.

## Example

```

require('homey-syslog')('192.168.1.123', {

  port           : 514,

  transport      : 'tcp'

  globalHandlers : true,

});

```

## DON'T USE IN PRODUCTION CODE

The purpose of this library is to aid during development of Homey apps, it's not intended to be used for apps in production.

An option could be to explicitly set a `DEBUG` environment variable in `env.json`, and only load this library when that variable evaluates to true:

```

// env.json

{ "DEBUG" : "true", "SYSLOG_HOST" : "..." }

// app.js

if (Homey.env.DEBUG === 'true') {

  require('homey-syslog')(...);

}

```