@hapiness/logger

Hapiness module for logging

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@hapiness/logger
001.1.06 years ago7 years agoMinified + gzip package size for @hapiness/logger in KB

Readme

Hapiness
<a href="https://travis-ci.org/hapinessjs/logger-module.svg?branch=master">
    <img src="https://travis-ci.org/hapinessjs/logger-module.svg?branch=master" alt="build" />
</a>
<a href="https://coveralls.io/github/hapinessjs/logger-module?branch=master">
    <img src="https://coveralls.io/repos/github/hapinessjs/logger-module/badge.svg?branch=master" alt="coveralls" />
</a>
<a href="https://david-dm.org/hapinessjs/logger-module">
    <img src="https://david-dm.org/hapinessjs/logger-module.svg" alt="dependencies" />
</a>
<a href="https://david-dm.org/hapinessjs/logger-module?type=dev">
    <img src="https://david-dm.org/hapinessjs/logger-module/dev-status.svg" alt="devDependencies" />
</a>
<a href="https://www.typescriptlang.org/docs/tutorial.html">
    <img src="https://cdn-images-1.medium.com/max/800/1*8lKzkDJVWuVbqumysxMRYw.png"
         align="right" alt="Typescript logo" width="50" height="50" style="border:none;" />
</a>
<a href="http://reactivex.io/rxjs">
    <img src="http://reactivex.io/assets/Rx_Logo_S.png"
         align="right" alt="ReactiveX logo" width="50" height="50" style="border:none;" />
</a>
<a href="http://hapijs.com">
    <img src="http://bit.ly/2lYPYPw"
         align="right" alt="Hapijs logo" width="75" style="border:none;" />
</a>
Logger Module
Logger module for the Hapiness framework.

Table of contents

* [Yarn or NPM it in your package.json](#yarn-or-npm-it-in-your-packagejson)
* [Import LoggerModule from the library](#import-loggermodule-from-the-library)

Using your module inside Hapiness application

yarn or npm it in your package.json

$ npm install --save @hapiness/core @hapiness/logger rxjs

or

$ yarn add @hapiness/core @hapiness/logger rxjs
"dependencies": {
    "@hapiness/core": "^1.2.2",
    "@hapiness/logger": "^1.1.0",
    "rxjs": "^5.5.2",
    //...
}
//...

import LoggerModule from the library

import { Hapiness, HapinessModule, HttpServer, OnGet } from '@hapiness/core';
import { LoggerModule, LoggerService } from '@hapiness/logger';

@HapinessModule({
    version: '1.0.0',
    imports: [
        LoggerModule
    ]
})
class HapinessModuleApp {
    constructor(private _logger: LoggerService) {
        this._logger.info('my data log');
    }
}

@Route({
    method: 'get',
    path: '/test'
})
class MyRoute implements OnGet {
    constructor(private _logger: LoggerService) {}
    onGet(request, reply) {
        this._logger.warn('my data log');
        reply('test');
    }
}

// Define your logger

Hapiness.bootstrap(HapinessModuleApp, [ LoggerExt.setConfig({ logger: myLogger }) ]);

Access logs

If HttpServerExt is loaded, the LoggerModule will inject an AccessLogs component. To desactivate the access logs, provide a module's config:
@HapinessModule({
    version: '1.0.0',
    imports: [
        LoggerModule.setConfig({ accessLogs: false })
    ]
})
class HapinessModuleApp {
    ...
}

Back to top

Contributing

To set up your development environment:
  1. clone the repo to your workspace,
  2. in the shell cd to the main folder,
  3. hit npm or yarn install,
  4. run npm or yarn run test.
* It will lint the code and execute all tests. 
* The test coverage report can be viewed from `./coverage/lcov-report/index.html`.
Back to top

Change History

  • v1.1.0 (2017-11-20)
* Latest packages' versions.
* Documentation.
* Change packaging process.
  • v1.0.0 (2017-10-26)
* Create LoggerModule
* Logger extension
* Logger provider
* Access logs
* Documentation
Back to top

Maintainers

<tr>
    <td colspan="4" align="center"><a href="https://www.tadaweb.com"><img src="http://bit.ly/2xHQkTi" width="117" alt="tadaweb" /></a></td>
</tr>
<tr>
    <td align="center"><a href="https://github.com/Juneil"><img src="https://avatars3.githubusercontent.com/u/6546204?v=3&s=117" width="117"/></a></td>
    <td align="center"><a href="https://github.com/antoinegomez"><img src="https://avatars3.githubusercontent.com/u/997028?v=3&s=117" width="117"/></a></td>
    <td align="center"><a href="https://github.com/reptilbud"><img src="https://avatars3.githubusercontent.com/u/6841511?v=3&s=117" width="117"/></a></td>
    <td align="center"><a href="https://github.com/njl07"><img src="https://avatars3.githubusercontent.com/u/1673977?v=3&s=117" width="117"/></a></td>
</tr>
<tr>
    <td align="center"><a href="https://github.com/Juneil">Julien Fauville</a></td>
    <td align="center"><a href="https://github.com/antoinegomez">Antoine Gomez</a></td>
    <td align="center"><a href="https://github.com/reptilbud">Sébastien Ritz</a></td>
    <td align="center"><a href="https://github.com/njl07">Nicolas Jessel</a></td>
</tr>

Back to top

License

Copyright (c) 2017 Hapiness Licensed under the MIT license.
Back to top