smartlog-destination-local/docs/index.md

75 lines
3.6 KiB
Markdown
Raw Normal View History

2017-04-22 11:22:56 +00:00
# beautylog
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
beautiful logging, TypeScript ready
## Availabililty
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/beautylog)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/beautylog)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/beautylog)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/beautylog/)
## Status for master
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
[![build status](https://GitLab.com/pushrocks/beautylog/badges/master/build.svg)](https://GitLab.com/pushrocks/beautylog/commits/master)
[![coverage report](https://GitLab.com/pushrocks/beautylog/badges/master/coverage.svg)](https://GitLab.com/pushrocks/beautylog/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/beautylog.svg)](https://www.npmjs.com/package/beautylog)
[![Dependency Status](https://david-dm.org/pushrocks/beautylog.svg)](https://david-dm.org/pushrocks/beautylog)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/beautylog/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/beautylog/badges/code.svg)](https://www.bithound.io/github/pushrocks/beautylog)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
2017-04-22 11:26:11 +00:00
## Quick Demo
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
[![asciicast](https://asciinema.org/a/46djsde96ecsho9wqibjx2zye.png)](https://asciinema.org/a/46djsde96ecsho9wqibjx2zye)
## Usage
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
Use TypeScript for best in class instellisense.
```javascript
2018-03-01 00:06:12 +00:00
beautylog.log('some log message'); // normal console log message
beautylog.info('some log message'); // info console log message
beautylog.ok('some log message'); // ok console log message
beautylog.warn('some log message'); // warn console log message
beautylog.success('some success message'); // success console log message
beautylog.error('some error message'); // error console log message
2017-04-22 11:22:56 +00:00
```
### Ora Integration
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
beautylog wraps the excellent ora module from npm to better work with beautylog. In general that means that you can log persistent messages WHILE you are actually having an active Ora object. beautylog handles all the fuss for you.
```javascript
2018-03-01 00:06:12 +00:00
beautylog.ora.start('Hi, this is some text!', 'blue');
beautylog.info('some persistent text'); //does not disturb ora
console.log('something'); // even this works because console.log is monkeypatched by beautylog
beautylog.ora.text('some updated text'); // switches the text
beautylog.ora.stop();
2017-04-22 11:22:56 +00:00
```
## Centralized remote logging
2018-03-01 00:06:12 +00:00
2017-04-22 11:22:56 +00:00
Beautylog makes it easy to have all your node applications log to a remote location.
```javascript
2018-03-01 00:06:12 +00:00
import { Loggly } from 'beautyremote';
2017-04-22 11:22:56 +00:00
let myLogglyRemote = new Loggly({
2022-10-26 16:41:04 +00:00
token: 'my_super_long_token_here',
2018-03-01 00:06:12 +00:00
});
beautylog.registerRemote(myLogglyRemote);
2017-04-22 11:22:56 +00:00
```
> Note: Beautylog monkeypatches all console log methods.
2018-03-01 00:06:12 +00:00
> There is no need to change anything in your code.
> Everything that is getting logged to your console by node will get logged to a remote as well.
2017-04-22 11:22:56 +00:00
For further information read the linked docs at the top of this README.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2018-03-01 00:06:12 +00:00
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-04-22 11:22:56 +00:00
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)