You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by "jtuglu-netflix (via GitHub)" <gi...@apache.org> on 2025/05/25 08:30:27 UTC
[PR] Add taskType dimension to overlord-emitted task count metrics (druid)
jtuglu-netflix opened a new pull request, #18032:
URL: https://github.com/apache/druid/pull/18032
Allows allows extension for more granular aggregation on dimensions in the future.
<!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. -->
<!-- Please read the doc for contribution (https://github.com/apache/druid/blob/master/CONTRIBUTING.md) before making this PR. Also, once you open a PR, please _avoid using force pushes and rebasing_ since these make it difficult for reviewers to see what you've changed in response to their reviews. See [the 'If your pull request shows conflicts with master' section](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#if-your-pull-request-shows-conflicts-with-master) for more details. -->
Fixes #XXXX.
<!-- Replace XXXX with the id of the issue fixed in this PR. Remove this section if there is no corresponding issue. Don't reference the issue in the title of this pull-request. -->
<!-- If you are a committer, follow the PR action item checklist for committers:
https://github.com/apache/druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. -->
### Description
<!-- Describe the goal of this PR, what problem are you fixing. If there is a corresponding issue (referenced above), it's not necessary to repeat the description here, however, you may choose to keep one summary sentence. -->
<!-- Describe your patch: what did you change in code? How did you fix the problem? -->
<!-- If there are several relatively logically separate changes in this PR, create a mini-section for each of them. For example: -->
#### Fixed the bug ...
#### Renamed the class ...
#### Added a forbidden-apis entry ...
<!--
In each section, please describe design decisions made, including:
- Choice of algorithms
- Behavioral aspects. What configuration values are acceptable? How are corner cases and error conditions handled, such as when there are insufficient resources?
- Class organization and design (how the logic is split between classes, inheritance, composition, design patterns)
- Method organization and design (how the logic is split between methods, parameters and return types)
- Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics)
-->
<!-- It's good to describe an alternative design (or mention an alternative name) for every design (or naming) decision point and compare the alternatives with the designs that you've implemented (or the names you've chosen) to highlight the advantages of the chosen designs and names. -->
<!-- If there was a discussion of the design of the feature implemented in this PR elsewhere (e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list), link to that discussion from this PR description and explain what have changed in your final design compared to your original proposal or the consensus version in the end of the discussion. If something hasn't changed since the original discussion, you can omit a detailed discussion of those aspects of the design here, perhaps apart from brief mentioning for the sake of readability of this PR description. -->
<!-- Some of the aspects mentioned above may be omitted for simple and small changes. -->
#### Release note
<!-- Give your best effort to summarize your changes in a couple of sentences aimed toward Druid users.
If your change doesn't have end user impact, you can skip this section.
For tips about how to write a good release note, see [Release notes](https://github.com/apache/druid/blob/master/CONTRIBUTING.md#release-notes).
-->
<hr>
##### Key changed/added classes in this PR
* `MyFoo`
* `OurBar`
* `TheirBaz`
<hr>
<!-- Check the items by putting "x" in the brackets for the done things. Not all of these items apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items from the checklist below are strictly necessary, but it would be very helpful if you at least self-review the PR. -->
This PR has:
- [ ] been self-reviewed.
- [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
- [ ] added documentation for new or modified features or behaviors.
- [ ] a release note entry in the PR description.
- [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
- [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/dev/license.md)
- [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
- [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold for [code coverage](https://github.com/apache/druid/blob/master/dev/code-review/code-coverage.md) is met.
- [ ] added integration tests.
- [ ] been tested in a test Druid cluster.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "kfaraz (via GitHub)" <gi...@apache.org>.
kfaraz commented on code in PR #18032:
URL: https://github.com/apache/druid/pull/18032#discussion_r2106185150
##########
server/src/main/java/org/apache/druid/server/metrics/TaskCountStatsProvider.java:
##########
@@ -26,34 +26,34 @@
public interface TaskCountStatsProvider
{
/**
- * Return the number of successful tasks for each datasource during emission period.
+ * Return the number of successful tasks for each datasource and task type during emission period.
*/
@Deprecated
- Map<String, Long> getSuccessfulTaskCount();
+ Map<TaskMetricKey, Long> getSuccessfulTaskCount();
/**
- * Return the number of failed tasks for each datasource during emission period.
+ * Return the number of failed tasks for each datasource and task type during emission period.
*/
@Deprecated
- Map<String, Long> getFailedTaskCount();
+ Map<TaskMetricKey, Long> getFailedTaskCount();
Review Comment:
Use `RowKey` instead.
##########
server/src/main/java/org/apache/druid/server/metrics/TaskMetricKey.java:
##########
@@ -0,0 +1,65 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.druid.server.metrics;
+
+import java.util.Objects;
+
+/**
+ A hashable, extendible key used for aggregating useful metrics on tasks.
+*/
+public class TaskMetricKey
Review Comment:
I don't think we need this new class. There is an existing class [RowKey](https://github.com/apache/druid/blob/master/server/src/main/java/org/apache/druid/server/coordinator/stats/RowKey.java) which is more generic.
The `RowKey` is typically used in `CoordinatorRunStats` which I had plans to generalize for all of Druid and not keep limited to the Coordinator.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "kfaraz (via GitHub)" <gi...@apache.org>.
kfaraz commented on code in PR #18032:
URL: https://github.com/apache/druid/pull/18032#discussion_r2106184984
##########
server/src/main/java/org/apache/druid/server/metrics/TaskMetricKey.java:
##########
@@ -0,0 +1,65 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.druid.server.metrics;
+
+import java.util.Objects;
+
+/**
+ A hashable, extendible key used for aggregating useful metrics on tasks.
+*/
+public class TaskMetricKey
Review Comment:
I don't think we need this new class. There is an existing class [RowKey](https://github.com/apache/druid/blob/master/server/src/main/java/org/apache/druid/server/coordinator/stats/RowKey.java) which is more generic.
The `RowKey` is typically used in `CoordinatorRunStats` which I had plans to generalize for all of Druid and not keep limited to the Coordinator. The `CoordinatorRunStats` anyway happens to be already in use in `TaskCountStatsMonitor`.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "kfaraz (via GitHub)" <gi...@apache.org>.
kfaraz commented on code in PR #18032:
URL: https://github.com/apache/druid/pull/18032#discussion_r2106380024
##########
server/src/main/java/org/apache/druid/server/metrics/TaskCountStatsMonitor.java:
##########
@@ -61,12 +62,14 @@ public boolean doMonitor(ServiceEmitter emitter)
return true;
}
- private void emit(ServiceEmitter emitter, String key, Map<String, Long> counts)
+ private void emit(ServiceEmitter emitter, String key, Map<RowKey, Long> counts)
{
final ServiceMetricEvent.Builder builder = new ServiceMetricEvent.Builder();
if (counts != null) {
counts.forEach((k, v) -> {
- builder.setDimension("dataSource", k);
+ for (final Map.Entry<Dimension, String> entry : k.getValues().entrySet()) {
+ builder.setDimension(entry.getKey().reportedName(), entry.getValue());
+ }
Review Comment:
Nit: short-hand (since we are already using forEach in this code block)
```suggestion
k.getValues().forEach((dim, value) -> builder.setDimension(dim.reportedName(), value));
```
##########
indexing-service/src/main/java/org/apache/druid/indexing/overlord/TaskQueue.java:
##########
@@ -904,58 +906,56 @@ private Map<String, Long> getDeltaValues(Map<String, Long> total, Map<String, Lo
return deltaValues;
}
- public Map<String, Long> getSuccessfulTaskCount()
+ public Map<RowKey, Long> getSuccessfulTaskCount()
{
- Map<String, Long> total = CollectionUtils.mapValues(totalSuccessfulTaskCount, AtomicLong::get);
+ final Map<RowKey, Long> total = CollectionUtils.mapValues(totalSuccessfulTaskCount, AtomicLong::get);
synchronized (totalSuccessfulTaskCount) {
- Map<String, Long> delta = getDeltaValues(total, prevTotalSuccessfulTaskCount);
+ Map<RowKey, Long> delta = getDeltaValues(total, prevTotalSuccessfulTaskCount);
prevTotalSuccessfulTaskCount = total;
return delta;
}
}
- public Map<String, Long> getFailedTaskCount()
+ public Map<RowKey, Long> getFailedTaskCount()
{
- Map<String, Long> total = CollectionUtils.mapValues(totalFailedTaskCount, AtomicLong::get);
+ final Map<RowKey, Long> total = CollectionUtils.mapValues(totalFailedTaskCount, AtomicLong::get);
synchronized (totalFailedTaskCount) {
- Map<String, Long> delta = getDeltaValues(total, prevTotalFailedTaskCount);
+ Map<RowKey, Long> delta = getDeltaValues(total, prevTotalFailedTaskCount);
prevTotalFailedTaskCount = total;
return delta;
}
}
- private Map<String, String> getCurrentTaskDatasources()
+ private Map<String, RowKey> getCurrentTaskDatasources()
{
- return activeTasks.values().stream()
- .map(entry -> entry.task)
- .collect(Collectors.toMap(Task::getId, Task::getDataSource));
+ return activeTasks.values().stream().filter(entry -> !entry.isComplete).map(entry -> entry.task).collect(Collectors.toMap(Task::getId, TaskQueue::getMetricKey));
Review Comment:
It was cleaner to have this broken over multiple lines.
##########
server/src/main/java/org/apache/druid/server/coordinator/stats/Dimension.java:
##########
@@ -25,6 +25,7 @@
public enum Dimension
{
TIER("tier"),
+ TASK_TYPE("taskType"),
Review Comment:
Yes, that is the eventual goal. It is a part of making `CoordinatorRunStats` available to the whole of Druid.
But I don't want to rush it until I have had a chance to think some more about it.
##########
indexing-service/src/main/java/org/apache/druid/indexing/overlord/TaskQueue.java:
##########
@@ -1136,4 +1136,16 @@ static class TaskEntry
this.lastUpdatedTime = DateTimes.nowUtc();
}
}
+
+ private static RowKey getMetricKey(final Task task)
+ {
+ if (task == null) {
+ return RowKey.empty();
+ }
+ RowKey.Builder builder = new RowKey.Builder();
+ builder.with(Dimension.DATASOURCE, task.getDataSource());
+ builder.with(Dimension.TASK_TYPE, task.getType());
+
+ return builder.build();
Review Comment:
You can use the short hand:
```suggestion
return RowKey.with(Dimension.DATASOURCE, task.getDataSource())
.and(Dimension.TASK_TYPE, task.getType());
```
##########
server/src/test/java/org/apache/druid/server/metrics/TaskCountStatsMonitorTest.java:
##########
@@ -85,12 +93,17 @@ public void testMonitor()
final TaskCountStatsMonitor monitor = new TaskCountStatsMonitor(statsProvider);
final StubServiceEmitter emitter = new StubServiceEmitter("service", "host");
monitor.doMonitor(emitter);
- Assert.assertEquals(7, emitter.getEvents().size());
- emitter.verifyValue("task/success/count", 1L);
- emitter.verifyValue("task/failed/count", 1L);
- emitter.verifyValue("task/running/count", 1L);
- emitter.verifyValue("task/pending/count", 1L);
- emitter.verifyValue("task/waiting/count", 1L);
+
+ Assert.assertEquals(9, emitter.getEvents().size());
+
+ emitter.verifyValue("task/success/count", ImmutableMap.of("dataSource", "d1", "taskType", "index"), 1L);
Review Comment:
for brevity:
```suggestion
emitter.verifyValue("task/success/count", Map.of("dataSource", "d1", "taskType", "index"), 1L);
```
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "maytasm (via GitHub)" <gi...@apache.org>.
maytasm commented on PR #18032:
URL: https://github.com/apache/druid/pull/18032#issuecomment-2908919228
@jtuglu-netflix Please also update the docs i.e. https://github.com/apache/druid/blob/master/docs/operations/metrics.md?plain=1#L312 with the new dimension (i.e. taskType).
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "jtuglu-netflix (via GitHub)" <gi...@apache.org>.
jtuglu-netflix commented on code in PR #18032:
URL: https://github.com/apache/druid/pull/18032#discussion_r2106317052
##########
server/src/main/java/org/apache/druid/server/coordinator/stats/Dimension.java:
##########
@@ -25,6 +25,7 @@
public enum Dimension
{
TIER("tier"),
+ TASK_TYPE("taskType"),
Review Comment:
It might be nice to merge this with `DruidMetrics`, but I've left as-is for now.
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "jtuglu-netflix (via GitHub)" <gi...@apache.org>.
jtuglu-netflix commented on code in PR #18032:
URL: https://github.com/apache/druid/pull/18032#discussion_r2106317052
##########
server/src/main/java/org/apache/druid/server/coordinator/stats/Dimension.java:
##########
@@ -25,6 +25,7 @@
public enum Dimension
{
TIER("tier"),
+ TASK_TYPE("taskType"),
Review Comment:
It might be nice to merge this with `DruidMetrics`
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org
Re: [PR] Add taskType dimension to overlord-emitted task count metrics (druid)
Posted by "kfaraz (via GitHub)" <gi...@apache.org>.
kfaraz merged PR #18032:
URL: https://github.com/apache/druid/pull/18032
--
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: commits-unsubscribe@druid.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org