Updated documentation for OshiSysMonitor by hardikbajaj · Pull Request #14799 · apache/druid

hardikbajaj · 2023-08-11T11:54:33Z

Fixes #14359

Description

Updates documentation for OshiSysMontior

Fixed the bug ...

Renamed the class ...

Added a forbidden-apis entry ...

Release note

Key changed/added classes in this PR

This PR has:

hardikbajaj · 2023-08-11T12:07:32Z

I didn't noticed wrong formatter formatted this file on my local :( . I'll get back with updated documentation

abhishekagarwal87 · 2023-08-14T08:57:19Z

docs/operations/metrics.md

-The `taskIngestionMode` dimension includes the following modes: 
-* `APPEND`: a native ingestion job appending to existing segments 
+The `taskIngestionMode` dimension includes the following modes:
+


can you revert this formatting change?

This blank line is coming again with auto formatting. Do you want me to remove this ?

ektravel · 2023-08-21T16:48:39Z

docs/operations/metrics.md



-You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring query execution, ingestion, coordination, and so on.
+You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring


Suggested change

You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring

You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring query execution, ingestion, coordination, and so on.

ektravel · 2023-08-21T16:48:49Z

docs/operations/metrics.md


-You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring query execution, ingestion, coordination, and so on.
+You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring
+query execution, ingestion, coordination, and so on.


Remove line 27.

ektravel · 2023-08-21T16:49:06Z

docs/operations/metrics.md

 ### Router
-|Metric|Description|Dimensions|Normal value|
+
+|Metric|Description|Dimensions|Normal Value|


ektravel · 2023-08-21T16:49:48Z

docs/operations/metrics.md

 #### Memcached only metrics

-Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to from the cache retrieval layer.
+Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to


Suggested change

Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to

Memcached client metrics are reported as per the following. These metrics come directly from the client.

ektravel · 2023-08-21T16:49:58Z

docs/operations/metrics.md


-Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to from the cache retrieval layer.
+Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to
+from the cache retrieval layer.


Remove line 141.

ektravel · 2023-08-21T16:51:09Z

docs/operations/metrics.md

-|`true`|`true `|Invalid combination, exception thrown.|
-|`false`|`false`|`REPLACE_LEGACY`. The default for JSON-based batch ingestion. |
-|`false`|`true`|`REPLACE`|
+| `isAppendToExisting` | `isDropExisting` | mode |


ektravel · 2023-08-21T16:51:52Z

docs/operations/metrics.md

-|`false`|`false`|`REPLACE_LEGACY`. The default for JSON-based batch ingestion. |
-|`false`|`true`|`REPLACE`|
+| `isAppendToExisting` | `isDropExisting` | mode |
+|----------------------|-------------------|------|


Suggested change

|----------------------|-------------------|------|

|--------------------|----------------|----|

ektravel · 2023-08-21T16:52:17Z

docs/operations/metrics.md

-|`false`|`true`|`REPLACE`|
+| `isAppendToExisting` | `isDropExisting` | mode |
+|----------------------|-------------------|------|
+| `true`               | `false` | `APPEND`|


ektravel · 2023-08-21T16:52:55Z

docs/operations/metrics.md

+| `isAppendToExisting` | `isDropExisting` | mode |
+|----------------------|-------------------|------|
+| `true`               | `false` | `APPEND`|
+| `true`               | `true  ` | Invalid combination, exception thrown. |


ektravel · 2023-08-21T16:53:32Z

docs/operations/metrics.md

+|----------------------|-------------------|------|
+| `true`               | `false` | `APPEND`|
+| `true`               | `true  ` | Invalid combination, exception thrown. |
+| `false`              | `false` | `REPLACE_LEGACY` (this is the default for native batch ingestion). |


ektravel · 2023-08-21T16:53:52Z

docs/operations/metrics.md

+| `true`               | `false` | `APPEND`|
+| `true`               | `true  ` | Invalid combination, exception thrown. |
+| `false`              | `false` | `REPLACE_LEGACY` (this is the default for native batch ingestion). |
+| `false`              | `true` | `REPLACE`|


