Update documentation (#20380)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
thiagoftsm committed
May 30, 2025 at 06:48 UTC
1a69853f031ed808a968a5662e97462458e27bf1
2 files changed
+33
-18
packaging/windows/WINDOWS_INSTALLER.md
+9
-9
@@ -120,21 +120,21 @@ Right-click on PowerShell and select "Run as administrator" before running these
120
- Stable version
121
122
```powershell
123
- New-Item -Path "$env:PROGRAMDATA\netdata" -ItemType Directory -Force
123
+ New-Item -Path "$env:PROGRAMDATA\Netdata" -ItemType Directory -Force
124
@'
125
- Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\netdata\netdata-x64.msi
126
- msiexec /qn /i $env:PROGRAMDATA\netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
127
- '@ | Out-File -FilePath "$env:PROGRAMDATA\netdata\netdata-updater.ps1" -Encoding UTF8
125
+ Invoke-WebRequest https://github.com/netdata/netdata/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\Netdata\netdata-x64.msi
126
+ msiexec /qn /i $env:PROGRAMDATA\Netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
127
+ '@ | Out-File -FilePath "$env:PROGRAMDATA\Netdata\netdata-updater.ps1" -Encoding UTF8
128
```
129
130
- Nightly version
131
132
```powershell
133
- New-Item -Path "$env:PROGRAMDATA\netdata" -ItemType Directory -Force
133
+ New-Item -Path "$env:PROGRAMDATA\Netdata" -ItemType Directory -Force
134
@'
135
- Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\netdata\netdata-x64.msi
136
- msiexec /qn /i $env:PROGRAMDATA\netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
137
- '@ | Out-File -FilePath "$env:PROGRAMDATA\netdata\netdata-updater.ps1" -Encoding UTF8
135
+ Invoke-WebRequest https://github.com/netdata/netdata-nightlies/releases/latest/download/netdata-x64.msi -OutFile $env:PROGRAMDATA\Netdata\netdata-x64.msi
136
+ msiexec /qn /i $env:PROGRAMDATA\Netdata\netdata-x64.msi TOKEN="<CLAIM_TOKEN>" ROOMS="<ROOM_ID>"
137
+ '@ | Out-File -FilePath "$env:PROGRAMDATA\Netdata\netdata-updater.ps1" -Encoding UTF8
138
```
139
140
:::info
@@ -155,7 +155,7 @@ Replace `<CLAIM_TOKEN>` with your Netdata Cloud claim token and `<ROOM_ID>` with
155
| **Triggers** | Schedule | Daily |
156
| | Time | Your preferred time (e.g., 7AM UTC) |
157
| **Actions** | Program/Script | `powershell` |
158
-| | Arguments | `-noprofile -executionpolicy bypass -file %PROGRAMDATA%\netdata\netdata-updater.ps1` |
158
+| | Arguments | `-noprofile -executionpolicy bypass -file %PROGRAMDATA%\Netdata\netdata-updater.ps1` |
159
160
:::tip
161
src/libnetdata/log/README.md
+24
-9
@@ -85,7 +85,7 @@ In `netdata.conf`, there are the following settings:
85
86
### Configuring log sources
87
88
-Each for the sources (`daemon`, `collector`, `access`, `health`), accepts the following:
88
+Each for the sources (`daemon`, `collector`, `access`, `health`), accepts the following:
89
90
```
91
source = {FORMAT},level={LEVEL},protection={LOG}/{PERIOD}@{OUTPUT}
@@ -222,6 +222,17 @@ journalctl -u netdata --namespace=netdata
222
journalctl -u netdata --namespace=netdata -r
223
```
224
225
+## Using Windows Event Viewer to View Netdata Logs
226
+
227
+The Netdata service on Windows systems automatically logs events to the Windows Event Viewer. To access these logs:
228
+
229
+1. Click the **Start** menu
230
+2. Type **Event Viewer** and select **Run as Administrator**
231
+3. In the Event Viewer window, expand **Applications and Services Logs**
232
+4. Click **Netdata**
233
+
234
+The Netdata section contains all available log categories [listed above](#log-sources).
235
+
236
## Using Event Tracing for Windows (ETW)
237
238
ETW requires the publisher `Netdata` to be registered. Our Windows installer does this automatically.
@@ -241,7 +252,7 @@ wevtutil um "%SystemRoot%\System32\wevt_netdata_manifest.xml"
252
253
The structure of the logs are as follows:
254
244
- - Publisher `Netdata`
255
+- Publisher `Netdata`
256
- Channel `Netdata/Daemon`: general messages about the Netdata service
257
- Channel `Netdata/Collector`: general messages about Netdata external plugins
258
- Channel `Netdata/Health`: alert transitions and general messages generated by Netdata's health engine
@@ -266,12 +277,12 @@ concurrently.
277
278
For WEL, Netdata logs as follows:
279
269
- - Channel `NetdataWEL` (unfortunately `Netdata` cannot be used, it conflicts with the ETW Publisher name)
270
- - Publisher `NetdataDaemon`: general messages about the Netdata service
271
- - Publisher `NetdataCollector`: general messages about Netdata external plugins
272
- - Publisher `NetdataHealth`: alert transitions and general messages generated by Netdata's health engine
273
- - Publisher `NetdataAccess`: all accesses to Netdata APIs
274
- - Publisher `NetdataAclk`: for Cloud connectivity tracing (disabled by default)
280
+- Channel `NetdataWEL` (unfortunately `Netdata` cannot be used, it conflicts with the ETW Publisher name)
281
+ - Publisher `NetdataDaemon`: general messages about the Netdata service
282
+ - Publisher `NetdataCollector`: general messages about Netdata external plugins
283
+ - Publisher `NetdataHealth`: alert transitions and general messages generated by Netdata's health engine
284
+ - Publisher `NetdataAccess`: all accesses to Netdata APIs
285
+ - Publisher `NetdataAclk`: for Cloud connectivity tracing (disabled by default)
286
287
Publishers must have unique names system-wide, so we had to prefix them with `Netdata`.
288
@@ -288,6 +299,7 @@ WEL does not have the problem ETW has with the percent character `%`, so Netdata
299
There are key differences between ETW and WEL.
300
301
### Publishers and Providers
302
+
303
**Publishers** are collections of ETW Providers. A Publisher is implied by a manifest file,
304
each of which is considered a Publisher, and each manifest file can define multiple **Providers** in it.
305
Other than that there is no entity related to **Publishers** in the system.
@@ -306,6 +318,7 @@ To define a **Provider**:
318
The Provider appears as `Source` in the Event Viewer, for both WEL and ETW.
319
320
### Channels
321
+
322
- **Channels** for WEL are collections of WEL Providers, (each WEL Provider is a single Stream of logs).
323
- **Channels** for ETW slice the logs of each Provider into multiple Streams.
324
@@ -318,16 +331,18 @@ a Channel may include independent WEL Providers (e.g. the "Applications" Channel
331
WEL Channels cannot include ETW Providers.
332
333
### Retention
334
+
335
Retention is always defined per Stream.
336
337
- Retention in ETW is defined per ETW Channel (ETW Provider Stream).
338
- Retention in WEL is defined per WEL Provider (each WEL Provider is a single Stream).
339
340
### Messages Formatting
341
+
342
- ETW supports recursive fields expansion, and therefore `%N` in fields is expanded recursively
343
(or replaced with an error message if expansion fails). Netdata replaces `%N` with `℅N` to stop
344
recursive expansion (since `%N` cannot be logged otherwise).
330
-- WEL performs a single field expansion, and therefore the `%` character in fields is never expanded.
345
+- WEL performs a single field expansion, and therefore the `%` character in fields is never expanded.
346
347
### Usability
348