You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@druid.apache.org by GitBox <gi...@apache.org> on 2021/03/09 08:42:15 UTC
[GitHub] [druid] zhangyue19921010 opened a new pull request #10967: Add missing API references for coordinator
zhangyue19921010 opened a new pull request #10967:
URL: https://github.com/apache/druid/pull/10967
<!-- 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. -->
<!-- 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
Based on
https://github.com/apache/druid/blob/753bce324bdf8c7c5b2b602f89c720749bfa6e22/server/src/main/java/org/apache/druid/server/http/MetadataResource.java#L134
And
https://github.com/apache/druid/blob/753bce324bdf8c7c5b2b602f89c720749bfa6e22/server/src/main/java/org/apache/druid/server/http/MetadataResource.java#L95
There are several missing API references for coordinator.
`/druid/coordinator/v1/metadata/segments`
`/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus`
`/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus&datasources={dataSourceName}`
`/druid/coordinator/v1/metadata/datasources?includeDisabled`
This pr adds these missing api references into api-reference.md
<!--
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. -->
<hr>
##### Key changed/added classes in this PR
* `api-reference.md`
<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.
- [ ] 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.
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
[GitHub] [druid] zhangyue19921010 edited a comment on pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
zhangyue19921010 edited a comment on pull request #10967:
URL: https://github.com/apache/druid/pull/10967#issuecomment-797259710
All the APIs are used by `MetadataSegmentView` internal. Maybe we can document these APIs for users who are interested.
https://github.com/apache/druid/blob/753bce324bdf8c7c5b2b602f89c720749bfa6e22/sql/src/main/java/org/apache/druid/sql/calcite/schema/MetadataSegmentView.java#L178
----------------------------------------------------------------
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.
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
[GitHub] [druid] clintropolis commented on a change in pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
clintropolis commented on a change in pull request #10967:
URL: https://github.com/apache/druid/pull/10967#discussion_r611006539
##########
File path: docs/operations/api-reference.md
##########
@@ -157,19 +157,37 @@ If no used segments are found for the given inputs, this API returns `204 No Con
##### GET
+* `/druid/coordinator/v1/metadata/segments`
+
+Returns a list of all segments for each datasource enabled in the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources enabled in the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus`
+
+Returns a list of all segments for each datasource with the full segment metadata and an extra field `overshadowed`.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus&datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources with the full segment metadata and an extra field `overshadowed`.
+
Review comment:
I wonder if we should add some sort of note that these segment API methods are primarily intended for internal use and maybe should be used with care in large clusters.
--
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.
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
[GitHub] [druid] suneet-s merged pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
suneet-s merged pull request #10967:
URL: https://github.com/apache/druid/pull/10967
--
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.
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
[GitHub] [druid] suneet-s commented on pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
suneet-s commented on pull request #10967:
URL: https://github.com/apache/druid/pull/10967#issuecomment-794009916
> This is a document fixing. Failed CI jobs could pass after re running.
I've re-triggered the flaky tests
----------------------------------------------------------------
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.
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
[GitHub] [druid] zhangyue19921010 commented on pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
zhangyue19921010 commented on pull request #10967:
URL: https://github.com/apache/druid/pull/10967#issuecomment-797259710
All the APIs are used by `MetadataSegmentView` internal. Maybe we can document these APIs for users who are interested.
----------------------------------------------------------------
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.
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
[GitHub] [druid] zhangyue19921010 commented on pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
zhangyue19921010 commented on pull request #10967:
URL: https://github.com/apache/druid/pull/10967#issuecomment-793888627
This is a document fixing. Failed CI jobs could pass after re running.
----------------------------------------------------------------
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.
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
[GitHub] [druid] suneet-s commented on a change in pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
suneet-s commented on a change in pull request #10967:
URL: https://github.com/apache/druid/pull/10967#discussion_r609152814
##########
File path: docs/operations/api-reference.md
##########
@@ -157,19 +157,37 @@ If no used segments are found for the given inputs, this API returns `204 No Con
##### GET
+* `/druid/coordinator/v1/metadata/segments`
+
+Returns a list of all segments for each datasource enabled in the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources enabled in the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus`
+
+Returns a list of all segments for each datasource with the full segment metadata and an extra field `overshadowed`.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus&datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources with the full segment metadata and an extra field `overshadowed`.
+
Review comment:
All the API docs are written as examples of APIs. I think this can be confusing for an end user. What do you think about collapsing all of these into a single API line in the docs. Something like
```suggestion
* `/druid/coordinator/v1/metadata/segments[?datasources={dataSourceName1}[&datasources={datasourceName2}][&includeOvershadowedStatus]]`
Returns a list of all segments for each datasource enabled in the cluster. Optionally, filtered by datasources. If `includeOvershadowedStatus` is passed, then the response will include an extra field `overshadowed`
```
I can't tell if this is easier to understand than what you've written here. Thoughts?
--
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.
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
[GitHub] [druid] zhangyue19921010 commented on pull request #10967: Add missing API references for coordinator
Posted by GitBox <gi...@apache.org>.
zhangyue19921010 commented on pull request #10967:
URL: https://github.com/apache/druid/pull/10967#issuecomment-794047423
> > This is a document fixing. Failed CI jobs could pass after re running.
>
> I've re-triggered the flaky tests
Thanks a lot. It seems there is still a failed job. Could you please help me to re-trigger it again ... Ah 😓
----------------------------------------------------------------
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.
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