tslog-influxdb-transport

Send logs to influxdb2 via telegraf without writing them to files.

About The Project

This library provides a transporter to configure and send logs from tslog via telegraph directly to InfluxDB2. This allows you to aggregate the logs in one place in this case in InfluxDB2. The stored log data can be visualized and alerts can be set up in the InfluxDB2 UI with the built-in Chronograf and Kapacitor tools.

Installation

npm i @harvve/tslog-influxdb-transport

Usage

Attach transport provider to tslog instance.

import { Logger } from 'tslog';
import { Transporter } from '@harvve/tslog-influxdb-transport';

const transporter = new Transporter({
  address: 'localhost',
  port: 3123,
  socketType: 'udp4',
  measurementName: 'myLoggerLogs',
  minLevel: 'info'
});

const logger: Logger = new Logger({
  name: 'myLogger',
  attachedTransports: [this.transporter.getTransportProvider()]
});

logger.info('Hello!');

Check out working example --> View Demo

Settings

All possible settings are defined in the ITransporterOptions interface and modern IDEs will provide auto-completion accordingly.

• port - number - Destination port (port on which the telegraf listens)
• address - string - Destination host name or IP address
• socketType - udp4 | udp6 - Type of socket
• measurementName - string - Name of measurement (in influxdb2 bucket)
• minLevel - TLogLevelName - Minimum logging level to transport - default 'debug'
• fieldKeys - Array - List of field keys - If no keys are provided, the default ones will be used
• tagKeys - Array - List of tag keys - with string value only - If keys are not specified, default ones will be used

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/harvve/tslog-influxdb-transport

Acknowledgments

• tslog docs
• InfluxDB2 docs
• Telegraf docs
• node.js dgram