@tsed/logger-logstash-http NPM

@tsed/logger-logstash-http

A package of Ts.ED logger framework.

Features

The logstash appenders for Ts.ED Logger send NDJSON formatted log events to logstash receivers. This appender uses HTTP to send the events (there is another logstash appender that uses UDP).

Installation

npm install --save @tsed/logger-logstash-http

Configuration

type - logstash-http
options.url - string - logFaces receiver servlet URL
options.application - string (optional) - used to identify your application's logs
options.logChannel - string (optional) - also used to identify your application's logs but in a more specific way
options.logType - string (optional) - used for the type field in the logstash data
options.timeout - integer (optional, defaults to 5000ms) - the timeout for the HTTP request.
options.maxBuffer - integer (optional, defaults to 0) - Group bulk request by the maxBuffer number. By Default the buffer is disabled.

This appender will also pick up Logger context values from the events, and add them as p_ values in the logFaces event. See the example below for more details.

Example

import {Logger} from "@tsed/logger";
import "@tsed/logger-logstash-http";

const logger = new Logger("loggerName");

logger.appenders.set("stdout", {
  type: "logstash-http",
  level: ["info"],
  options: {
    url: "http://localhost:9200/_bulk",
    application: "logstash-tsed",
    logType: "application",
    logChannel: "node"
  }
});

logger.context.set("requestId", "123");
logger.info("some interesting log message");
logger.error("something has gone wrong");

This example will result in two log events being sent to your localhost:9200. Both events will have a context.requestId property with a value of 123.

Backers

Thank you to all our backers! 🙏 [Become a backer]

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.