Giter VIP home page Giter VIP logo

stackify-log-winston's Introduction

Stackify Log API for Winston

npm version

Winston transport for Stackify

Errors and Logs Overview:

http://support.stackify.com/errors-and-logs-overview/

Sign Up for a Trial:

http://www.stackify.com/sign-up/

Installation

$ npm install stackify-logger
$ npm install winston-stackify

Usage

Using the default logger:

var winston = require('winston');
var stackify = require('stackify-logger');

stackify.start({apiKey: '***', appName: 'Node Application', env: 'dev'});

require('winston-stackify').Stackify;

winston.add(winston.transports.Stackify, {storage : stackify});

Instantiating your own logger:

var winston = require('winston');
var stackify = require('stackify-logger');

stackify.start({apiKey: '***', appName: 'Node Application', env: 'dev'});

require('winston-stackify').Stackify;

var logger = new (winston.Logger)({
    transports: [
        new (winston.transports.Console)(),
        new (winston.transports.Stackify)(options)
    ]
});

The following options could be passed to the start method:

  • apiKey (Required): Stackify API key
  • appName (Required): Application name
  • env: Environment name. If a Stackify agent is installed, this does not need to be set. If a Stackify agent is not installed, this should be set to the environment name.
  • proxy: HTTP proxy
  • debug: Enables internal debug logging for troubleshooting. Defaults to false.

The Stackify Winston transport takes the following options:

  • storage (Required): Stackify logging library instance. You should specify it directly by passing stackify-logger module instance.
  • level: Level of messages that this transport should log.
  • silent: Boolean flag indicating whether to suppress output, defaults to false.
  • handleExceptions: Property set to false by default for this transport because Stackify Logger Library handles exceptions itself already. If you're not using default logger and instantiating your own, you don't need to set this option for Stackify transport.

Troubleshooting

If logging isn't working, enable internal debug logging for Stackify by setting the debug flag in the Stackify options.

stackify.start({apiKey: '***', appName: 'Node Application', env: 'dev', debug: true});

You will see stackify-debug.log in your application's directory.

License

Copyright 2019 Stackify, LLC.

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.

stackify-log-winston's People

Contributors

alexanderdesmond avatar alexk-blackops avatar darinhoward avatar eric-martin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

stackify-log-winston's Issues

Adding configuration to Angular Project

I didn't find where to add this code for core angular project created with angular CLI which is using 3rd party API. Can you please provide proper documentation/readme.md where can configure for my project?

Upgrade to 3.0 transport

Upgrade/add new version that is 3.0 native - will resolve 'stackify is a legacy winston transport' from showing up.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.