sendnrw/windows_exporter
2
0
Fork 0
mirror of https://github.com/prometheus-community/windows_exporter.git synced 2026-03-05 18:16:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix incorrect metric prefix in update collector documentation (#1985)

Browse Source 
Signed-off-by: Melody Sofia Eroshevich <se@cloudeteer.de>
This commit is contained in:
Melo
2025-04-09 16:49:40 +02:00
committed by GitHub
parent cb1769cacc
commit 415c134f70
1 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/collector.update.md
View File

@@ -11,8 +11,12 @@ The Windows Update service is responsible for managing the installation of updat
| Data source | Windows Update service | | Data source | Windows Update service |
| Enabled by default? | No | | Enabled by default? | No |
## Flags ## Flags
> [!NOTE]
> The collector name used in the CLI flags is `updates`, while the metric prefix is `update`. This naming mismatch is known and intentional for compatibility reasons.
### `--collector.updates.online` ### `--collector.updates.online`
Whether to search for updates online. If set to `false`, the collector will only list updates that are already found by the Windows Update service. Whether to search for updates online. If set to `false`, the collector will only list updates that are already found by the Windows Update service.
Set to `true` to search for updates online, which will take longer to complete. Set to `true` to search for updates online, which will take longer to complete.
@@ -22,23 +26,23 @@ Define the interval of scraping Windows Update information
## Metrics ## Metrics
| Name | Description | Type | Labels | | Name | Description | Type | Labels |
|--------------------------------|-----------------------------------------------|-------|-------------------------------| |--------------------------------|-------------------------------------------------------------|-------|-------------------------------|
| `windows_updates_pending_info` | Expose information single pending update item | gauge | `category`,`severity`,`title` | | `windows_update_pending_info` | Expose information for a single pending update item | gauge | `category`,`severity`,`title` |
| `windows_updates_scrape_query_duration_seconds` | Duration of the last scrape query to the Windows Update API | gauge | | | `windows_update_scrape_query_duration_seconds` | Duration of the last scrape query to the Windows Update API | gauge | |
| `windows_updates_scrape_timestamp_seconds` | Timestamp of the last scrape | gauge | | | `windows_update_scrape_timestamp_seconds` | Timestamp of the last scrape | gauge | |
### Example metrics ### Example metrics
``` ```
# HELP windows_updates_pending Pending Windows Updates # HELP windows_update_pending Pending Windows Updates
# TYPE windows_updates_pending gauge # TYPE windows_update_pending gauge
windows_updates_pending{category="Drivers",severity="",title="Intel Corporation - Bluetooth - 23.60.5.10"} 1 windows_update_pending{category="Drivers",severity="",title="Intel Corporation - Bluetooth - 23.60.5.10"} 1
# HELP windows_updates_scrape_query_duration_seconds Duration of the last scrape query to the Windows Update API # HELP windows_update_scrape_query_duration_seconds Duration of the last scrape query to the Windows Update API
# TYPE windows_updates_scrape_query_duration_seconds gauge # TYPE windows_update_scrape_query_duration_seconds gauge
windows_updates_scrape_query_duration_seconds 2.8161838 windows_update_scrape_query_duration_seconds 2.8161838
# HELP windows_updates_scrape_timestamp_seconds Timestamp of the last scrape # HELP windows_update_scrape_timestamp_seconds Timestamp of the last scrape
# TYPE windows_updates_scrape_timestamp_seconds gauge # TYPE windows_update_scrape_timestamp_seconds gauge
windows_updates_scrape_timestamp_seconds 1.727539734e+09 windows_update_scrape_timestamp_seconds 1.727539734e+09
``` ```
## Useful queries ## Useful queries