Missing Overlord and MiddleManager api docs#7042
Conversation
| Check whether a MiddleManager is in an enabled or disabled state. Returns JSON object keyed by the `druid.host` and the boolean state. | ||
|
|
||
| ```json | ||
| {"localhost":true} |
There was a problem hiding this comment.
I'm sure it returns host:port.
There was a problem hiding this comment.
Oops, yes you are correct, thanks for catching! 👍
…de i was referencing
|
Now with more missing Overlord API documentation as well. |
clintropolis
changed the title
surekhasaharan
left a comment
surekhasaharan
left a comment
There was a problem hiding this comment.
Thanks @clintropolis for adding docs and cleaning up some of the unused code. Took a 1st pass, left some minor comments.
| | `datasource`| return tasks filtered by Druid datasource.| | ||
| | `createdTimeInterval`| return tasks created within the specified interval. | | ||
| | `max`| maximum number of `"complete"` tasks to return. Only applies when `state` is set to `"complete"`.| | ||
| | `type`| filter tasks by task type.| |
There was a problem hiding this comment.
May be we should add what are some of the types, say, "where type can be index, kill, compact etc." or if we want to put all the types from here, in addition there are index_kafka and index_kinesis, I think. If you feel the list is long, I'm fine with just few examples.
There was a problem hiding this comment.
I think there are too many, and it can't really be done exhaustively since extensions can add to this as well. Instead I think I'm going to link to ingestion tasks doc to at least point users in the right direction.
|
|
||
| * `/druid/indexer/v1/runningTasks` | ||
|
|
||
| Retrieve list of complete tasks. Equivalent to `/druid/indexer/v1/tasks?state=running`. |
There was a problem hiding this comment.
oh, it should be "Retrieve list of running tasks".
|
|
||
| * `/druid/indexer/v1/waitingTasks` | ||
|
|
||
| Retrieve list of complete tasks. Equivalent to `/druid/indexer/v1/tasks?state=waiting`. |
There was a problem hiding this comment.
same here, and at few other places below
|
|
||
| ##### DELETE | ||
|
|
||
| * `/druid/indexer/v1/pendingSegments/{dataSource}` |
There was a problem hiding this comment.
Hmm, this was intended for internal use only. Do you think it would be useful for people too?
There was a problem hiding this comment.
Yeah, i wasn't thinking so hard about it. I think it's harmless to leave, but linked to druid.coordinator.kill.pendingSegments.on to mention that it can be done automatically via config.
* document middle manager api * re-arrange * correction * document more missing overlord api calls, minor re-arrange of some code i was referencing * fix it * this will fix it * fixup * link to other docs
5 participants
Adds missing Overlord and MiddleManager API documentation, fixes #5917