@logtape/syslog 0.12.0-dev.199 → 0.12.0-dev.201

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +38 -75
  2. package/deno.json +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,89 +1,52 @@
1
- # @logtape/syslog
1
+ <!-- deno-fmt-ignore-file -->
2
2
 
3
- [![JSR](https://jsr.io/badges/@logtape/syslog)](https://jsr.io/@logtape/syslog)
4
- [![npm](https://img.shields.io/npm/v/@logtape/syslog)](https://www.npmjs.com/package/@logtape/syslog)
3
+ LogTape syslog sink
4
+ ===================
5
5
 
6
- Syslog sink for [LogTape]. This package provides a syslog sink that sends log messages to a syslog server following the [RFC 5424] specification.
6
+ [![JSR][JSR badge]][JSR]
7
+ [![npm][npm badge]][npm]
7
8
 
8
- ## Features
9
+ Syslog sink for [LogTape]. This package provides a syslog sink that sends log
10
+ messages to a syslog server following the [RFC 5424] specification.
9
11
 
10
- - **RFC 5424 compliant**: Follows the official syslog protocol specification
11
- - **Multiple transports**: Supports both UDP and TCP protocols
12
- - **Cross-runtime**: Works on Deno, Node.js, and Bun
13
- - **Non-blocking**: Asynchronous message sending with proper cleanup
14
- - **Configurable**: Extensive configuration options for facility, hostname, etc.
15
- - **Structured logging**: Optional structured data support
16
- - **Zero dependencies**: No external dependencies
17
-
18
- ## Installation
19
-
20
- ::: code-group
21
-
22
- ```sh [Deno]
23
- deno add jsr:@logtape/syslog
24
- ```
25
-
26
- ```sh [npm]
27
- npm add @logtape/syslog
28
- ```
29
-
30
- ```sh [pnpm]
31
- pnpm add @logtape/syslog
32
- ```
33
-
34
- ```sh [Yarn]
35
- yarn add @logtape/syslog
36
- ```
37
-
38
- ```sh [Bun]
39
- bun add @logtape/syslog
40
- ```
41
-
42
- :::
12
+ [JSR]: https://jsr.io/@logtape/syslog
13
+ [JSR badge]: https://jsr.io/badges/@logtape/syslog
14
+ [npm]: https://www.npmjs.com/package/@logtape/syslog
15
+ [npm badge]: https://img.shields.io/npm/v/@logtape/syslog?logo=npm
16
+ [LogTape]: https://logtape.org/
17
+ [RFC 5424]: https://tools.ietf.org/rfc/rfc5424.txt
43
18
 
44
- ## Usage
45
19
 
46
- ```typescript
47
- import { configure } from "@logtape/logtape";
48
- import { getSyslogSink } from "@logtape/syslog";
20
+ Features
21
+ --------
49
22
 
50
- await configure({
51
- sinks: {
52
- syslog: getSyslogSink({
53
- hostname: "syslog.example.com",
54
- port: 514,
55
- protocol: "udp",
56
- facility: "local0",
57
- appName: "my-app",
58
- }),
59
- },
60
- loggers: [
61
- { category: [], sinks: ["syslog"], level: "info" },
62
- ],
63
- });
64
- ```
23
+ - *RFC 5424 compliant*: Follows the official syslog protocol specification
24
+ - *Multiple transports*: Supports both UDP and TCP protocols
25
+ - *Cross-runtime*: Works on Deno, Node.js, and Bun
26
+ - *Non-blocking*: Asynchronous message sending with proper cleanup
27
+ - *Configurable*: Extensive configuration options for facility, hostname, etc.
28
+ - *Structured logging*: Optional structured data support
29
+ - *Zero dependencies*: No external dependencies
65
30
 
66
- ## Configuration Options
67
31
 
68
- - **hostname**: Syslog server hostname (default: "localhost")
69
- - **port**: Syslog server port (default: 514)
70
- - **protocol**: Transport protocol "udp" or "tcp" (default: "udp")
71
- - **facility**: Syslog facility (default: "local0")
72
- - **appName**: Application name in syslog messages (default: "logtape")
73
- - **syslogHostname**: Hostname field in syslog messages
74
- - **processId**: Process ID field in syslog messages
75
- - **timeout**: Connection timeout in milliseconds (default: 5000)
76
- - **includeStructuredData**: Include LogTape properties as structured data (default: false)
32
+ Installation
33
+ ------------
77
34
 
78
- ## Facilities
35
+ This package is available on [JSR] and [npm]. You can install it for various
36
+ JavaScript runtimes and package managers:
79
37
 
80
- Supports all RFC 5424 facilities:
81
- - System facilities: `kernel`, `user`, `mail`, `daemon`, `security`, `syslog`, `lpr`, `news`, `uucp`, `cron`, `authpriv`, `ftp`, `ntp`, `logaudit`, `logalert`, `clock`
82
- - Local facilities: `local0` through `local7`
38
+ ~~~~ sh
39
+ deno add jsr:@logtape/syslog # for Deno
40
+ npm add @logtape/syslog # for npm
41
+ pnpm add @logtape/syslog # for pnpm
42
+ yarn add @logtape/syslog # for Yarn
43
+ bun add @logtape/syslog # for Bun
44
+ ~~~~
83
45
 
84
- ## License
85
46
 
86
- MIT License. See [LICENSE](../LICENSE) for details.
47
+ Docs
48
+ ----
87
49
 
88
- [LogTape]: https://logtape.org/
89
- [RFC 5424]: https://tools.ietf.org/rfc/rfc5424.txt
50
+ The docs of this package is available at
51
+ <https://logtape.org/manual/sinks#syslog-sink>. For the API references,
52
+ see <https://jsr.io/@logtape/syslog>.
package/deno.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@logtape/syslog",
3
- "version": "0.12.0-dev.199+b454c29f",
3
+ "version": "0.12.0-dev.201+5fd8ad3c",
4
4
  "license": "MIT",
5
5
  "exports": "./mod.ts",
6
6
  "exclude": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@logtape/syslog",
3
- "version": "0.12.0-dev.199+b454c29f",
3
+ "version": "0.12.0-dev.201+5fd8ad3c",
4
4
  "description": "Syslog sink for LogTape",
5
5
  "keywords": [
6
6
  "logging",
@@ -41,7 +41,7 @@
41
41
  "./package.json": "./package.json"
42
42
  },
43
43
  "peerDependencies": {
44
- "@logtape/logtape": "0.12.0-dev.199+b454c29f"
44
+ "@logtape/logtape": "0.12.0-dev.201+5fd8ad3c"
45
45
  },
46
46
  "devDependencies": {
47
47
  "@alinea/suite": "^0.6.3",