2023-06-26 18:48:54 -04:00
---
id: supervisor-api
title: Supervisor API
sidebar_label: Supervisors
---
2023-08-16 22:01:21 -04:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2023-06-26 18:48:54 -04:00
<!--
~ 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.
-->
2023-07-27 15:58:37 -04:00
This topic describes the API endpoints to manage and monitor supervisors for Apache Druid.
2024-04-24 16:14:01 -04:00
The topic uses the Apache Kafka term offset to refer to the identifier for records in a partition. If you are using Amazon Kinesis, the equivalent is sequence number.
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. Replace it with the information for your deployment. For example, use `http://localhost:8888` for quickstart deployments.
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
## Supervisor information
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
The following table lists the properties of a supervisor object:
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
|Property|Type|Description|
|---|---|---|
|`id`|String|Unique identifier.|
2024-02-12 16:52:42 -05:00
|`state`|String|Generic state of the supervisor. Available states:`UNHEALTHY_SUPERVISOR`, `UNHEALTHY_TASKS` , `PENDING` , `RUNNING` , `SUSPENDED` , `STOPPING` . See [Supervisor reference ](../ingestion/supervisor.md#status-report ) for more information.|
|`detailedState`|String|Detailed state of the supervisor. This property contains a more descriptive, implementation-specific state that may provide more insight into the supervisor's activities than the `state` property. See [Apache Kafka ingestion ](../ingestion/kafka-ingestion.md ) and [Amazon Kinesis ingestion ](../ingestion/kinesis-ingestion.md ) for supervisor-specific states.|
2023-07-27 15:58:37 -04:00
|`healthy`|Boolean|Supervisor health indicator.|
|`spec`|Object|Container object for the supervisor configuration.|
|`suspended`|Boolean|Indicates whether the supervisor is in a suspended state.|
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
### Get an array of active supervisor IDs
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
Returns an array of strings representing the names of active supervisors. If there are no active supervisors, it returns an empty array.
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### URL
2023-06-26 18:48:54 -04:00
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor`
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< TabItem value = "1" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved array of active supervisor IDs*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "2" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "3" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```json
[
"wikipedia_stream",
"social_media"
]
```
< / details >
### Get an array of active supervisor objects
Retrieves an array of active supervisor objects. If there are no active supervisors, it returns an empty array. For reference on the supervisor object properties, see the preceding [table ](#supervisor-information ).
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor?full`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< TabItem value = "4" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved supervisor objects*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "5" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor?full=null"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "6" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor?full=null HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```json
[
{
"id": "wikipedia_stream",
"state": "RUNNING",
"detailedState": "CONNECTING_TO_STREAM",
"healthy": true,
"spec": {
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "wikipedia_stream",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9042"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "wikipedia_stream",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9042"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
},
"suspended": false
},
{
"id": "social_media",
"state": "RUNNING",
"detailedState": "RUNNING",
"healthy": true,
"spec": {
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
},
"suspended": false
}
]
```
< / details >
### Get an array of supervisor states
Retrieves an array of objects representing active supervisors and their current state. If there are no active supervisors, it returns an empty array. For reference on the supervisor object properties, see the preceding [table ](#supervisor-information ).
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor?state=true`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< TabItem value = "7" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved supervisor state objects*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "8" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor?state=true"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "9" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor?state=true HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```json
[
{
"id": "wikipedia_stream",
"state": "UNHEALTHY_SUPERVISOR",
"detailedState": "UNABLE_TO_CONNECT_TO_STREAM",
"healthy": false,
"suspended": false
},
{
"id": "social_media",
"state": "RUNNING",
"detailedState": "RUNNING",
"healthy": true,
"suspended": false
}
]
```
< / details >
### Get supervisor specification
Retrieves the specification for a single supervisor. The returned specification includes the `dataSchema` , `ioConfig` , and `tuningConfig` objects.
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/{supervisorId}`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "10" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved supervisor spec*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "11" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
The following example shows how to retrieve the specification of a supervisor with the name `wikipedia_stream` .
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "12" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/wikipedia_stream"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "13" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor/wikipedia_stream HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
}
```
< / details >
### Get supervisor status
Retrieves the current status report for a single supervisor. The report contains the state of the supervisor tasks and an array of recently thrown exceptions.
2024-02-12 16:52:42 -05:00
For additional information about the status report, see [Supervisor reference ](../ingestion/supervisor.md#status-report ).
2023-07-27 15:58:37 -04:00
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/{supervisorId}/status`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "14" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved supervisor status*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "15" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
The following example shows how to retrieve the status of a supervisor with the name `social_media` .
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "16" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/status"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "17" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor/social_media/status HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"id": "social_media",
"generationTime": "2023-07-05T23:24:43.934Z",
"payload": {
"dataSource": "social_media",
"stream": "social_media",
"partitions": 1,
"replicas": 1,
"durationSeconds": 3600,
"activeTasks": [
{
"id": "index_kafka_social_media_ab72ae4127c591c_flcbhdlh",
"startingOffsets": {
"0": 3176381
},
"startTime": "2023-07-05T23:21:39.321Z",
"remainingSeconds": 3415,
"type": "ACTIVE",
"currentOffsets": {
"0": 3296632
},
"lag": {
"0": 3
}
}
],
"publishingTasks": [],
"latestOffsets": {
"0": 3296635
},
"minimumLag": {
"0": 3
},
"aggregateLag": 3,
"offsetsLastUpdated": "2023-07-05T23:24:30.212Z",
"suspended": false,
"healthy": true,
"state": "RUNNING",
"detailedState": "RUNNING",
"recentErrors": []
}
}
```
< / details >
2024-02-12 16:52:42 -05:00
### Get supervisor health
Retrieves the current health report for a single supervisor. The health of a supervisor is determined by the supervisor's `state` (as returned by the `/status` endpoint) and the `druid.supervisor.*` Overlord configuration thresholds.
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/{supervisorId}/health`
2024-02-12 16:52:42 -05:00
#### Responses
< Tabs >
< TabItem value = "18" label = "200 SUCCESS" >
*Supervisor is healthy*
< / TabItem >
< TabItem value = "19" label = "404 NOT FOUND" >
*Invalid supervisor ID*
< / TabItem >
< TabItem value = "20" label = "503 SERVICE UNAVAILABLE" >
*Supervisor is unhealthy*
< / TabItem >
< / Tabs >
---
#### Sample request
The following example shows how to retrieve the health report for a supervisor with the name `social_media` .
< Tabs >
< TabItem value = "21" label = "cURL" >
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/health"
```
< / TabItem >
< TabItem value = "22" label = "HTTP" >
```HTTP
GET /druid/indexer/v1/supervisor/social_media/health HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
< / TabItem >
< / Tabs >
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2024-02-12 16:52:42 -05:00
```json
{
"healthy": false
}
```
< / details >
### Get supervisor ingestion stats
Returns a snapshot of the current ingestion row counters for each task being managed by the supervisor, along with moving averages for the row counters. See [Row stats ](../ingestion/tasks.md#row-stats ) for more information.
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/{supervisorId}/stats`
2024-02-12 16:52:42 -05:00
#### Responses
< Tabs >
< TabItem value = "23" label = "200 SUCCESS" >
*Successfully retrieved supervisor stats*
< / TabItem >
< TabItem value = "24" label = "404 NOT FOUND" >
*Invalid supervisor ID*
< / TabItem >
< / Tabs >
---
#### Sample request
The following example shows how to retrieve the current ingestion row counters for a supervisor with the name `custom_data` .
< Tabs >
< TabItem value = "25" label = "cURL" >
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/custom_data/stats"
```
< / TabItem >
< TabItem value = "26" label = "HTTP" >
```HTTP
GET /druid/indexer/v1/supervisor/custom_data/stats HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
< / TabItem >
< / Tabs >
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2024-02-12 16:52:42 -05:00
```json
{
"0": {
"index_kafka_custom_data_881d621078f6b7c_ccplchbi": {
"movingAverages": {
"buildSegments": {
"5m": {
"processed": 53.401225142603316,
"processedBytes": 5226.400757148808,
"unparseable": 0.0,
"thrownAway": 0.0,
"processedWithError": 0.0
},
"15m": {
"processed": 56.92994990102502,
"processedBytes": 5571.772059828217,
"unparseable": 0.0,
"thrownAway": 0.0,
"processedWithError": 0.0
},
"1m": {
"processed": 37.134921285556636,
"processedBytes": 3634.2766230628677,
"unparseable": 0.0,
"thrownAway": 0.0,
"processedWithError": 0.0
}
}
},
"totals": {
"buildSegments": {
"processed": 665,
"processedBytes": 65079,
"processedWithError": 0,
"thrownAway": 0,
"unparseable": 0
}
}
}
}
}
```
< / details >
2023-07-27 15:58:37 -04:00
## Audit history
An audit history provides a comprehensive log of events, including supervisor configuration, creation, suspension, and modification history.
### Get audit history for all supervisors
2024-02-12 16:52:42 -05:00
Retrieves an audit history of specs for all supervisors.
2023-07-27 15:58:37 -04:00
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/history`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2024-02-12 16:52:42 -05:00
< TabItem value = "27" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved audit history*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "28" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/history"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "29" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor/history HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"social_media": [
{
"spec": {
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
},
"version": "2023-07-03T18:51:02.970Z"
}
]
}
```
< / details >
### Get audit history for a specific supervisor
Retrieves an audit history of specs for a single supervisor.
#### URL
2024-04-12 12:19:13 -04:00
`GET` `/druid/indexer/v1/supervisor/{supervisorId}/history`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "30" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully retrieved supervisor audit history*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "31" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
The following example shows how to retrieve the audit history of a supervisor with the name `wikipedia_stream` .
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "23" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/wikipedia_stream/history"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "32" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
GET /druid/indexer/v1/supervisor/wikipedia_stream/history HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
[
{
"spec": {
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "wikipedia_stream",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9042"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "wikipedia_stream",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9042"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
},
"version": "2023-07-05T20:59:16.872Z"
}
]
```
< / details >
## Manage supervisors
### Create or update a supervisor
2024-02-12 16:52:42 -05:00
Creates a new supervisor spec or updates an existing one with new configuration and schema information. When updating a supervisor spec, the datasource must remain the same as the previous supervisor.
You can define a supervisor spec for [Apache Kafka ](../ingestion/kafka-ingestion.md ) or [Amazon Kinesis ](../ingestion/kinesis-ingestion.md ) streaming ingestion methods.
The following table lists the properties of a supervisor spec:
2023-07-27 15:58:37 -04:00
2024-02-12 16:52:42 -05:00
|Property|Type|Description|Required|
|--------|----|-----------|--------|
|`type`|String|The supervisor type. One of`kafka` or `kinesis` .|Yes|
|`spec`|Object|The container object for the supervisor configuration.|Yes|
|`ioConfig`|Object|The I/O configuration object to define the connection and I/O-related settings for the supervisor and indexing task.|Yes|
|`dataSchema`|Object|The schema for the indexing task to use during ingestion. See [`dataSchema` ](../ingestion/ingestion-spec.md#dataschema ) for more information.|Yes|
|`tuningConfig`|Object|The tuning configuration object to define performance-related settings for the supervisor and indexing tasks.|No|
2023-07-27 15:58:37 -04:00
2024-02-12 16:52:42 -05:00
When you call this endpoint on an existing supervisor, the running supervisor signals its tasks to stop reading and begin publishing, exiting itself. Druid then uses the provided configuration from the request body to create a new supervisor. Druid submits a new schema while retaining existing publishing tasks and starts new tasks at the previous task offsets.
This way, you can apply configuration changes without a pause in ingestion.
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### URL
2023-06-26 18:48:54 -04:00
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor`
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### Responses
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "33" label = "200 SUCCESS" >
2023-08-16 22:01:21 -04:00
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
*Successfully created a new supervisor or updated an existing supervisor*
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "34" label = "415 UNSUPPORTED MEDIA TYPE" >
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
*Request body content type is not in JSON format*
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
The following example uses JSON input format to create a supervisor spec for Kafka with a `social_media` datasource and `social_media` topic.
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "35" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor" \
--header 'Content-Type: application/json' \
--data '{
"type": "kafka",
"spec": {
"ioConfig": {
"type": "kafka",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"topic": "social_media",
"inputFormat": {
"type": "json"
},
"useEarliestOffset": true
},
"tuningConfig": {
"type": "kafka"
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso"
},
"dimensionsSpec": {
"dimensions": [
"username",
"post_title",
{
"type": "long",
"name": "views"
},
{
"type": "long",
"name": "upvotes"
},
{
"type": "long",
"name": "comments"
},
"edited"
]
},
"granularitySpec": {
"queryGranularity": "none",
"rollup": false,
"segmentGranularity": "hour"
}
}
}
}'
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "36" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
Content-Type: application/json
Content-Length: 1359
{
"type": "kafka",
"spec": {
"ioConfig": {
"type": "kafka",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"topic": "social_media",
"inputFormat": {
"type": "json"
},
"useEarliestOffset": true
},
"tuningConfig": {
"type": "kafka"
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso"
},
"dimensionsSpec": {
"dimensions": [
"username",
"post_title",
{
"type": "long",
"name": "views"
},
{
"type": "long",
"name": "upvotes"
},
{
"type": "long",
"name": "comments"
},
"edited"
]
},
"granularitySpec": {
"queryGranularity": "none",
"rollup": false,
"segmentGranularity": "hour"
}
}
}
}
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"id": "social_media"
}
```
< / details >
### Suspend a running supervisor
Suspends a single running supervisor. Returns the updated supervisor spec, where the `suspended` property is set to `true` . The suspended supervisor continues to emit logs and metrics.
2024-02-12 16:52:42 -05:00
Indexing tasks remain suspended until you [resume the supervisor ](#resume-a-supervisor ).
2023-07-27 15:58:37 -04:00
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/suspend`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "37" label = "200 SUCCESS" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully shut down supervisor*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "38" label = "400 BAD REQUEST" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Supervisor already suspended*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "39" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
The following example shows how to suspend a running supervisor with the name `social_media` .
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "40" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/suspend"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "41" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/social_media/suspend HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": true
}
```
< / details >
### Suspend all supervisors
Suspends all supervisors. Note that this endpoint returns an HTTP `200 Success` code message even if there are no supervisors or running supervisors to suspend.
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/suspendAll`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "42" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully suspended all supervisors*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "43" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/suspendAll"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "44" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/suspendAll HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"status": "success"
}
```
< / details >
### Resume a supervisor
Resumes indexing tasks for a supervisor. Returns an updated supervisor spec with the `suspended` property set to `false` .
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/resume`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "45" label = "200 SUCCESS" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully resumed supervisor*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "46" label = "400 BAD REQUEST" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Supervisor already running*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "47" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
The following example resumes a previously suspended supervisor with name `social_media` .
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "48" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/resume"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "49" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/social_media/resume HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### Sample response
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
```json
{
"type": "kafka",
"spec": {
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
}
},
"dataSchema": {
"dataSource": "social_media",
"timestampSpec": {
"column": "__time",
"format": "iso",
"missingValue": null
},
"dimensionsSpec": {
"dimensions": [
{
"type": "string",
"name": "username",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "string",
"name": "post_title",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
},
{
"type": "long",
"name": "views",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "upvotes",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "long",
"name": "comments",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": false
},
{
"type": "string",
"name": "edited",
"multiValueHandling": "SORTED_ARRAY",
"createBitmapIndex": true
}
],
"dimensionExclusions": [
"__time"
],
"includeAllDimensions": false,
"useSchemaDiscovery": false
},
"metricsSpec": [],
"granularitySpec": {
"type": "uniform",
"segmentGranularity": "HOUR",
"queryGranularity": {
"type": "none"
},
"rollup": false,
"intervals": []
},
"transformSpec": {
"filter": null,
"transforms": []
}
},
"tuningConfig": {
"type": "kafka",
"appendableIndexSpec": {
"type": "onheap",
"preserveExistingMetrics": false
},
"maxRowsInMemory": 150000,
"maxBytesInMemory": 0,
"skipBytesInMemoryOverheadCheck": false,
"maxRowsPerSegment": 5000000,
"maxTotalRows": null,
"intermediatePersistPeriod": "PT10M",
"maxPendingPersists": 0,
"indexSpec": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"indexSpecForIntermediatePersists": {
"bitmap": {
"type": "roaring"
},
"dimensionCompression": "lz4",
"stringDictionaryEncoding": {
"type": "utf8"
},
"metricCompression": "lz4",
"longEncoding": "longs"
},
"reportParseExceptions": false,
"handoffConditionTimeout": 0,
"resetOffsetAutomatically": false,
"segmentWriteOutMediumFactory": null,
"workerThreads": null,
"chatRetries": 8,
"httpTimeout": "PT10S",
"shutdownTimeout": "PT80S",
"offsetFetchPeriod": "PT30S",
"intermediateHandoffPeriod": "P2147483647D",
"logParseExceptions": false,
"maxParseExceptions": 2147483647,
"maxSavedParseExceptions": 0,
"skipSequenceNumberAvailabilityCheck": false,
"repartitionTransitionDuration": "PT120S"
},
"ioConfig": {
"topic": "social_media",
"inputFormat": {
2024-06-05 23:01:14 -04:00
"type": "json"
2023-07-27 15:58:37 -04:00
},
"replicas": 1,
"taskCount": 1,
"taskDuration": "PT3600S",
"consumerProperties": {
"bootstrap.servers": "localhost:9094"
},
"autoScalerConfig": null,
"pollTimeout": 100,
"startDelay": "PT5S",
"period": "PT30S",
"useEarliestOffset": true,
"completionTimeout": "PT1800S",
"lateMessageRejectionPeriod": null,
"earlyMessageRejectionPeriod": null,
"lateMessageRejectionStartDateTime": null,
"configOverrides": null,
"idleConfig": null,
"stream": "social_media",
"useEarliestSequenceNumber": true
},
"context": null,
"suspended": false
}
```
< / details >
### Resume all supervisors
Resumes all supervisors. Note that this endpoint returns an HTTP `200 Success` code even if there are no supervisors or suspended supervisors to resume.
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/resumeAll`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2024-02-12 16:52:42 -05:00
< TabItem value = "50" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully resumed all supervisors*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "51" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/resumeAll"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "52" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/resumeAll HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"status": "success"
}
```
< / details >
### Reset a supervisor
2024-02-12 16:52:42 -05:00
The supervisor must be running for this endpoint to be available.
2024-04-24 16:14:01 -04:00
Resets the specified supervisor. This endpoint clears supervisor metadata, prompting the supervisor to resume data reading. The supervisor restarts from the earliest or latest available position, depending on the value of the `useEarliestOffset` property.
After clearing all stored offsets, the supervisor kills and recreates active tasks,
2024-02-12 16:52:42 -05:00
so that tasks begin reading from valid positions.
2023-07-27 15:58:37 -04:00
2024-04-24 16:14:01 -04:00
Use this endpoint to recover from a stopped state due to missing offsets. Use this endpoint with caution as it may result in skipped messages and lead to data loss or duplicate data.
2023-07-27 15:58:37 -04:00
2024-04-24 16:14:01 -04:00
The indexing service keeps track of the latest persisted offsets to provide exactly-once ingestion guarantees across tasks. Subsequent tasks must start reading from where the previous task completed for Druid to accept the generated segments. If the messages at the expected starting offsets are no longer available, the supervisor refuses to start and in-flight tasks fail. Possible causes for missing messages include the message retention period elapsing or the topic being removed and re-created. Use the `reset` endpoint to recover from this condition.
2024-02-12 16:52:42 -05:00
2023-07-27 15:58:37 -04:00
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/reset`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2024-02-12 16:52:42 -05:00
< TabItem value = "53" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully reset supervisor*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "54" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
The following example shows how to reset a supervisor with the name `social_media` .
< Tabs >
2023-07-27 15:58:37 -04:00
2024-02-12 16:52:42 -05:00
< TabItem value = "55" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/reset"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
2024-02-12 16:52:42 -05:00
< TabItem value = "56" label = "HTTP" >
2023-08-16 22:01:21 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/social_media/reset HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"id": "social_media"
}
```
< / details >
2024-02-12 16:52:42 -05:00
### Reset offsets for a supervisor
The supervisor must be running for this endpoint to be available.
Resets the specified offsets for partitions without resetting the entire set.
2024-04-24 16:14:01 -04:00
This endpoint clears only the stored offsets, prompting the supervisor to resume reading data from the specified offsets.
2024-02-12 16:52:42 -05:00
If there are no stored offsets, the specified offsets are set in the metadata store.
2023-08-17 17:13:10 -04:00
2024-02-12 16:52:42 -05:00
After resetting stored offsets, the supervisor kills and recreates any active tasks pertaining to the specified partitions,
so that tasks begin reading specified offsets. For partitions that are not specified in this operation, the supervisor resumes from the last stored offset.
2023-08-17 17:13:10 -04:00
2024-02-12 16:52:42 -05:00
Use this endpoint with caution. It can cause skipped messages, leading to data loss or duplicate data.
2023-08-17 17:13:10 -04:00
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/resetOffsets`
2023-08-17 17:13:10 -04:00
#### Responses
2023-11-20 14:16:10 -05:00
< Tabs >
< TabItem value = "1" label = "200 SUCCESS" >
2023-08-17 17:13:10 -04:00
*Successfully reset offsets*
2023-11-20 14:16:10 -05:00
< / TabItem >
< TabItem value = "2" label = "404 NOT FOUND" >
2023-08-17 17:13:10 -04:00
*Invalid supervisor ID*
2023-11-20 14:16:10 -05:00
< / TabItem >
< / Tabs >
2023-08-17 17:13:10 -04:00
---
#### Reset Offsets Metadata
This section presents the structure and details of the reset offsets metadata payload.
| Field | Type | Description | Required |
|---------|---------|---------|---------|
| `type` | String | The type of reset offsets metadata payload. It must match the supervisor's `type` . Possible values: `kafka` or `kinesis` . | Yes |
| `partitions` | Object | An object representing the reset metadata. See below for details. | Yes |
#### Partitions
The following table defines the fields within the `partitions` object in the reset offsets metadata payload.
| Field | Type | Description | Required |
|---------|---------|---------|---------|
| `type` | String | Must be set as `end` . Indicates the end sequence numbers for the reset offsets. | Yes |
| `stream` | String | The stream to be reset. It must be a valid stream consumed by the supervisor. | Yes |
| `partitionOffsetMap` | Object | A map of partitions to corresponding offsets for the stream to be reset.| Yes |
#### Sample request
2024-02-12 16:52:42 -05:00
The following example shows how to reset offsets for a Kafka supervisor with the name `social_media` . For example, the supervisor is reading from a Kafka topic `ads_media_stream` and has the stored offsets: `{"0": 0, "1": 10, "2": 20, "3": 40}` .
2023-08-17 17:13:10 -04:00
2023-11-20 14:16:10 -05:00
< Tabs >
< TabItem value = "3" label = "cURL" >
2023-08-17 17:13:10 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/resetOffsets"
--header 'Content-Type: application/json'
--data-raw '{"type":"kafka","partitions":{"type":"end","stream":"ads_media_stream","partitionOffsetMap":{"0":100, "2": 650}}}'
```
2023-11-20 14:16:10 -05:00
< / TabItem >
< TabItem value = "4" label = "HTTP" >
2023-08-17 17:13:10 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/social_media/resetOffsets HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
Content-Type: application/json
{
"type": "kafka",
"partitions": {
"type": "end",
"stream": "ads_media_stream",
"partitionOffsetMap": {
"0": 100,
"2": 650
}
}
}
```
2024-02-12 16:52:42 -05:00
The example operation resets offsets only for partitions `0` and `2` to 100 and 650 respectively. After a successful reset,
when the supervisor's tasks restart, they resume reading from `{"0": 100, "1": 10, "2": 650, "3": 40}` .
2023-08-17 17:13:10 -04:00
2023-11-20 14:16:10 -05:00
< / TabItem >
< / Tabs >
2023-08-17 17:13:10 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-08-17 17:13:10 -04:00
```json
{
"id": "social_media"
}
```
< / details >
2023-07-27 15:58:37 -04:00
### Terminate a supervisor
2024-04-24 16:14:01 -04:00
Terminates a supervisor and its associated indexing tasks, triggering the publishing of their segments. When you terminate a supervisor, Druid places a tombstone marker in the metadata store to prevent reloading on restart.
2023-07-27 15:58:37 -04:00
The terminated supervisor still exists in the metadata store and its history can be retrieved.
2023-08-16 22:01:21 -04:00
#### URL
2023-07-27 15:58:37 -04:00
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/terminate`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< TabItem value = "49" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully terminated a supervisor*
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "50" label = "404 NOT FOUND" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Invalid supervisor ID or supervisor not running*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
#### Sample request
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "51" label = "cURL" >
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/terminate"
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "52" label = "HTTP" >
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/social_media/terminate HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
#### Sample response
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-07-27 15:58:37 -04:00
```json
{
"id": "social_media"
}
```
< / details >
### Terminate all supervisors
Terminates all supervisors. Terminated supervisors still exist in the metadata store and their history can be retrieved. Note that this endpoint returns an HTTP `200 Success` code even if there are no supervisors or running supervisors to terminate.
#### URL
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/terminateAll`
2023-07-27 15:58:37 -04:00
#### Responses
2023-08-16 22:01:21 -04:00
< Tabs >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
< TabItem value = "53" label = "200 SUCCESS" >
2023-07-27 15:58:37 -04:00
2023-08-16 22:01:21 -04:00
*Successfully terminated all supervisors*
< / TabItem >
< / Tabs >
2023-07-27 15:58:37 -04:00
---
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### Sample request
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< Tabs >
< TabItem value = "54" label = "cURL" >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/terminateAll"
```
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< TabItem value = "55" label = "HTTP" >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
```HTTP
POST /druid/indexer/v1/supervisor/terminateAll HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
```
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
< / TabItem >
< / Tabs >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### Sample response
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
< details >
2024-04-12 12:19:13 -04:00
< summary > View the response< / summary >
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
```json
{
"status": "success"
}
```
< / details >
2023-06-26 18:48:54 -04:00
2024-05-14 09:39:50 -04:00
### Handoff task groups for a supervisor early
Trigger handoff for specified task groups of a supervisor early. This is a best effort API and makes no guarantees of handoff execution
#### URL
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/taskGroups/handoff`
#### Sample request
2024-06-12 23:13:22 -04:00
The following example shows how to handoff task groups for a supervisor with the name `social_media` and has the task groups: `1,2,3` .
2024-05-14 09:39:50 -04:00
< Tabs >
< TabItem value = "3" label = "cURL" >
```shell
curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/taskGroups/handoff"
--header 'Content-Type: application/json'
--data-raw '{"taskGroupIds": [1, 2, 3]}'
```
< / TabItem >
< TabItem value = "4" label = "HTTP" >
```HTTP
POST /druid/indexer/v1/supervisor/social_media/taskGroups/handoff HTTP/1.1
Host: http://ROUTER_IP:ROUTER_PORT
Content-Type: application/json
{
"taskGroupIds": [1, 2, 3],
}
```
< / TabItem >
< / Tabs >
#### Sample response
< details >
< summary > View the response< / summary >
2024-05-16 11:42:44 -04:00
(empty response)
2024-05-14 09:39:50 -04:00
< / details >
2023-07-27 15:58:37 -04:00
### Shut down a supervisor
2023-06-26 18:48:54 -04:00
2023-08-16 22:01:21 -04:00
Shuts down a supervisor. This endpoint is deprecated and will be removed in future releases. Use the equivalent [terminate ](#terminate-a-supervisor ) endpoint instead.
2023-06-26 18:48:54 -04:00
2023-07-27 15:58:37 -04:00
#### URL
2023-06-26 18:48:54 -04:00
2024-04-12 12:19:13 -04:00
`POST` `/druid/indexer/v1/supervisor/{supervisorId}/shutdown`