ektravel · 2023-08-21T16:54:28Z

docs/operations/metrics.md

-|`ingest/handoff/time`|Total number of milliseconds taken to handoff a set of segments.|`dataSource`, `taskId`, `taskType`, `groupId`, `tags`|Depends on the coordinator cycle time.|
-|`ingest/handoff/time`|Total number of milliseconds taken to handoff a set of segments.|`dataSource`, `taskId`, `taskType`, `groupId`, `tags`|Depends on the coordinator cycle time.|
-If the JVM does not support CPU time measurement for the current thread, `ingest/merge/cpu` and `ingest/persists/cpu` will be 0.
+|`ingest/handoff/time`|Total number of milliseconds taken to handoff a set of segments.|`dataSource`, `taskId`, `taskType`, `groupId`, `tags`|Depends on coordinator cycle time.|


ektravel · 2023-08-21T16:55:55Z

docs/operations/metrics.md


-The shuffle metrics can be enabled by adding `org.apache.druid.indexing.worker.shuffle.ShuffleMonitor` in `druid.monitoring.monitors`
+The shuffle metrics can be enabled by adding `org.apache.druid.indexing.worker.shuffle.ShuffleMonitor`
+in `druid.monitoring.monitors`


Suggested change

in `druid.monitoring.monitors`

in `druid.monitoring.monitors`.

ektravel · 2023-08-21T16:56:06Z

docs/operations/metrics.md

