Skip to content

add docs for TaskCountStatsMonitor #9114

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

Merged
suneet-s merged 2 commits into from
Jun 18, 2020
Merged

add docs for TaskCountStatsMonitor #9114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc6d91d
fix docs
Jan 1, 2020
caa7f89
Merge branch 'master' into docs_fix
tomscut Jan 4, 2020
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
1 change: 1 addition & 0 deletions docs/configuration/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@ The following monitors are available:
|`org.apache.druid.segment.realtime.RealtimeMetricsMonitor`|Reports statistics on Realtime processes.|
|`org.apache.druid.server.metrics.EventReceiverFirehoseMonitor`|Reports how many events have been queued in the EventReceiverFirehose.|
|`org.apache.druid.server.metrics.QueryCountStatsMonitor`|Reports how many queries have been successful/failed/interrupted.|
Copy link
Copy Markdown

@sthetland sthetland Jun 10, 2020

Choose a reason for hiding this comment

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

Suggested change
|`org.apache.druid.server.metrics.QueryCountStatsMonitor`|Reports how many queries have been successful/failed/interrupted.|
|`org.apache.druid.server.metrics.QueryCountStatsMonitor`|Reports how many queries have succeeded, failed, or were interrupted.|

|`org.apache.druid.server.metrics.TaskCountStatsMonitor`|Reports how many tasks are success/failed/running/pending/waiting.|
Copy link
Copy Markdown
Contributor

@suneet-s suneet-s Jan 20, 2020

Choose a reason for hiding this comment

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

As someone new to the monitors, I think explaining why you would need this is helpful. Are there specific use cases where I should be monitoring the task counts? Maybe I want to set up alerting on failed jobs?

Copy link
Copy Markdown
Contributor Author

@tomscut tomscut Jan 22, 2020

Choose a reason for hiding this comment

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

@suneet-s Thank you very much for your reply!

Some implementation classes are registered by default and we don't need to register them manually, such as CacheMonitor, JettyMonitor and ExecutorServiceMonitor. But some are not registered by default and need to be configured ourselves, such as QueryCountStatsMonitor and TaskCountStatsMonitor.
Docs: https://druid.apache.org/docs/latest/operations/metrics.html
PR: https://github.com/apache/druid/pull/6657/files

I found a description for QueryCountStatsMonitor, but not for TaskCountStatsMonitor. The description of TaskCountStatsMonitor might have been missed, so I added.

In our scenario, kafka has a large number of indexing tasks and a large amount of data that needs to be consumed with low latency. Therefore, task monitoring is very important.

We deployed the druid cluster with ambari, so monitoring and alerting were implemented based on ambari-metric-collector.

Copy link
Copy Markdown
Contributor

@jihoonson jihoonson May 1, 2020

Choose a reason for hiding this comment

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

Suggest ... tasks are success ... -> ... tasks have been succeeded ...

Copy link
Copy Markdown

@sthetland sthetland Jun 10, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

... or "have been successful", to be consistency with the prior row in the table.

Even better though might be to expand out, for both rows:

Suggested change
|`org.apache.druid.server.metrics.TaskCountStatsMonitor`|Reports how many tasks are success/failed/running/pending/waiting.|
|`org.apache.druid.server.metrics.TaskCountStatsMonitor`|Reports how many tasks have succeeded, failed, or are currently in the running, pending, or waiting state.|

|`org.apache.druid.server.emitter.HttpEmittingMonitor`|Reports internal metrics of `http` or `parametrized` emitter (see below). Must not be used with another emitter type. See the description of the metrics here: https://github.com/apache/druid/pull/4973.|


Expand Down