ektravel commented on code in PR #14799:
URL: https://github.com/apache/druid/pull/14799#discussion_r1300439400
##########
docs/operations/metrics.md:
##########
@@ -402,32 +408,82 @@ The following metric is only available if the
`EventReceiverFirehoseMonitor` mod
|`ingest/events/buffered`|Number of events queued in the
`EventReceiverFirehose` buffer.|`serviceName`, `dataSource`, `taskId`,
`taskType`, `bufferCapacity`|Equal to the current number of events in the
buffer queue.|
|`ingest/bytes/received`|Number of bytes received by the
`EventReceiverFirehose`.|`serviceName`, `dataSource`, `taskId`,
`taskType`|Varies|
-## Sys
+## Sys [Deprecated]
+
+> SysMonitor will be deprecated due to its reliance on the sigar library,
which is no longer maintained.
+> A new Monitor called [OshiSysMonitor](#oshisysmonitor), which provides
similar functionality but is based on the oshi
+> library. We encourage all users to switch to OshiSysMonitor as soon as
possible.
These metrics are only available if the `SysMonitor` module is included.
-|Metric|Description|Dimensions|Normal value|
-|------|-----------|----------|------------|
-|`sys/swap/free`|Free swap||Varies|
-|`sys/swap/max`|Max swap||Varies|
-|`sys/swap/pageIn`|Paged in swap||Varies|
-|`sys/swap/pageOut`|Paged out swap||Varies|
-|`sys/disk/write/count`|Writes to disk|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
-|`sys/disk/read/count`|Reads from disk|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
-|`sys/disk/write/size`|Bytes written to disk. One indicator of the amount of
paging occurring for segments.|`fsDevName`,`fsDirName`,`fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
-|`sys/disk/read/size`|Bytes read from disk. One indicator of the amount of
paging occurring for segments.|`fsDevName`,`fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
-|`sys/net/write/size`|Bytes written to the network|`netName`, `netAddress`,
`netHwaddr`|Varies|
-|`sys/net/read/size`|Bytes read from the network|`netName`, `netAddress`,
`netHwaddr`|Varies|
-|`sys/fs/used`|Filesystem bytes used|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|< max|
-|`sys/fs/max`|Filesystem bytes max|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
-|`sys/mem/used`|Memory used||< max|
-|`sys/mem/max`|Memory max||Varies|
-|`sys/storage/used`|Disk space used|`fsDirName`|Varies|
-|`sys/cpu`|CPU used|`cpuName`, `cpuTime`|Varies|
+| Metric | Description
|Dimensions|Normal Value|
+|------------------------|--------------------------------------------------------------------------------------|----------|------------|
+| `sys/swap/free` | Free swap
||Varies|
+| `sys/swap/max` | Max swap
||Varies|
+| `sys/swap/pageIn` | Paged in swap
||Varies|
+| `sys/swap/pageOut` | Paged out swap
||Varies|
+| `sys/disk/write/count` | Writes to disk
|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
+| `sys/disk/read/count` | Reads from disk
|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
+| `sys/disk/write/size` | Bytes written to disk. One indicator of the amount
of paging occurring for segments. |`fsDevName`,`fsDirName`,`fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
+| `sys/disk/read/size` | Bytes read from disk. One indicator of the amount
of paging occurring for segments. |`fsDevName`,`fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
+| `sys/net/write/size` | Bytes written to the network
|`netName`, `netAddress`, `netHwaddr`|Varies|
+| `sys/net/read/size` | Bytes read from the network
|`netName`, `netAddress`, `netHwaddr`|Varies|
+| `sys/fs/used` | Filesystem bytes used
|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|< max|
+| `sys/fs/max` | Filesystem bytes max
|`fsDevName`, `fsDirName`, `fsTypeName`,
`fsSysTypeName`, `fsOptions`|Varies|
+| `sys/mem/used` | Memory used
||< max|
+| `sys/mem/max` | Memory max
||Varies|
+| `sys/storage/used` | Disk space used
|`fsDirName`|Varies|
+| `sys/cpu` | CPU used
|`cpuName`, `cpuTime`|Varies|
+
+## OshiSysMonitor
+
+These metrics are only available if the `OshiSysMonitor` module is included.
+
+| Metric | Description
| Dimensions |
Normal Value |
Review Comment:
Please fix the table formatting.
Do not add whitespace to make columns longer. Trim excessive white space
between columns.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