-The shuffle metrics can be enabled by adding `org.apache.druid.indexing.worker.shuffle.ShuffleMonitor` in `druid.monitoring.monitors`
+The shuffle metrics can be enabled by adding `org.apache.druid.indexing.worker.shuffle.ShuffleMonitor`
+in `druid.monitoring.monitors`
 See [Enabling Metrics](../configuration/index.md#enabling-metrics) for more details.


Suggested change

See [Enabling Metrics](../configuration/index.md#enabling-metrics) for more details.

See [Enabling metrics](../configuration/index.md#enabling-metrics) for more details.

ektravel · 2023-08-21T17:23:02Z

docs/operations/metrics.md

-## Sys
+## Sys [Deprecated]
+
+> SysMonitor will be deprecated due to its reliance on the sigar library, which is no longer maintained.


Suggested change

> SysMonitor will be deprecated due to its reliance on the sigar library, which is no longer maintained.

> SysMonitor is now deprecated and will be removed in future releases.

ektravel · 2023-08-21T17:29:05Z

docs/operations/metrics.md

+## 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


Suggested change

> A new Monitor called [OshiSysMonitor](#oshisysmonitor), which provides similar functionality but is based on the oshi

> Instead, use the new OSHI monitor called [OshiSysMonitor](#oshisysmonitor). The new monitor has a wider support for different machine architectures including ARM instances.

ektravel · 2023-08-21T17:29:54Z

docs/operations/metrics.md

+
+> 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.


Remove line 415.

ektravel · 2023-08-21T17:31:23Z

docs/operations/metrics.md

-|`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|


If SysMonitor is deprecated, should these metrics be removed?

Also, please fix the table formatting. Do not add whitespace to make columns longer. Trim excessive white space between columns.

ektravel · 2023-08-21T17:31:54Z

docs/operations/metrics.md

+
+These metrics are only available if the `OshiSysMonitor` module is included.
+
+| Metric                     | Description                                                                          | Dimensions                           | Normal Value        |


Please fix the table formatting.

Do not add whitespace to make columns longer. Trim excessive white space between columns.

ektravel · 2023-08-21T17:32:35Z

website/.spelling

 org.apache.druid.jetty.RequestLog
 org.apache.hadoop
 overlord.html
+oshi


Suggested change

oshi

OSHI

ektravel · 2023-08-21T17:32:51Z

website/.spelling

 sql
 sqlQuery
 successfulSending
+sigar


Suggested change

sigar

[S]igar

ektravel

Reviewed documentation portion of the PR.

hardikbajaj · 2023-08-28T05:15:09Z

@ektravel @abhishekagarwal87 , This PR got closed accidentally, I have moved it to a new PR now #14912 and addressed all the comments there.

github-actions bot added the Area - Documentation label Aug 11, 2023

hardikbajaj force-pushed the master branch from e7f161b to 6e43233 Compare August 13, 2023 18:37

abhishekagarwal87 reviewed Aug 14, 2023

View reviewed changes

ektravel reviewed Aug 21, 2023

View reviewed changes

website/.spelling Outdated

sql

sqlQuery

successfulSending

sigar

Copy link
Copy Markdown

Contributor

ektravel Aug 21, 2023

Choose a reason for hiding this comment

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

Suggested change

sigar

[S]igar

ektravel reviewed Aug 21, 2023

View reviewed changes

hardikbajaj closed this Aug 27, 2023

hardikbajaj force-pushed the master branch from 9813a6a to 9fcbf05 Compare August 27, 2023 16:25

hardikbajaj mentioned this pull request Aug 27, 2023

Updated documentation for OshiSysMonitor #14912

Merged

10 tasks



		You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring query execution, ingestion, coordination, and so on.
		You can configure Druid to [emit metrics](../configuration/index.md#enabling-metrics) that are essential for monitoring

	\|Metric\|Description\|Dimensions\|Normal Value\|
	\|Metric\|Description\|Dimensions\|Normal value\|

	Memcached client metrics are reported as per the following. These metrics come directly from the client as opposed to
	Memcached client metrics are reported as per the following. These metrics come directly from the client.

	\| `isAppendToExisting` \| `isDropExisting` \| mode \|
	\|`isAppendToExisting`\|`isDropExisting`\|mode\|

	\|----------------------\|-------------------\|------\|
	\|--------------------\|----------------\|----\|

	\| `true` \| `true ` \| Invalid combination, exception thrown. \|
	\|`true`\|`true`\|Invalid combination, exception thrown.\|

	\| `false` \| `false` \| `REPLACE_LEGACY` (this is the default for native batch ingestion). \|
	\|`false`\|`false`\|`REPLACE_LEGACY` (This is the default for native batch ingestion.)\|

	\|`ingest/handoff/time`\|Total number of milliseconds taken to handoff a set of segments.\|`dataSource`, `taskId`, `taskType`, `groupId`, `tags`\|Depends on coordinator cycle time.\|
	\|`ingest/handoff/time`\|Total number of milliseconds taken to handoff a set of segments.\|`dataSource`, `taskId`, `taskType`, `groupId`, `tags`\|Depends on the coordinator cycle time.\|

	in `druid.monitoring.monitors`
	in `druid.monitoring.monitors`.

	See [Enabling Metrics](../configuration/index.md#enabling-metrics) for more details.
	See [Enabling metrics](../configuration/index.md#enabling-metrics) for more details.

	> SysMonitor will be deprecated due to its reliance on the sigar library, which is no longer maintained.
	> SysMonitor is now deprecated and will be removed in future releases.

	> A new Monitor called [OshiSysMonitor](#oshisysmonitor), which provides similar functionality but is based on the oshi
	> Instead, use the new OSHI monitor called [OshiSysMonitor](#oshisysmonitor). The new monitor has a wider support for different machine architectures including ARM instances.


		These metrics are only available if the `OshiSysMonitor` module is included.

		\| Metric \| Description \| Dimensions \| Normal Value \|

Conversation

hardikbajaj commented Aug 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Fixed the bug ...

Renamed the class ...

Added a forbidden-apis entry ...

Release note

Key changed/added classes in this PR

Uh oh!

hardikbajaj commented Aug 11, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ektravel Aug 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ektravel left a comment

Choose a reason for hiding this comment

Uh oh!

hardikbajaj commented Aug 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hardikbajaj commented Aug 11, 2023 •

edited

Loading

ektravel Aug 21, 2023 •

edited

Loading