You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update host-otel-collector documentation for OneUptime Host Collector installation on Windows
- Changed instructions to download and install OneUptime Host Collector instead of otelcol-contrib.
- Updated paths and configuration file locations to reflect the new collector.
- Added details on enabling the windows_service receiver in the configuration.
- Clarified that the windows_service receiver is included in OneUptime Host Collector and not in the upstream otelcol-contrib.
- Provided YAML configuration examples for metrics pipelines including the windows_service receiver.
- Updated service registration commands to reflect the new collector name and paths.
Copy file name to clipboardExpand all lines: App/FeatureSet/Docs/Content/nl/telemetry/host-otel-collector.md
+31-57Lines changed: 31 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,35 +268,30 @@ Om een aangepast of applicatiespecifiek kanaal te lezen (alles wat je kunt zien
268
268
269
269
Het host-tabblad **Services** wordt gevoed door de [`windowsservicereceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/windowsservicereceiver) (configuratietype `windows_service`), die de actieve status en het opstarttype van Windows-services als metrieken rapporteert.
270
270
271
-
> **Deze receiver is _niet_ inbegrepen in de upstream voorgebouwde `otelcol-contrib`-binary.** Hoewel zijn metadata de `contrib`-distributie declareert, is hij niet toegevoegd aan het contrib-release-manifest, dus de officiële voorgebouwde collector die je in Stap 1 hebt geïnstalleerd bevat hem niet. `windows_service` toevoegen aan die collector mislukt bij het opstarten met `'receivers' unknown type: "windows_service"` — en **geen enkele versie-upgrade lost dit op**, omdat hij in geen enkele uitgebrachte `otelcol-contrib`-build wordt meegeleverd. De receiver is bovendien **alpha** en **alleen voor Windows**.
271
+
**De OneUptime Host Collector (geïnstalleerd in Stap 1, de standaard op Windows) bevat deze receiver al.** Schakel hem in je `config.yaml` in en voeg hem toe aan de metrieken-pipeline:
272
272
273
-
Je hebt twee manieren om een collector te krijgen die hem bevat. Als je geen per-service-status nodig hebt, kun je dit helemaal overslaan — host-metrieken, Windows Event Logs en al het andere werken met de standaard-collector.
274
-
275
-
#### Optie A — Gebruik de OneUptime Host Collector (aanbevolen)
276
-
277
-
OneUptime publiceert een voorgebouwde collector — de **OneUptime Host Collector** — die `windows_service` al bevat (plus `hostmetrics`, `windowseventlog`, `filelog` en de OTLP-exporter). Geen Go-toolchain of bouwen vereist.
278
-
279
-
1. Download het Windows-asset van de [OneUptime releasespagina](https://github.com/OneUptime/oneuptime/releases) — ofwel `oneuptime-host-collector_windows_amd64.zip` (of `_arm64.zip`) of de `oneuptime-host-collector-amd64.msi`-installer.
280
-
2. Pak uit naar `C:\Program Files\OneUptimeHostCollector\` (de MSI installeert het daar voor je). Het archief levert een `config.yaml` die `windows_service` al inschakelt.
281
-
3. Bewerk `config.yaml` en stel je `x-oneuptime-token` in (en de endpoint als je zelf host).
282
-
4. Registreer en start het als een Windows-service vanuit een **verhoogde** PowerShell-prompt:
# Collect every service by default. To cut volume — and avoid the
278
+
# "access denied" noise from services the collector can't open —
279
+
# list just the ones you care about:
280
+
# include_services: [Spooler, W3SVC, MSSQLSERVER]
281
+
# Or collect everything except a few:
282
+
# exclude_services: [TrustedInstaller]
289
283
290
-
sc.exe start "OneUptimeHostCollector"
284
+
service:
285
+
pipelines:
286
+
metrics:
287
+
receivers: [hostmetrics, windows_service]
291
288
```
292
289
293
-
Het draait als `LocalSystem` (de standaard van `sc.exe`) zodat het elke service kan lezen. Het tabblad **Services** vult automatisch zodra metrieken binnenkomen. Dit is ook dezelfde collector voor Linux/macOS (die assets laten alleen de Windows-only receiver weg).
294
-
295
-
#### Optie B — Bouw je eigen met `ocb`
290
+
De receiver zendt één `windows.service.status`-gauge per service uit — de integer is de Win32-servicestatus (`4` = actief, `1` = gestopt) — met de attributen `name` en `startup_mode`. Draai de collector als `LocalSystem` (de standaard van `sc.exe`) zodat hij elke service kan lezen; elke service die hij niet kan openen, wordt overgeslagen. De receiver is **alpha** en **alleen voor Windows**; bekende problemen zijn onder andere een scrape-fout die de collector kan laten crashen en een `access denied` op één service die andere services beïnvloedt — beperk tot `include_services` als je hier tegenaan loopt.
296
291
297
-
Als je liever je eigen collector bouwt (of al een aangepaste distributie draait), compileer er dan een met de [OpenTelemetry Collector Builder (`ocb`)](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder).
292
+
#### Liever de upstream collector gebruiken?
298
293
299
-
**1. Bouw een aangepaste collector met `ocb`.** Maak`builder-config.yaml` (houd elke versie op dezelfde collector-release):
294
+
De upstream voorgebouwde `otelcol-contrib`-binary bevat `windowsservicereceiver` **niet** — `windows_service` toevoegen mislukt bij het opstarten met `'receivers' unknown type: "windows_service"`, en **geen enkele versie-upgrade lost dit op** (hij zit in geen enkele uitgebrachte `otelcol-contrib`-build). Schakel ofwel over naar de OneUptime Host Collector (Stap 1), of bouw je eigen met de [OpenTelemetry Collector Builder (`ocb`)](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder) — maak `builder-config.yaml` (houd elke versie op dezelfde collector-release):
Bouw hem vervolgens (vereist Go) — de uitvoer is één enkele `otelcol-oneuptime.exe` die je in plaats van `otelcol-contrib` draait:
323
-
324
317
```powershell
325
318
go install go.opentelemetry.io/collector/cmd/builder@v0.154.0
326
319
builder --config builder-config.yaml
327
320
```
328
321
329
-
**2. Schakel de receiver in** in je `config.yaml` en voeg hem toe aan de metrieken-pipeline:
330
-
331
-
```yaml
332
-
receivers:
333
-
windows_service:
334
-
collection_interval: 30s
335
-
# Collect every service by default. To cut volume — and avoid the
336
-
# "access denied" noise from services the collector can't open —
337
-
# list just the ones you care about:
338
-
# include_services: [Spooler, W3SVC, MSSQLSERVER]
339
-
# Or collect everything except a few:
340
-
# exclude_services: [TrustedInstaller]
341
-
342
-
service:
343
-
pipelines:
344
-
metrics:
345
-
receivers: [hostmetrics, windows_service]
346
-
```
347
-
348
-
De receiver zendt één `windows.service.status`-gauge per service uit — de integer is de Win32-servicestatus (`4` = actief, `1` = gestopt) — met de attributen `name` en `startup_mode`. Draai de collector als `LocalSystem` (de standaard met `sc.exe create`) zodat hij elke service kan lezen; elke service die hij niet kan openen, wordt overgeslagen. Omdat de receiver alpha is, pin en test de versie vóór productie — bekende problemen zijn onder andere een scrape-fout die de collector kan laten crashen en een `access denied` op één service die andere services beïnvloedt; beperk tot `include_services` als je hier tegenaan loopt.
322
+
Draai vervolgens de resulterende `otelcol-oneuptime.exe` en schakel `windows_service` in zoals hierboven getoond.
sc.exe description "otelcol-contrib" "Collects host telemetry and forwards it to OneUptime over OTLP."
556
+
sc.exe description "OneUptimeHostCollector" "Collects host telemetry and forwards it to OneUptime over OTLP."
583
557
584
-
sc.exe start "otelcol-contrib"
585
-
sc.exe query "otelcol-contrib"
558
+
sc.exe start "OneUptimeHostCollector"
559
+
sc.exe query "OneUptimeHostCollector"
586
560
```
587
561
588
-
De service draait standaard onder `LocalSystem`, dat de rechten heeft die nodig zijn om het `Security`-kanaal van de Windows Event Log te lezen.
562
+
De service draait standaard onder `LocalSystem`, dat de rechten heeft die nodig zijn om het `Security`-kanaal van de Windows Event Log en elke Windows-service te lezen.
Copy file name to clipboardExpand all lines: App/FeatureSet/Docs/Content/no/telemetry/host-otel-collector.md
+30-56Lines changed: 30 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,35 +268,30 @@ For a lese en egendefinert eller applikasjonsspesifikk kanal (alt du kan se unde
268
268
269
269
Host-fanen **Services** drives av [`windowsservicereceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/windowsservicereceiver) (konfigtype `windows_service`), som rapporterer kjoretilstanden og oppstartstypen til Windows-tjenester som metrikker.
270
270
271
-
> **Denne receiveren er _ikke_ inkludert i den oppstroms forhandsbygde `otelcol-contrib`-binaerfilen.** Selv om metadataene dens erklaerer `contrib`-distribusjonen, har den ikke blitt lagt til i contrib-utgivelsesmanifestet, sa den offisielle forhandsbygde collectoren du installerte i Trinn 1 inneholder den ikke. A legge til `windows_service` i den collectoren feiler ved oppstart med `'receivers' unknown type: "windows_service"` — og **ingen versjonsoppgradering loser dette**, fordi den ikke leveres i noen utgitt `otelcol-contrib`-bygg. Receiveren er ogsa **alpha** og **kun for Windows**.
271
+
**OneUptime Host Collector (installert i Trinn 1, standarden pa Windows) inkluderer allerede denne receiveren.** Aktiver den i `config.yaml`-en din og legg den til i metrikk-pipelinen:
272
272
273
-
Du har to mater a fa en collector som inkluderer den pa. Hvis du ikke trenger status per tjeneste, kan du hoppe over dette helt — host-metrikker, Windows Event Logs og alt annet fungerer med standard-collectoren.
274
-
275
-
#### Alternativ A — Bruk OneUptime Host Collector (anbefalt)
276
-
277
-
OneUptime publiserer en forhandsbygd collector — **OneUptime Host Collector** — som allerede inkluderer `windows_service` (i tillegg til `hostmetrics`, `windowseventlog`, `filelog` og OTLP-eksportoren). Ingen Go-verktoykjede eller bygging kreves.
278
-
279
-
1. Last ned Windows-asseten fra [OneUptime-utgivelsessiden](https://github.com/OneUptime/oneuptime/releases) — enten `oneuptime-host-collector_windows_amd64.zip` (eller `_arm64.zip`) eller `oneuptime-host-collector-amd64.msi`-installasjonsprogrammet.
280
-
2. Pakk ut til `C:\Program Files\OneUptimeHostCollector\` (MSI-en installerer der for deg). Arkivet leveres med en `config.yaml` som allerede aktiverer `windows_service`.
281
-
3. Rediger `config.yaml` og sett din `x-oneuptime-token` (og endepunktet hvis du selvhoster).
282
-
4. Registrer og start den som en Windows-tjeneste fra en **forhoyet** PowerShell-ledetekst:
# Collect every service by default. To cut volume — and avoid the
278
+
# "access denied" noise from services the collector can't open —
279
+
# list just the ones you care about:
280
+
# include_services: [Spooler, W3SVC, MSSQLSERVER]
281
+
# Or collect everything except a few:
282
+
# exclude_services: [TrustedInstaller]
289
283
290
-
sc.exe start "OneUptimeHostCollector"
284
+
service:
285
+
pipelines:
286
+
metrics:
287
+
receivers: [hostmetrics, windows_service]
291
288
```
292
289
293
-
Den kjorer som `LocalSystem` (`sc.exe`-standarden) slik at den kan lese alle tjenester. Fanen **Services** fylles automatisk nar metrikker ankommer. Dette er den samme collectoren for Linux/macOS ogsa (de assetene utelater bare den Windows-spesifikke receiveren).
294
-
295
-
#### Alternativ B — Bygg din egen med `ocb`
290
+
Receiveren sender ut en `windows.service.status`-gauge per tjeneste — heltallet er Win32-tjenestetilstanden (`4` = kjorer, `1` = stoppet) — med attributtene `name` og `startup_mode`. Kjor collectoren som `LocalSystem` (`sc.exe`-standarden) slik at den kan lese alle tjenester; de den ikke klarer a apne, hoppes over. Receiveren er **alpha** og **kun for Windows**; kjente problemer inkluderer en scrape-feil som kan krasje collectoren og en `access denied` pa en tjeneste som pavirker andre — begrens til `include_services` hvis du treffer pa dem.
296
291
297
-
Hvis du heller vil bygge din egen collector (eller allerede kjorer en egendefinert distribusjon), kompiler en med [OpenTelemetry Collector Builder (`ocb`)](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder).
292
+
#### Bruker du det oppstroms collectoren i stedet?
298
293
299
-
**1. Bygg en egendefinert collector med `ocb`.** Opprett`builder-config.yaml` (hold alle versjoner pa samme collector-utgave):
294
+
Det oppstroms forhandsbygde `otelcol-contrib`-binaerfilen inkluderer **ikke** `windowsservicereceiver` — a legge til `windows_service` feiler ved oppstart med `'receivers' unknown type: "windows_service"`, og **ingen versjonsoppgradering loser dette** (den finnes ikke i noe utgitt `otelcol-contrib`-bygg). Bytt enten til OneUptime Host Collector (Trinn 1), eller bygg din egen med [OpenTelemetry Collector Builder (`ocb`)](https://github.com/open-telemetry/opentelemetry-collector/tree/main/cmd/builder) — opprett `builder-config.yaml` (hold alle versjoner pa samme collector-utgave):
Bygg den deretter (krever Go) — utdataet er en enkelt `otelcol-oneuptime.exe` som du kjorer i stedet for `otelcol-contrib`:
323
-
324
317
```powershell
325
318
go install go.opentelemetry.io/collector/cmd/builder@v0.154.0
326
319
builder --config builder-config.yaml
327
320
```
328
321
329
-
**2. Aktiver receiveren** i `config.yaml`-en din og legg den til i metrikk-pipelinen:
330
-
331
-
```yaml
332
-
receivers:
333
-
windows_service:
334
-
collection_interval: 30s
335
-
# Collect every service by default. To cut volume — and avoid the
336
-
# "access denied" noise from services the collector can't open —
337
-
# list just the ones you care about:
338
-
# include_services: [Spooler, W3SVC, MSSQLSERVER]
339
-
# Or collect everything except a few:
340
-
# exclude_services: [TrustedInstaller]
341
-
342
-
service:
343
-
pipelines:
344
-
metrics:
345
-
receivers: [hostmetrics, windows_service]
346
-
```
347
-
348
-
Receiveren sender ut en `windows.service.status`-gauge per tjeneste — heltallet er Win32-tjenestetilstanden (`4` = kjorer, `1` = stoppet) — med attributtene `name` og `startup_mode`. Kjor collectoren som `LocalSystem` (standarden med `sc.exe create`) slik at den kan lese alle tjenester; de den ikke klarer a apne, hoppes over. Fordi receiveren er alpha, fest og test versjonen for produksjon — kjente problemer inkluderer en scrape-feil som kan krasje collectoren og en `access denied` pa en tjeneste som pavirker andre; begrens til `include_services` hvis du treffer pa dem.
322
+
Kjor deretter den resulterende `otelcol-oneuptime.exe` og aktiver `windows_service` som vist ovenfor.
0 commit comments