Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerilym/winston-axios
An axios transport for winston which allows for sending REST requests to an external API
https://github.com/aerilym/winston-axios
axios winston winston-transport
Last synced: about 2 months ago
JSON representation
An axios transport for winston which allows for sending REST requests to an external API
- Host: GitHub
- URL: https://github.com/aerilym/winston-axios
- Owner: Aerilym
- Created: 2022-08-18T14:36:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-11T02:20:53.000Z (5 months ago)
- Last Synced: 2024-08-11T04:13:18.542Z (5 months ago)
- Topics: axios, winston, winston-transport
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/winston-axios
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Winston-Axios
[](https://github.com/Aerilym/winston-axios/actions/workflows/build.yml)
[](https://badge.fury.io/js/winston-axios)
[](https://snyk.io/test/github/aerilym/winston-axios)
An axios transport for winston which allows for sending REST requests to an external API.
## Usage
### Setup
```JavaScript
const { AxiosTransport } = require('winston-axios');
```
or
```TypeScript
import { AxiosTransport } from 'winston-axios';
```
### Create a logger with an Axios Transport
```JavaScript
const winston = require('winston');
const { AxiosTransport } = require('winston-axios');
const logger = winston.createLogger({
level: 'info',
format: winston.format.json(),
transports: [
new AxiosTransport({
url: 'http://localhost:9999',
path: '/log',
auth: 'abc123',
}),
],
});
```
### Add an Axios Transport to an existing logger
```JavaScript
const { AxiosTransport } = require('winston-axios');
logger.add(
new AxiosTransport({
host: 'http://localhost:9999/log'
})
);
```
### Receiving the log message
You can simply use `logger.info(request.body);` to log the request in the external API as Winston can resolve the body.
More information on body formatting is to come.
## Example
A production example of using this transport is available here: [photoprism-helper logger.ts](https://github.com/Aerilym/photoprism-helper/tree/master/src/logger.ts)
Here is the relevant code, omitting anything not relevant to the transport:
```TypeScript
import { createLogger, transports } from 'winston';
import { AxiosTransport } from 'winston-axios';
const config = {
levelConsole: 'info',
url: 'http://apiurl.com'
key: 'abc123'
}
//.code here.//
// Create a logger instance with custom settings
export const logger = createLogger({
transports: [
new transports.Console({ level: config.levelConsole }),
//.code here.//
],
//.code here.//
});
//.code here.//
// Add an Axios transport to the logger instance
logger.add(
new AxiosTransport({
url: config.url,
path: '/log',
auth: config.key,
})
);
```
## Documentation
- AxiosTransportOptions
-
Options for Axios Transport.
- AxiosTransport
-
Transport for Winston that sends log messages to a remote server using Axios.
## AxiosTransportOptions
Options for Axios Transport.
| Param | Type | Description |
| -------- | -------------------------------- | --------------------------------------------------------------------------------------------------- |
| url | string | The url to send the logs to. |
| path | string | The path to send the logs to. The destination url will resolve to url + path. |
| auth | string | The authentication token to send with the logs. Will override any auth headers provided in headers. |
| authType | TransportAuthType | The type of authentication to use. |
| method | TransportMethod | The method to use when sending the logs. |
| headers | AxiosRequestHeaders | The headers to send with the logs. |
## AxiosTransport
Transport for Winston that sends log messages to a remote server using Axios.
**See**: [AxiosTransportOptions](#AxiosTransportOptions)
### new AxiosTransport(options)
| Param | Type | Description |
| ------- | ------------------------------------------------------------ | ------------------------------ |
| options | [AxiosTransportOptions](#AxiosTransportOptions) | The options for the transport. |
**Example**
```js
const logger = createLogger({
transports: [
new AxiosTransport({
url: 'http://localhost:3000',
path: '/logs',
}),
],
});
logger.log({ level: 'info', message: 'Hello World' });
```