Repository navigation
Expand file tree
/
Copy pathdocs-pipe.html
More file actions
188 lines (175 loc) · 11.6 KB
/
Copy pathdocs-pipe.html
File metadata and controls
188 lines (175 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Pipe — LogDoc Documentation</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500;700&family=IBM+Plex+Mono&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/style.css">
</head>
<body>
<div class="page">
<!-- ============ Header ============ -->
<header class="header">
<a class="logo-group" href="index.html">
<svg width="36" height="36" viewBox="0 0 36 36">
<path d="M24.156 1.086 A18 18 0 1 0 35.727 21.126 L27.750 19.719 A9.9 9.9 0 1 1 21.386 8.697 Z" fill="#e35b28"/>
<circle cx="26.5" cy="6.5" r="4.5" fill="#ffffff"/>
</svg>
<span class="logo-text">LogDoc</span>
</a>
<nav class="nav">
<a class="w500" href="index.html">Home</a>
<a class="w500" href="topology.html">Topology</a>
<a class="orange w500" href="documentation.html">Documentation</a>
<a href="download.html">Download</a>
<a href="docs-configuration.html">Config</a>
<a href="plugins.html">Plugins</a>
<a href="contacts.html">Contacts</a>
</nav>
<div class="header-spacer"></div>
<div class="header-right">
<button class="nav-toggle" type="button" aria-label="Toggle navigation" aria-expanded="false">
<span></span><span></span><span></span>
</button>
<a class="header-cta" href="download.html">Download</a>
</div>
</header>
<!-- ============ Doc body ============ -->
<div class="doc-body">
<!-- Sidebar -->
<aside class="doc-sidebar">
<span class="doc-side-title">DOCUMENTATION</span>
<div class="doc-side-sp16"></div>
<a class="doc-side-link" href="docs-getting-started.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M12 15v5s3.03-.55 4-2c1.08-1.62 0-5 0-5"/><path d="M4.5 16.5c-1.5 1.26-2 5-2 5s3.74-.5 5-2c.71-.84.7-2.13-.09-2.91a2.18 2.18 0 0 0-2.91-.09"/><path d="M9 12a22 22 0 0 1 2-3.95A12.88 12.88 0 0 1 22 2c0 2.72-.78 7.5-6 11a22.4 22.4 0 0 1-4 2z"/><path d="M9 12H4s.55-3.03 2-4c1.62-1.08 5 .05 5 .05"/></svg>
<span>Getting Started</span>
</a>
<a class="doc-side-link" href="docs-configuration.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M9.671 4.136a2.34 2.34 0 0 1 4.659 0 2.34 2.34 0 0 0 3.319 1.915 2.34 2.34 0 0 1 2.33 4.033 2.34 2.34 0 0 0 0 3.831 2.34 2.34 0 0 1-2.33 4.033 2.34 2.34 0 0 0-3.319 1.915 2.34 2.34 0 0 1-4.659 0 2.34 2.34 0 0 0-3.32-1.915 2.34 2.34 0 0 1-2.33-4.033 2.34 2.34 0 0 0 0-3.831A2.34 2.34 0 0 1 6.35 6.051a2.34 2.34 0 0 0 3.319-1.915"/><circle cx="12" cy="12" r="3"/></svg>
<span>Configuration</span>
</a>
<a class="doc-side-link" href="docs-pipeline-architecture.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M15 6a9 9 0 0 0-9 9V3"/><circle cx="18" cy="6" r="3"/><circle cx="6" cy="18" r="3"/></svg>
<span>Pipeline Architecture</span>
</a>
<a class="doc-side-link" href="docs-plugin-sdk.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M15.39 4.39a1 1 0 0 0 1.68-.474 2.5 2.5 0 1 1 3.014 3.015 1 1 0 0 0-.474 1.68l1.683 1.682a2.414 2.414 0 0 1 0 3.414L19.61 15.39a1 1 0 0 1-1.68-.474 2.5 2.5 0 1 0-3.014 3.015 1 1 0 0 1 .474 1.68l-1.683 1.682a2.414 2.414 0 0 1-3.414 0L8.61 19.61a1 1 0 0 0-1.68.474 2.5 2.5 0 1 1-3.014-3.015 1 1 0 0 0 .474-1.68l-1.683-1.682a2.414 2.414 0 0 1 0-3.414L4.39 8.61a1 1 0 0 1 1.68.474 2.5 2.5 0 1 0 3.014-3.015 1 1 0 0 1-.474-1.68l1.683-1.682a2.414 2.414 0 0 1 3.414 0z"/></svg>
<span>Plugin SDK</span>
</a>
<a class="doc-side-link" href="docs-access-control.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z"/></svg>
<span>Access Control</span>
</a>
<div class="doc-side-sp24"></div>
<span class="doc-side-title">PIPELINE</span>
<div class="doc-side-sp16"></div>
<a class="doc-side-link" href="docs-gather.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><polyline points="22 12 16 12 14 15 10 15 8 12 2 12"/><path d="M5.45 5.11 2 12v6a2 2 0 0 0 2 2h16a2 2 0 0 0 2-2v-6l-3.45-6.89A2 2 0 0 0 16.76 4H7.24a2 2 0 0 0-1.79 1.11z"/></svg>
<span>Gather</span>
</a>
<a class="doc-side-link active" href="docs-pipe.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="18" cy="18" r="3"/><circle cx="6" cy="6" r="3"/><path d="M6 21V9a9 9 0 0 0 9 9"/></svg>
<span>Pipe</span>
</a>
<a class="doc-side-link" href="docs-sink.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><ellipse cx="12" cy="5" rx="9" ry="3"/><path d="M3 5V19A9 3 0 0 0 21 19V5"/><path d="M3 12A9 3 0 0 0 21 12"/></svg>
<span>Sink</span>
</a>
<a class="doc-side-link" href="docs-view.html">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><rect width="20" height="14" x="2" y="3" rx="2"/><line x1="8" x2="16" y1="21" y2="21"/><line x1="12" x2="12" y1="17" y2="21"/></svg>
<span>View</span>
</a>
</aside>
<!-- Main content -->
<main class="doc-main">
<div class="doc-breadcrumb">
<span>Docs</span>
<svg class="icon" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="m9 18 6-6-6-6"/></svg>
<span class="current">Pipe</span>
</div>
<div class="doc-title-section">
<h1 class="doc-title">Pipe</h1>
<p class="doc-sub">Pipe is the routing stage of the pipeline. It filters, transforms and directs events from sources to one or more sinks based on declarative rules.</p>
</div>
<div class="doc-divider"></div>
<section class="doc-section">
<h2 class="doc-h2">Filters</h2>
<p class="doc-text">Each pipe evaluates events against an ordered list of filters. An event continues down the pipe only if every filter matches:</p>
<div class="doc-list">
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Level — match by severity (debug, info, warn, error, fatal)</span>
</div>
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Field — compare structured fields against exact values or ranges</span>
</div>
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Regex — full-text patterns applied to the raw message</span>
</div>
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Rate — throttle noisy sources with events-per-second limits</span>
</div>
</div>
</section>
<section class="doc-section">
<h2 class="doc-h2">Transforms</h2>
<p class="doc-text">Between filtering and delivery, pipes can reshape events on the fly:</p>
<div class="doc-list">
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Rename, add or drop fields before delivery</span>
</div>
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Mask sensitive values such as tokens and card numbers</span>
</div>
<div class="doc-check-item">
<svg class="icon" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M20 6 9 17l-5-5"/></svg>
<span>Enrich events with static tags or lookup tables</span>
</div>
</div>
</section>
<div class="doc-divider"></div>
<section class="doc-section">
<h2 class="doc-h2">Routing Example</h2>
<p class="doc-text">Pipes connect sources to sinks. A single event can fan out to multiple sinks:</p>
<div class="doc-code">
<span class="lang">yaml</span>
<code>pipes:</code>
<code> - name: errors-to-alerts</code>
<code> from: [syslog, app-http]</code>
<code> filter:</code>
<code> level: error</code>
<code> to: [clickhouse, telegram-alerts]</code>
<code></code>
<code> - name: everything-archive</code>
<code> from: "*"</code>
<code> to: [s3-archive]</code>
</div>
</section>
<div class="doc-info-box">
<svg class="icon" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M15 14c.2-1 .7-1.7 1.5-2.5 1-.9 1.5-2.2 1.5-3.5A6 6 0 0 0 6 8c0 1 .2 2.2 1.5 3.5.7.7 1.3 1.5 1.5 2.5"/><path d="M9 18h6"/><path d="M10 22h4"/></svg>
<p>Rules are evaluated top to bottom and hot-reloaded on change. Use the web UI Pipe Inspector to trace a live event through every rule it hits.</p>
</div>
<div class="doc-pagenav doc-pagenav--flat">
<a class="doc-pagenav-item" href="docs-gather.html">
<span class="doc-pagenav-label">Previous</span>
<span class="doc-pagenav-title">Gather</span>
</a>
<a class="doc-pagenav-item next" href="docs-sink.html">
<span class="doc-pagenav-label">Next</span>
<span class="doc-pagenav-title">Sink</span>
</a>
</div>
</main>
</div>
</div>
<script src="js/site.js" defer></script>
</body>
</html>