@orgloop/logger-syslog 0.1.0 → 0.1.3
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.
- package/README.md +62 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @orgloop/logger-syslog
|
|
2
|
+
|
|
3
|
+
OrgLoop syslog logger -- RFC 5424 formatted messages for enterprise and Unix deployments. Supports UDP, TCP, and Unix socket transports with zero external dependencies.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @orgloop/logger-syslog
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Configuration
|
|
12
|
+
|
|
13
|
+
```yaml
|
|
14
|
+
loggers:
|
|
15
|
+
- name: syslog
|
|
16
|
+
type: "@orgloop/logger-syslog"
|
|
17
|
+
config:
|
|
18
|
+
transport: udp # udp | tcp | unix
|
|
19
|
+
host: "127.0.0.1" # Syslog server host (udp/tcp)
|
|
20
|
+
port: 514 # Syslog server port (udp/tcp)
|
|
21
|
+
path: "/dev/log" # Unix socket path (unix transport)
|
|
22
|
+
facility: local0 # Syslog facility
|
|
23
|
+
app_name: orgloop # APP-NAME field in messages
|
|
24
|
+
include_structured_data: true # Include [orgloop@49999 ...] SD element
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
All fields are optional and shown with their defaults.
|
|
28
|
+
|
|
29
|
+
## Behavior
|
|
30
|
+
|
|
31
|
+
Each log entry is formatted as an RFC 5424 syslog message:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
<134>1 2025-01-15T14:32:02.789Z myhost orgloop 12345 deliver.success [orgloop@49999 event_id="evt_abc" source="github" target="agent" duration_ms="342"] deliver.success github resource.changed evt_abc
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Severity mapping:** OrgLoop log phases are mapped to RFC 5424 severity levels:
|
|
38
|
+
|
|
39
|
+
| Severity | Phases |
|
|
40
|
+
|----------|--------|
|
|
41
|
+
| Error (3) | `deliver.failure`, `system.error` |
|
|
42
|
+
| Warning (4) | `transform.error`, `deliver.retry` |
|
|
43
|
+
| Informational (6) | `deliver.success`, `route.match`, `system.start`, `system.stop` |
|
|
44
|
+
| Debug (7) | `source.emit`, `route.no_match`, `transform.start` |
|
|
45
|
+
|
|
46
|
+
A `system.error` with `metadata.fatal: true` is upgraded to Critical (2).
|
|
47
|
+
|
|
48
|
+
**Structured data:** When enabled, event metadata is included as an RFC 5424 structured data element using `orgloop@49999` as the SD-ID, with fields like `event_id`, `trace_id`, `source`, `target`, and `duration_ms`.
|
|
49
|
+
|
|
50
|
+
**Transports:**
|
|
51
|
+
|
|
52
|
+
- **UDP** (default): Fire-and-forget. Lowest latency, no connection management.
|
|
53
|
+
- **TCP**: Reliable delivery with newline-delimited framing (RFC 5425). Auto-reconnects on failure with buffering during reconnection (up to 1000 messages).
|
|
54
|
+
- **Unix**: Same as TCP but over a Unix domain socket (e.g., `/dev/log`).
|
|
55
|
+
|
|
56
|
+
## Documentation
|
|
57
|
+
|
|
58
|
+
Full documentation at [orgloop.ai](https://orgloop.ai)
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orgloop/logger-syslog",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "OrgLoop syslog logger — RFC 5424 for enterprise/unix deployments",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"types": "dist/index.d.ts",
|
|
8
8
|
"dependencies": {
|
|
9
|
-
"@orgloop/sdk": "0.1.
|
|
9
|
+
"@orgloop/sdk": "0.1.3"
|
|
10
10
|
},
|
|
11
11
|
"orgloop": {
|
|
12
12
|
"type": "logger",
|