Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update sysmon to oshisysmon in reference docs #15258

Closed
wants to merge 6 commits into from
Closed

docs: update sysmon to oshisysmon in reference docs #15258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a53267b
docs: update sysmon to oshisysmon in reference docs
317brian Oct 25, 2023
74f1bca
add back sysmon w/ blurb that it is deprecated
317brian Oct 26, 2023
6a2f2b7
Apply suggestions from code review
317brian Oct 27, 2023
969e0a6
Merge branch 'master' into update-metrics-monitor-docs
317brian Nov 8, 2023
ad1bfb3
update spelling file
317brian Nov 15, 2023
4096c9a
Merge branch 'master' into update-metrics-monitor-docs
317brian Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/configuration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ There are four JVM parameters that we set on all of our services:
- The temp directory should not be volatile tmpfs.
- This directory should also have good read and write speed.
- Avoid NFS mount.
- The `org.apache.druid.java.util.metrics.SysMonitor` requires execute privileges on files in `java.io.tmpdir`. If you are using the system monitor, do not set `java.io.tmpdir` to `noexec`.
- The `org.apache.druid.java.util.metrics.OshiSysMonitor` and `org.apache.druid.java.util.metrics.SysMonitor` both require execute privileges on files in `java.io.tmpdir`. If you are using the system monitor, do not set `java.io.tmpdir` to `noexec`. Note that SysMonitor is deprecated. We recommend using OshiSysMonitor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hardikbajaj - do you know if the OshiSysMonitor needs this privilege?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hardikbajaj ping

- `-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager` This allows log4j2 to handle logs for non-log4j2 components (like jetty) which use standard java logging.

### Extensions
Expand Down Expand Up @@ -387,8 +387,9 @@ Metric monitoring is an essential part of Druid operations. The following monito

|Name|Description|
|----|-----------|
|`org.apache.druid.client.cache.CacheMonitor`|Emits metrics (to logs) about the segment results cache for Historical and Broker services. Reports typical cache statistics include hits, misses, rates, and size (bytes and number of entries), as well as timeouts and and errors.|
|`org.apache.druid.java.util.metrics.SysMonitor`|Reports on various system activities and statuses using the [SIGAR library](https://github.com/hyperic/sigar). Requires execute privileges on files in `java.io.tmpdir`. Do not set `java.io.tmpdir` to `noexec` when using `SysMonitor`.|
|`org.apache.druid.client.cache.CacheMonitor`|Emits metrics (to logs) about the segment results cache for Historical and Broker processes. Reports typical cache statistics include hits, misses, rates, and size (bytes and number of entries), as well as timeouts and and errors.|
|`org.apache.druid.java.util.metrics.SysMonitor`| Deprecated. Use OshiSysMonitor instead. Reports on various system activities and statuses using the [SIGAR library](https://github.com/hyperic/sigar). Requires execute privileges on files in `java.io.tmpdir`. Do not set `java.io.tmpdir` to `noexec` when using SysMonitor.|
|`org.apache.druid.java.util.metrics.OshiSysMonitor`|Reports on various system activities and statuses using the [OSHI JNA-based library](https://github.com/oshi/oshi). Requires execute privileges on files in `java.io.tmpdir`. Do not set `java.io.tmpdir` to `noexec` when using `OshiSysMonitor`.|
|`org.apache.druid.java.util.metrics.JvmMonitor`|Reports various JVM-related statistics.|
|`org.apache.druid.java.util.metrics.JvmCpuMonitor`|Reports statistics of CPU consumption by the JVM.|
|`org.apache.druid.java.util.metrics.CpuAcctDeltaMonitor`|Reports consumed CPU as per the cpuacct cgroup.|
Expand All @@ -410,7 +411,7 @@ Metric monitoring is an essential part of Druid operations. The following monito
For example, you might configure monitors on all services for system and JVM information within `common.runtime.properties` as follows:

```
druid.monitoring.monitors=["org.apache.druid.java.util.metrics.SysMonitor","org.apache.druid.java.util.metrics.JvmMonitor"]
druid.monitoring.monitors=["org.apache.druid.java.util.metrics.OshiSysMonitor","org.apache.druid.java.util.metrics.JvmMonitor"]
```

You can override cluster-wide configuration by amending the `runtime.properties` of individual services.
Expand Down
1 change: 1 addition & 0 deletions website/.spelling
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ JKS
jks
JMX
JRE
JNA-based
JS
JSON
JsonPath
Expand Down