blob: f0321a1134e5016324e8934b12c435b1dadb7c52 [file] [log] [blame]
"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6800],{3905:(e,n,t)=>{t.d(n,{Zo:()=>p,kt:()=>f});var a=t(67294);function s(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function r(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?i(Object(t),!0).forEach((function(n){s(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function l(e,n){if(null==e)return{};var t,a,s=function(e,n){if(null==e)return{};var t,a,s={},i=Object.keys(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||(s[t]=e[t]);return s}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)t=i[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(s[t]=e[t])}return s}var o=a.createContext({}),u=function(e){var n=a.useContext(o),t=n;return e&&(t="function"==typeof e?e(n):r(r({},n),e)),t},p=function(e){var n=u(e.components);return a.createElement(o.Provider,{value:n},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},c=a.forwardRef((function(e,n){var t=e.components,s=e.mdxType,i=e.originalType,o=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=u(t),c=s,f=m["".concat(o,".").concat(c)]||m[c]||d[c]||i;return t?a.createElement(f,r(r({ref:n},p),{},{components:t})):a.createElement(f,r({ref:n},p))}));function f(e,n){var t=arguments,s=n&&n.mdxType;if("string"==typeof e||s){var i=t.length,r=new Array(i);r[0]=c;var l={};for(var o in n)hasOwnProperty.call(n,o)&&(l[o]=n[o]);l.originalType=e,l[m]="string"==typeof e?e:s,r[1]=l;for(var u=2;u<i;u++)r[u]=t[u];return a.createElement.apply(null,r)}return a.createElement.apply(null,t)}c.displayName="MDXCreateElement"},85162:(e,n,t)=>{t.d(n,{Z:()=>r});var a=t(67294),s=t(86010);const i={tabItem:"tabItem_Ymn6"};function r(e){var n=e.children,t=e.hidden,r=e.className;return a.createElement("div",{role:"tabpanel",className:(0,s.Z)(i.tabItem,r),hidden:t},n)}},74866:(e,n,t)=>{t.d(n,{Z:()=>R});var a=t(87462),s=t(67294),i=t(86010),r=t(12466),l=t(16550),o=t(91980),u=t(67392),p=t(50012);function m(e){return function(e){var n,t;return null!=(n=null==(t=s.Children.map(e,(function(e){if(!e||(0,s.isValidElement)(e)&&(n=e.props)&&"object"==typeof n&&"value"in n)return e;var n;throw new Error("Docusaurus error: Bad <Tabs> child <"+("string"==typeof e.type?e.type:e.type.name)+'>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.')})))?void 0:t.filter(Boolean))?n:[]}(e).map((function(e){var n=e.props;return{value:n.value,label:n.label,attributes:n.attributes,default:n.default}}))}function d(e){var n=e.values,t=e.children;return(0,s.useMemo)((function(){var e=null!=n?n:m(t);return function(e){var n=(0,u.l)(e,(function(e,n){return e.value===n.value}));if(n.length>0)throw new Error('Docusaurus error: Duplicate values "'+n.map((function(e){return e.value})).join(", ")+'" found in <Tabs>. Every value needs to be unique.')}(e),e}),[n,t])}function c(e){var n=e.value;return e.tabValues.some((function(e){return e.value===n}))}function f(e){var n=e.queryString,t=void 0!==n&&n,a=e.groupId,i=(0,l.k6)(),r=function(e){var n=e.queryString,t=void 0!==n&&n,a=e.groupId;if("string"==typeof t)return t;if(!1===t)return null;if(!0===t&&!a)throw new Error('Docusaurus error: The <Tabs> component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return null!=a?a:null}({queryString:t,groupId:a});return[(0,o._X)(r),(0,s.useCallback)((function(e){if(r){var n=new URLSearchParams(i.location.search);n.set(r,e),i.replace(Object.assign({},i.location,{search:n.toString()}))}}),[r,i])]}function g(e){var n,t,a,i,r=e.defaultValue,l=e.queryString,o=void 0!==l&&l,u=e.groupId,m=d(e),g=(0,s.useState)((function(){return function(e){var n,t=e.defaultValue,a=e.tabValues;if(0===a.length)throw new Error("Docusaurus error: the <Tabs> component requires at least one <TabItem> children component");if(t){if(!c({value:t,tabValues:a}))throw new Error('Docusaurus error: The <Tabs> has a defaultValue "'+t+'" but none of its children has the corresponding value. Available values are: '+a.map((function(e){return e.value})).join(", ")+". If you intend to show no default tab, use defaultValue={null} instead.");return t}var s=null!=(n=a.find((function(e){return e.default})))?n:a[0];if(!s)throw new Error("Unexpected error: 0 tabValues");return s.value}({defaultValue:r,tabValues:m})})),T=g[0],v=g[1],k=f({queryString:o,groupId:u}),y=k[0],S=k[1],R=(n=function(e){return e?"docusaurus.tab."+e:null}({groupId:u}.groupId),t=(0,p.Nk)(n),a=t[0],i=t[1],[a,(0,s.useCallback)((function(e){n&&i.set(e)}),[n,i])]),h=R[0],P=R[1],x=function(){var e=null!=y?y:h;return c({value:e,tabValues:m})?e:null}();return(0,s.useLayoutEffect)((function(){x&&v(x)}),[x]),{selectedValue:T,selectValue:(0,s.useCallback)((function(e){if(!c({value:e,tabValues:m}))throw new Error("Can't select invalid tab value="+e);v(e),S(e),P(e)}),[S,P,m]),tabValues:m}}var T=t(72389);const v={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};function k(e){var n=e.className,t=e.block,l=e.selectedValue,o=e.selectValue,u=e.tabValues,p=[],m=(0,r.o5)().blockElementScrollPositionUntilNextRender,d=function(e){var n=e.currentTarget,t=p.indexOf(n),a=u[t].value;a!==l&&(m(n),o(a))},c=function(e){var n,t=null;switch(e.key){case"Enter":d(e);break;case"ArrowRight":var a,s=p.indexOf(e.currentTarget)+1;t=null!=(a=p[s])?a:p[0];break;case"ArrowLeft":var i,r=p.indexOf(e.currentTarget)-1;t=null!=(i=p[r])?i:p[p.length-1]}null==(n=t)||n.focus()};return s.createElement("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,i.Z)("tabs",{"tabs--block":t},n)},u.map((function(e){var n=e.value,t=e.label,r=e.attributes;return s.createElement("li",(0,a.Z)({role:"tab",tabIndex:l===n?0:-1,"aria-selected":l===n,key:n,ref:function(e){return p.push(e)},onKeyDown:c,onClick:d},r,{className:(0,i.Z)("tabs__item",v.tabItem,null==r?void 0:r.className,{"tabs__item--active":l===n})}),null!=t?t:n)})))}function y(e){var n=e.lazy,t=e.children,a=e.selectedValue,i=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){var r=i.find((function(e){return e.props.value===a}));return r?(0,s.cloneElement)(r,{className:"margin-top--md"}):null}return s.createElement("div",{className:"margin-top--md"},i.map((function(e,n){return(0,s.cloneElement)(e,{key:n,hidden:e.props.value!==a})})))}function S(e){var n=g(e);return s.createElement("div",{className:(0,i.Z)("tabs-container",v.tabList)},s.createElement(k,(0,a.Z)({},e,n)),s.createElement(y,(0,a.Z)({},e,n)))}function R(e){var n=(0,T.Z)();return s.createElement(S,(0,a.Z)({key:String(n)},e))}},94322:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>p,default:()=>T,frontMatter:()=>u,metadata:()=>m,toc:()=>c});var a=t(87462),s=t(63366),i=(t(67294),t(3905)),r=t(74866),l=t(85162),o=["components"],u={id:"supervisor-api",title:"Supervisor API",sidebar_label:"Supervisors"},p=void 0,m={unversionedId:"api-reference/supervisor-api",id:"api-reference/supervisor-api",title:"Supervisor API",description:"\x3c!--",source:"@site/docs/27.0.0/api-reference/supervisor-api.md",sourceDirName:"api-reference",slug:"/api-reference/supervisor-api",permalink:"/docs/27.0.0/api-reference/supervisor-api",draft:!1,tags:[],version:"current",frontMatter:{id:"supervisor-api",title:"Supervisor API",sidebar_label:"Supervisors"},sidebar:"docs",previous:{title:"Tasks",permalink:"/docs/27.0.0/api-reference/tasks-api"},next:{title:"Retention rules",permalink:"/docs/27.0.0/api-reference/retention-rules-api"}},d={},c=[{value:"Supervisor information",id:"supervisor-information",level:2},{value:"Get an array of active supervisor IDs",id:"get-an-array-of-active-supervisor-ids",level:3},{value:"URL",id:"url",level:4},{value:"Responses",id:"responses",level:4},{value:"Sample request",id:"sample-request",level:4},{value:"Sample response",id:"sample-response",level:4},{value:"Get an array of active supervisor objects",id:"get-an-array-of-active-supervisor-objects",level:3},{value:"URL",id:"url-1",level:4},{value:"Responses",id:"responses-1",level:4},{value:"Sample request",id:"sample-request-1",level:4},{value:"Sample response",id:"sample-response-1",level:4},{value:"Get an array of supervisor states",id:"get-an-array-of-supervisor-states",level:3},{value:"URL",id:"url-2",level:4},{value:"Responses",id:"responses-2",level:4},{value:"Sample request",id:"sample-request-2",level:4},{value:"Sample response",id:"sample-response-2",level:4},{value:"Get supervisor specification",id:"get-supervisor-specification",level:3},{value:"URL",id:"url-3",level:4},{value:"Responses",id:"responses-3",level:4},{value:"Sample request",id:"sample-request-3",level:4},{value:"Sample response",id:"sample-response-3",level:4},{value:"Get supervisor status",id:"get-supervisor-status",level:3},{value:"URL",id:"url-4",level:4},{value:"Responses",id:"responses-4",level:4},{value:"Sample request",id:"sample-request-4",level:4},{value:"Sample response",id:"sample-response-4",level:4},{value:"Audit history",id:"audit-history",level:2},{value:"Get audit history for all supervisors",id:"get-audit-history-for-all-supervisors",level:3},{value:"URL",id:"url-5",level:4},{value:"Responses",id:"responses-5",level:4},{value:"Sample request",id:"sample-request-5",level:4},{value:"Sample response",id:"sample-response-5",level:4},{value:"Get audit history for a specific supervisor",id:"get-audit-history-for-a-specific-supervisor",level:3},{value:"URL",id:"url-6",level:4},{value:"Responses",id:"responses-6",level:4},{value:"Sample request",id:"sample-request-6",level:4},{value:"Sample response",id:"sample-response-6",level:4},{value:"Manage supervisors",id:"manage-supervisors",level:2},{value:"Create or update a supervisor",id:"create-or-update-a-supervisor",level:3},{value:"URL",id:"url-7",level:4},{value:"Responses",id:"responses-7",level:4},{value:"Sample request",id:"sample-request-7",level:4},{value:"Sample response",id:"sample-response-7",level:4},{value:"Suspend a running supervisor",id:"suspend-a-running-supervisor",level:3},{value:"URL",id:"url-8",level:4},{value:"Responses",id:"responses-8",level:4},{value:"Sample request",id:"sample-request-8",level:4},{value:"Sample response",id:"sample-response-8",level:4},{value:"Suspend all supervisors",id:"suspend-all-supervisors",level:3},{value:"URL",id:"url-9",level:4},{value:"Responses",id:"responses-9",level:4},{value:"Sample request",id:"sample-request-9",level:4},{value:"Sample response",id:"sample-response-9",level:4},{value:"Resume a supervisor",id:"resume-a-supervisor",level:3},{value:"URL",id:"url-10",level:4},{value:"Responses",id:"responses-10",level:4},{value:"Sample request",id:"sample-request-10",level:4},{value:"Sample response",id:"sample-response-10",level:4},{value:"Resume all supervisors",id:"resume-all-supervisors",level:3},{value:"URL",id:"url-11",level:4},{value:"Responses",id:"responses-11",level:4},{value:"Sample request",id:"sample-request-11",level:4},{value:"Sample response",id:"sample-response-11",level:4},{value:"Reset a supervisor",id:"reset-a-supervisor",level:3},{value:"URL",id:"url-12",level:4},{value:"Responses",id:"responses-12",level:4},{value:"Sample request",id:"sample-request-12",level:4},{value:"Sample response",id:"sample-response-12",level:4},{value:"Terminate a supervisor",id:"terminate-a-supervisor",level:3},{value:"URL",id:"url-13",level:4},{value:"Responses",id:"responses-13",level:4},{value:"Sample request",id:"sample-request-13",level:4},{value:"Sample response",id:"sample-response-13",level:4},{value:"Terminate all supervisors",id:"terminate-all-supervisors",level:3},{value:"URL",id:"url-14",level:4},{value:"Responses",id:"responses-14",level:4},{value:"Sample request",id:"sample-request-14",level:4},{value:"Sample response",id:"sample-response-14",level:4},{value:"Shut down a supervisor",id:"shut-down-a-supervisor",level:3},{value:"URL",id:"url-15",level:4}],f={toc:c},g="wrapper";function T(e){var n=e.components,t=(0,s.Z)(e,o);return(0,i.kt)(g,(0,a.Z)({},f,t,{components:n,mdxType:"MDXLayout"}),(0,i.kt)("p",null,"This topic describes the API endpoints to manage and monitor supervisors for Apache Druid."),(0,i.kt)("p",null,"In this topic, ",(0,i.kt)("inlineCode",{parentName:"p"},"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 ",(0,i.kt)("inlineCode",{parentName:"p"},"http://localhost:8888")," for quickstart deployments."),(0,i.kt)("h2",{id:"supervisor-information"},"Supervisor information"),(0,i.kt)("p",null,"The following table lists the properties of a supervisor object:"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"Property"),(0,i.kt)("th",{parentName:"tr",align:null},"Type"),(0,i.kt)("th",{parentName:"tr",align:null},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"id")),(0,i.kt)("td",{parentName:"tr",align:null},"String"),(0,i.kt)("td",{parentName:"tr",align:null},"Unique identifier.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"state")),(0,i.kt)("td",{parentName:"tr",align:null},"String"),(0,i.kt)("td",{parentName:"tr",align:null},"Generic state of the supervisor. Available states:",(0,i.kt)("inlineCode",{parentName:"td"},"UNHEALTHY_SUPERVISOR"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"UNHEALTHY_TASKS"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"PENDING"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"RUNNING"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"SUSPENDED"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"STOPPING"),". See ",(0,i.kt)("a",{parentName:"td",href:"/docs/27.0.0/development/extensions-core/kafka-supervisor-operations"},"Apache Kafka operations")," for details.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"detailedState")),(0,i.kt)("td",{parentName:"tr",align:null},"String"),(0,i.kt)("td",{parentName:"tr",align:null},"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 ",(0,i.kt)("inlineCode",{parentName:"td"},"state")," property. See ",(0,i.kt)("a",{parentName:"td",href:"/docs/27.0.0/development/extensions-core/kafka-ingestion"},"Apache Kafka ingestion")," and ",(0,i.kt)("a",{parentName:"td",href:"/docs/27.0.0/development/extensions-core/kinesis-ingestion"},"Amazon Kinesis ingestion")," for supervisor-specific states.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"healthy")),(0,i.kt)("td",{parentName:"tr",align:null},"Boolean"),(0,i.kt)("td",{parentName:"tr",align:null},"Supervisor health indicator.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"spec")),(0,i.kt)("td",{parentName:"tr",align:null},"Object"),(0,i.kt)("td",{parentName:"tr",align:null},"Container object for the supervisor configuration.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("inlineCode",{parentName:"td"},"suspended")),(0,i.kt)("td",{parentName:"tr",align:null},"Boolean"),(0,i.kt)("td",{parentName:"tr",align:null},"Indicates whether the supervisor is in a suspended state.")))),(0,i.kt)("h3",{id:"get-an-array-of-active-supervisor-ids"},"Get an array of active supervisor IDs"),(0,i.kt)("p",null,"Returns an array of strings representing the names of active supervisors. If there are no active supervisors, it returns an empty array."),(0,i.kt)("h4",{id:"url"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor"),(0,i.kt)("h4",{id:"responses"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"1",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved array of active supervisor IDs")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"2",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor"\n'))),(0,i.kt)(l.Z,{value:"3",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'[\n "wikipedia_stream",\n "social_media"\n]\n'))),(0,i.kt)("h3",{id:"get-an-array-of-active-supervisor-objects"},"Get an array of active supervisor objects"),(0,i.kt)("p",null,"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 ",(0,i.kt)("a",{parentName:"p",href:"#supervisor-information"},"table"),"."),(0,i.kt)("h4",{id:"url-1"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor?full"),(0,i.kt)("h4",{id:"responses-1"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"4",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved supervisor objects")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-1"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"5",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor?full=null"\n'))),(0,i.kt)(l.Z,{value:"6",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor?full=null HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-1"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'[\n {\n "id": "wikipedia_stream",\n "state": "RUNNING",\n "detailedState": "CONNECTING_TO_STREAM",\n "healthy": true,\n "spec": {\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "wikipedia_stream",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9042"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "wikipedia_stream",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9042"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n },\n "suspended": false\n },\n {\n "id": "social_media",\n "state": "RUNNING",\n "detailedState": "RUNNING",\n "healthy": true,\n "spec": {\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n },\n "suspended": false\n }\n]\n'))),(0,i.kt)("h3",{id:"get-an-array-of-supervisor-states"},"Get an array of supervisor states"),(0,i.kt)("p",null,"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 ",(0,i.kt)("a",{parentName:"p",href:"#supervisor-information"},"table"),"."),(0,i.kt)("h4",{id:"url-2"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor?state=true"),(0,i.kt)("h4",{id:"responses-2"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"7",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved supervisor state objects")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-2"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"8",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor?state=true"\n'))),(0,i.kt)(l.Z,{value:"9",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor?state=true HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-2"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'[\n {\n "id": "wikipedia_stream",\n "state": "UNHEALTHY_SUPERVISOR",\n "detailedState": "UNABLE_TO_CONNECT_TO_STREAM",\n "healthy": false,\n "suspended": false\n },\n {\n "id": "social_media",\n "state": "RUNNING",\n "detailedState": "RUNNING",\n "healthy": true,\n "suspended": false\n }\n]\n'))),(0,i.kt)("h3",{id:"get-supervisor-specification"},"Get supervisor specification"),(0,i.kt)("p",null,"Retrieves the specification for a single supervisor. The returned specification includes the ",(0,i.kt)("inlineCode",{parentName:"p"},"dataSchema"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"ioConfig"),", and ",(0,i.kt)("inlineCode",{parentName:"p"},"tuningConfig")," objects."),(0,i.kt)("h4",{id:"url-3"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId"),(0,i.kt)("h4",{id:"responses-3"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"10",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved supervisor spec"))),(0,i.kt)(l.Z,{value:"11",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-3"},"Sample request"),(0,i.kt)("p",null,"The following example shows how to retrieve the specification of a supervisor with the name ",(0,i.kt)("inlineCode",{parentName:"p"},"wikipedia_stream"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"12",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/wikipedia_stream"\n'))),(0,i.kt)(l.Z,{value:"13",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor/wikipedia_stream HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-3"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n}\n'))),(0,i.kt)("h3",{id:"get-supervisor-status"},"Get supervisor status"),(0,i.kt)("p",null,"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."),(0,i.kt)("p",null,"For additional information about the status report, see the topic for each streaming ingestion methods:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/27.0.0/development/extensions-core/kinesis-ingestion#get-supervisor-status-report"},"Amazon Kinesis")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/27.0.0/development/extensions-core/kafka-supervisor-operations#getting-supervisor-status-report"},"Apache Kafka"))),(0,i.kt)("h4",{id:"url-4"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/status"),(0,i.kt)("h4",{id:"responses-4"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"14",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved supervisor status"))),(0,i.kt)(l.Z,{value:"15",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-4"},"Sample request"),(0,i.kt)("p",null,"The following example shows how to retrieve the status of a supervisor with the name ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"16",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/status"\n'))),(0,i.kt)(l.Z,{value:"17",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor/social_media/status HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-4"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "id": "social_media",\n "generationTime": "2023-07-05T23:24:43.934Z",\n "payload": {\n "dataSource": "social_media",\n "stream": "social_media",\n "partitions": 1,\n "replicas": 1,\n "durationSeconds": 3600,\n "activeTasks": [\n {\n "id": "index_kafka_social_media_ab72ae4127c591c_flcbhdlh",\n "startingOffsets": {\n "0": 3176381\n },\n "startTime": "2023-07-05T23:21:39.321Z",\n "remainingSeconds": 3415,\n "type": "ACTIVE",\n "currentOffsets": {\n "0": 3296632\n },\n "lag": {\n "0": 3\n }\n }\n ],\n "publishingTasks": [],\n "latestOffsets": {\n "0": 3296635\n },\n "minimumLag": {\n "0": 3\n },\n "aggregateLag": 3,\n "offsetsLastUpdated": "2023-07-05T23:24:30.212Z",\n "suspended": false,\n "healthy": true,\n "state": "RUNNING",\n "detailedState": "RUNNING",\n "recentErrors": []\n }\n}\n'))),(0,i.kt)("h2",{id:"audit-history"},"Audit history"),(0,i.kt)("p",null,"An audit history provides a comprehensive log of events, including supervisor configuration, creation, suspension, and modification history."),(0,i.kt)("h3",{id:"get-audit-history-for-all-supervisors"},"Get audit history for all supervisors"),(0,i.kt)("p",null,"Retrieve an audit history of specs for all supervisors."),(0,i.kt)("h4",{id:"url-5"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/history"),(0,i.kt)("h4",{id:"responses-5"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"18",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved audit history")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-5"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"19",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/history"\n'))),(0,i.kt)(l.Z,{value:"20",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor/history HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-5"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "social_media": [\n {\n "spec": {\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n },\n "version": "2023-07-03T18:51:02.970Z"\n }\n ]\n}\n'))),(0,i.kt)("h3",{id:"get-audit-history-for-a-specific-supervisor"},"Get audit history for a specific supervisor"),(0,i.kt)("p",null,"Retrieves an audit history of specs for a single supervisor."),(0,i.kt)("h4",{id:"url-6"},"URL"),(0,i.kt)("code",{class:"getAPI"},"GET")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/history"),(0,i.kt)("h4",{id:"responses-6"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"21",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully retrieved supervisor audit history"))),(0,i.kt)(l.Z,{value:"22",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-6"},"Sample request"),(0,i.kt)("p",null,"The following example shows how to retrieve the audit history of a supervisor with the name ",(0,i.kt)("inlineCode",{parentName:"p"},"wikipedia_stream"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"23",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/wikipedia_stream/history"\n'))),(0,i.kt)(l.Z,{value:"24",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"GET /druid/indexer/v1/supervisor/wikipedia_stream/history HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-6"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'[\n {\n "spec": {\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "wikipedia_stream",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9042"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "wikipedia_stream",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9042"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n },\n "version": "2023-07-05T20:59:16.872Z"\n }\n]\n'))),(0,i.kt)("h2",{id:"manage-supervisors"},"Manage supervisors"),(0,i.kt)("h3",{id:"create-or-update-a-supervisor"},"Create or update a supervisor"),(0,i.kt)("p",null,"Creates a new supervisor or updates an existing one for the same datasource with a new schema and configuration."),(0,i.kt)("p",null,"You can define a supervisor spec for ",(0,i.kt)("a",{parentName:"p",href:"/docs/27.0.0/development/extensions-core/kafka-ingestion#define-a-supervisor-spec"},"Apache Kafka")," or ",(0,i.kt)("a",{parentName:"p",href:"/docs/27.0.0/development/extensions-core/kinesis-ingestion#supervisor-spec"},"Amazon Kinesis")," streaming ingestion methods. Once created, the supervisor persists in the metadata database."),(0,i.kt)("p",null,"When you call this endpoint on an existing supervisor for the same datasource, 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."),(0,i.kt)("h4",{id:"url-7"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor"),(0,i.kt)("h4",{id:"responses-7"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"25",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully created a new supervisor or updated an existing supervisor"))),(0,i.kt)(l.Z,{value:"26",label:"415 UNSUPPORTED MEDIA TYPE",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Request body content type is not in JSON format")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-7"},"Sample request"),(0,i.kt)("p",null,"The following example uses JSON input format to create a supervisor spec for Kafka with a ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media")," datasource and ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media")," topic."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"27",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor" \\\n--header \'Content-Type: application/json\' \\\n--data \'{\n "type": "kafka",\n "spec": {\n "ioConfig": {\n "type": "kafka",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "topic": "social_media",\n "inputFormat": {\n "type": "json"\n },\n "useEarliestOffset": true\n },\n "tuningConfig": {\n "type": "kafka"\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso"\n },\n "dimensionsSpec": {\n "dimensions": [\n "username",\n "post_title",\n {\n "type": "long",\n "name": "views"\n },\n {\n "type": "long",\n "name": "upvotes"\n },\n {\n "type": "long",\n "name": "comments"\n },\n "edited"\n ]\n },\n "granularitySpec": {\n "queryGranularity": "none",\n "rollup": false,\n "segmentGranularity": "hour"\n }\n }\n }\n}\'\n'))),(0,i.kt)(l.Z,{value:"28",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},'POST /druid/indexer/v1/supervisor HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\nContent-Type: application/json\nContent-Length: 1359\n\n{\n "type": "kafka",\n "spec": {\n "ioConfig": {\n "type": "kafka",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "topic": "social_media",\n "inputFormat": {\n "type": "json"\n },\n "useEarliestOffset": true\n },\n "tuningConfig": {\n "type": "kafka"\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso"\n },\n "dimensionsSpec": {\n "dimensions": [\n "username",\n "post_title",\n {\n "type": "long",\n "name": "views"\n },\n {\n "type": "long",\n "name": "upvotes"\n },\n {\n "type": "long",\n "name": "comments"\n },\n "edited"\n ]\n },\n "granularitySpec": {\n "queryGranularity": "none",\n "rollup": false,\n "segmentGranularity": "hour"\n }\n }\n }\n}\n')))),(0,i.kt)("h4",{id:"sample-response-7"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "id": "social_media"\n}\n'))),(0,i.kt)("h3",{id:"suspend-a-running-supervisor"},"Suspend a running supervisor"),(0,i.kt)("p",null,"Suspends a single running supervisor. Returns the updated supervisor spec, where the ",(0,i.kt)("inlineCode",{parentName:"p"},"suspended")," property is set to ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),". The suspended supervisor continues to emit logs and metrics."),(0,i.kt)("h4",{id:"url-8"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/suspend"),(0,i.kt)("h4",{id:"responses-8"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"29",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully shut down supervisor"))),(0,i.kt)(l.Z,{value:"30",label:"400 BAD REQUEST",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Supervisor already suspended"))),(0,i.kt)(l.Z,{value:"31",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-8"},"Sample request"),(0,i.kt)("p",null,"The following example shows how to suspend a running supervisor with the name ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"32",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/suspend"\n'))),(0,i.kt)(l.Z,{value:"33",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/social_media/suspend HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-8"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": true\n}\n'))),(0,i.kt)("h3",{id:"suspend-all-supervisors"},"Suspend all supervisors"),(0,i.kt)("p",null,"Suspends all supervisors. Note that this endpoint returns an HTTP ",(0,i.kt)("inlineCode",{parentName:"p"},"200 Success")," code message even if there are no supervisors or running supervisors to suspend."),(0,i.kt)("h4",{id:"url-9"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/suspendAll"),(0,i.kt)("h4",{id:"responses-9"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"34",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully suspended all supervisors")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-9"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"35",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/suspendAll"\n'))),(0,i.kt)(l.Z,{value:"36",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/suspendAll HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-9"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "status": "success"\n}\n'))),(0,i.kt)("h3",{id:"resume-a-supervisor"},"Resume a supervisor"),(0,i.kt)("p",null,"Resumes indexing tasks for a supervisor. Returns an updated supervisor spec with the ",(0,i.kt)("inlineCode",{parentName:"p"},"suspended")," property set to ",(0,i.kt)("inlineCode",{parentName:"p"},"false"),"."),(0,i.kt)("h4",{id:"url-10"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/resume"),(0,i.kt)("h4",{id:"responses-10"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"37",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully resumed supervisor"))),(0,i.kt)(l.Z,{value:"38",label:"400 BAD REQUEST",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Supervisor already running"))),(0,i.kt)(l.Z,{value:"39",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-10"},"Sample request"),(0,i.kt)("p",null,"The following example resumes a previously suspended supervisor with name ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"40",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/resume"\n'))),(0,i.kt)(l.Z,{value:"41",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/social_media/resume HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-10"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "type": "kafka",\n "spec": {\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n }\n },\n "dataSchema": {\n "dataSource": "social_media",\n "timestampSpec": {\n "column": "__time",\n "format": "iso",\n "missingValue": null\n },\n "dimensionsSpec": {\n "dimensions": [\n {\n "type": "string",\n "name": "username",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "string",\n "name": "post_title",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n },\n {\n "type": "long",\n "name": "views",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "upvotes",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "long",\n "name": "comments",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": false\n },\n {\n "type": "string",\n "name": "edited",\n "multiValueHandling": "SORTED_ARRAY",\n "createBitmapIndex": true\n }\n ],\n "dimensionExclusions": [\n "__time"\n ],\n "includeAllDimensions": false,\n "useSchemaDiscovery": false\n },\n "metricsSpec": [],\n "granularitySpec": {\n "type": "uniform",\n "segmentGranularity": "HOUR",\n "queryGranularity": {\n "type": "none"\n },\n "rollup": false,\n "intervals": []\n },\n "transformSpec": {\n "filter": null,\n "transforms": []\n }\n },\n "tuningConfig": {\n "type": "kafka",\n "appendableIndexSpec": {\n "type": "onheap",\n "preserveExistingMetrics": false\n },\n "maxRowsInMemory": 150000,\n "maxBytesInMemory": 0,\n "skipBytesInMemoryOverheadCheck": false,\n "maxRowsPerSegment": 5000000,\n "maxTotalRows": null,\n "intermediatePersistPeriod": "PT10M",\n "maxPendingPersists": 0,\n "indexSpec": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "indexSpecForIntermediatePersists": {\n "bitmap": {\n "type": "roaring"\n },\n "dimensionCompression": "lz4",\n "stringDictionaryEncoding": {\n "type": "utf8"\n },\n "metricCompression": "lz4",\n "longEncoding": "longs"\n },\n "reportParseExceptions": false,\n "handoffConditionTimeout": 0,\n "resetOffsetAutomatically": false,\n "segmentWriteOutMediumFactory": null,\n "workerThreads": null,\n "chatThreads": null,\n "chatRetries": 8,\n "httpTimeout": "PT10S",\n "shutdownTimeout": "PT80S",\n "offsetFetchPeriod": "PT30S",\n "intermediateHandoffPeriod": "P2147483647D",\n "logParseExceptions": false,\n "maxParseExceptions": 2147483647,\n "maxSavedParseExceptions": 0,\n "skipSequenceNumberAvailabilityCheck": false,\n "repartitionTransitionDuration": "PT120S"\n },\n "ioConfig": {\n "topic": "social_media",\n "inputFormat": {\n "type": "json",\n "keepNullColumns": false,\n "assumeNewlineDelimited": false,\n "useJsonNodeReader": false\n },\n "replicas": 1,\n "taskCount": 1,\n "taskDuration": "PT3600S",\n "consumerProperties": {\n "bootstrap.servers": "localhost:9094"\n },\n "autoScalerConfig": null,\n "pollTimeout": 100,\n "startDelay": "PT5S",\n "period": "PT30S",\n "useEarliestOffset": true,\n "completionTimeout": "PT1800S",\n "lateMessageRejectionPeriod": null,\n "earlyMessageRejectionPeriod": null,\n "lateMessageRejectionStartDateTime": null,\n "configOverrides": null,\n "idleConfig": null,\n "stream": "social_media",\n "useEarliestSequenceNumber": true\n },\n "context": null,\n "suspended": false\n}\n'))),(0,i.kt)("h3",{id:"resume-all-supervisors"},"Resume all supervisors"),(0,i.kt)("p",null,"Resumes all supervisors. Note that this endpoint returns an HTTP ",(0,i.kt)("inlineCode",{parentName:"p"},"200 Success")," code even if there are no supervisors or suspended supervisors to resume."),(0,i.kt)("h4",{id:"url-11"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/resumeAll"),(0,i.kt)("h4",{id:"responses-11"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"42",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully resumed all supervisors")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-11"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"43",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/resumeAll"\n'))),(0,i.kt)(l.Z,{value:"44",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/resumeAll HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-11"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "status": "success"\n}\n'))),(0,i.kt)("h3",{id:"reset-a-supervisor"},"Reset a supervisor"),(0,i.kt)("p",null,"Resets the specified supervisor. This endpoint clears stored offsets in Kafka or sequence numbers in Kinesis, prompting the supervisor to resume data reading. The supervisor will start from the earliest or latest available position, depending on the platform (offsets in Kafka or sequence numbers in Kinesis). It kills and recreates active tasks to read from valid positions."),(0,i.kt)("p",null,"Use this endpoint to recover from a stopped state due to missing offsets in Kafka or sequence numbers in Kinesis. Use this endpoint with caution as it may result in skipped messages and lead to data loss or duplicate data."),(0,i.kt)("h4",{id:"url-12"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/reset"),(0,i.kt)("h4",{id:"responses-12"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"45",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully reset supervisor"))),(0,i.kt)(l.Z,{value:"46",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-12"},"Sample request"),(0,i.kt)("p",null,"The following example shows how to reset a supervisor with the name ",(0,i.kt)("inlineCode",{parentName:"p"},"social_media"),"."),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"47",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/reset"\n'))),(0,i.kt)(l.Z,{value:"48",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/social_media/reset HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-12"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "id": "social_media"\n}\n'))),(0,i.kt)("h3",{id:"terminate-a-supervisor"},"Terminate a supervisor"),(0,i.kt)("p",null,"Terminates a supervisor and its associated indexing tasks, triggering the publishing of their segments. When terminated, a tombstone marker is placed in the database to prevent reloading on restart."),(0,i.kt)("p",null,"The terminated supervisor still exists in the metadata store and its history can be retrieved."),(0,i.kt)("h4",{id:"url-13"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/terminate"),(0,i.kt)("h4",{id:"responses-13"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"49",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully terminated a supervisor"))),(0,i.kt)(l.Z,{value:"50",label:"404 NOT FOUND",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Invalid supervisor ID or supervisor not running")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-13"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"51",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/social_media/terminate"\n'))),(0,i.kt)(l.Z,{value:"52",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/social_media/terminate HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-13"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "id": "social_media"\n}\n'))),(0,i.kt)("h3",{id:"terminate-all-supervisors"},"Terminate all supervisors"),(0,i.kt)("p",null,"Terminates all supervisors. Terminated supervisors still exist in the metadata store and their history can be retrieved. Note that this endpoint returns an HTTP ",(0,i.kt)("inlineCode",{parentName:"p"},"200 Success")," code even if there are no supervisors or running supervisors to terminate."),(0,i.kt)("h4",{id:"url-14"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/terminateAll"),(0,i.kt)("h4",{id:"responses-14"},"Responses"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"53",label:"200 SUCCESS",mdxType:"TabItem"},(0,i.kt)("p",null,(0,i.kt)("em",{parentName:"p"},"Successfully terminated all supervisors")))),(0,i.kt)("hr",null),(0,i.kt)("h4",{id:"sample-request-14"},"Sample request"),(0,i.kt)(r.Z,{mdxType:"Tabs"},(0,i.kt)(l.Z,{value:"54",label:"cURL",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-shell"},'curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/indexer/v1/supervisor/terminateAll"\n'))),(0,i.kt)(l.Z,{value:"55",label:"HTTP",mdxType:"TabItem"},(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-HTTP"},"POST /druid/indexer/v1/supervisor/terminateAll HTTP/1.1\nHost: http://ROUTER_IP:ROUTER_PORT\n")))),(0,i.kt)("h4",{id:"sample-response-14"},"Sample response"),(0,i.kt)("details",null,(0,i.kt)("summary",null,"Click to show sample response"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "status": "success"\n}\n'))),(0,i.kt)("h3",{id:"shut-down-a-supervisor"},"Shut down a supervisor"),(0,i.kt)("p",null,"Shuts down a supervisor. This endpoint is deprecated and will be removed in future releases. Use the equivalent ",(0,i.kt)("a",{parentName:"p",href:"#terminate-a-supervisor"},"terminate")," endpoint instead."),(0,i.kt)("h4",{id:"url-15"},"URL"),(0,i.kt)("code",{class:"postAPI"},"POST")," ",(0,i.kt)("code",null,"/druid/indexer/v1/supervisor/:supervisorId/shutdown"))}T.isMDXComponent=!0}}]);