ektravel commented on code in PR #14740: URL: https://github.com/apache/druid/pull/14740#discussion_r1290633458
########## docs/api-reference/automatic-compaction-api.md: ########## @@ -23,69 +23,762 @@ sidebar_label: Automatic compaction ~ under the License. --> -This document describes status and configuration API endpoints for [automatic compaction](../data-management/automatic-compaction.md) in Apache Druid. +This topic describes status and configuration API endpoints for [automatic compaction](../data-management/automatic-compaction.md) in Apache Druid. You can configure automatic compaction in the Druid web console or API. -## Automatic compaction status +In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. Replace it with the information for your deployment. For example, use `http://localhost:8888` for quickstart deployments. + +## Manage automatic compaction + +### Update capacity for compaction tasks + +Update the capacity for compaction tasks. The minimum number of compaction tasks is 1 and the maximum is 2147483652. + +#### URL + +<code class="postAPI">POST</code> <code>/druid/coordinator/v1/config/compaction/taskslots</code> + +#### Query parameters + +To limit the maximum number of compaction tasks, use the optional query parameters `ratio` and `max`: + +* `ratio` (optional) + * Type: Float + * Default: 0.1 + * Limit the ratio of the total task slots to compaction task slots. +* `max` (optional) + * Type: Int + * Default: 2147483647 + * Limit the maximum number of task slots for compaction tasks. + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully updated compaction configuration* + +<!--404 NOT FOUND--> + +*Invalid `max` value* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- + +#### Sample request + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> + +```shell +curl --request POST "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction/taskslots?ratio=0.2&max=250000"; +``` + +<!--HTTP--> + +```HTTP +POST /druid/coordinator/v1/config/compaction/taskslots?ratio=0.2&max=250000 HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` + +<!--END_DOCUSAURUS_CODE_TABS--> + +#### Sample response + +A successful request returns an HTTP `200 OK` message code and an empty response body. + +### Create or update automatic compaction configuration + +Creates or updates the automatic compaction configuration for a datasource. You pass the automatic compaction as a JSON object in the request body. + +Automatic compaction configuration require only the `dataSource` property. Druid fills all other properties with default values if not specified. See [Automatic compaction dynamic configuration](../configuration/index.md#automatic-compaction-dynamic-configuration) for configuration details. + +Note that this endpoint returns an HTTP `200 OK` message code even if the datasource name does not exist. + +#### URL + +<code class="postAPI">POST</code> <code>/druid/coordinator/v1/config/compaction</code> + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully submitted auto compaction configuration* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- +#### Sample request + +The following example creates an automatic compaction configuration for datasource `wikipedia_hour`. This automatic compaction configuration performs compaction on `wikipedia_hour`, resulting in compacted segments that represent a day interval of data. In this example: + +* `wikipedia_hour` is a datasource with `HOUR` segment granularity. +* `skipOffsetFromLatest` is set to `PT0S`, meaning that no data is skipped. +* `partitionsSpec` is set to the default `dynamic`, allowing Druid to dynamically determine the optimal partitioning strategy. +* `type` is set to `index_parallel`, meaning that parallel indexing is used. +* `segmentGranularity` is set to `DAY`, meaning that each compacted segment is a day of data. + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> -`GET /druid/coordinator/v1/compaction/progress?dataSource={dataSource}` +```shell +curl "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction"\ +--header 'Content-Type: application/json' \ +--data '{ + "dataSource": "wikipedia_hour", + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "partitionsSpec": { + "type": "dynamic" + }, + "type": "index_parallel" + }, + "granularitySpec": { + "segmentGranularity": "DAY" + } +}' +``` -Returns the total size of segments awaiting compaction for the given dataSource. The specified dataSource must have [automatic compaction](../data-management/automatic-compaction.md) enabled. +<!--HTTP--> -`GET /druid/coordinator/v1/compaction/status` +```HTTP +POST /druid/coordinator/v1/config/compaction HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +Content-Type: application/json +Content-Length: 281 -Returns the status and statistics from the auto-compaction run of all dataSources which have auto-compaction enabled in the latest run. The response payload includes a list of `latestStatus` objects. Each `latestStatus` represents the status for a dataSource (which has/had auto-compaction enabled). +{ + "dataSource": "wikipedia_hour", + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "partitionsSpec": { + "type": "dynamic" + }, + "type": "index_parallel" + }, + "granularitySpec": { + "segmentGranularity": "DAY" + } +} +``` -The `latestStatus` object has the following keys: -* `dataSource`: name of the datasource for this status information -* `scheduleStatus`: auto-compaction scheduling status. Possible values are `NOT_ENABLED` and `RUNNING`. Returns `RUNNING ` if the dataSource has an active auto-compaction config submitted. Otherwise, returns `NOT_ENABLED`. -* `bytesAwaitingCompaction`: total bytes of this datasource waiting to be compacted by the auto-compaction (only consider intervals/segments that are eligible for auto-compaction) -* `bytesCompacted`: total bytes of this datasource that are already compacted with the spec set in the auto-compaction config -* `bytesSkipped`: total bytes of this datasource that are skipped (not eligible for auto-compaction) by the auto-compaction -* `segmentCountAwaitingCompaction`: total number of segments of this datasource waiting to be compacted by the auto-compaction (only consider intervals/segments that are eligible for auto-compaction) -* `segmentCountCompacted`: total number of segments of this datasource that are already compacted with the spec set in the auto-compaction config -* `segmentCountSkipped`: total number of segments of this datasource that are skipped (not eligible for auto-compaction) by the auto-compaction -* `intervalCountAwaitingCompaction`: total number of intervals of this datasource waiting to be compacted by the auto-compaction (only consider intervals/segments that are eligible for auto-compaction) -* `intervalCountCompacted`: total number of intervals of this datasource that are already compacted with the spec set in the auto-compaction config -* `intervalCountSkipped`: total number of intervals of this datasource that are skipped (not eligible for auto-compaction) by the auto-compaction +<!--END_DOCUSAURUS_CODE_TABS--> -`GET /druid/coordinator/v1/compaction/status?dataSource={dataSource}` +#### Sample response -Similar to the API `/druid/coordinator/v1/compaction/status` above but filters response to only return information for the dataSource given. -The dataSource must have auto-compaction enabled. +A successful request returns an HTTP `200 OK` message code and an empty response body. + + +### Remove automatic compaction configuration + +Removes the automatic compaction configuration for a datasource. This updates the compaction status of the datasource to "Not enabled." + +#### URL + +<code class="deleteAPI">DELETE</code> <code>/druid/coordinator/v1/config/compaction/:dataSource</code> + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully deleted automatic compaction configuration* + +<!--404 NOT FOUND--> + +*Datasource does not have automatic compaction or invalid datasource name* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- + + +#### Sample request + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> + +```shell +curl --request DELETE "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction/wikipedia_hour"; +``` + +<!--HTTP--> + +```HTTP +DELETE /druid/coordinator/v1/config/compaction/wikipedia_hour HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` + +<!--END_DOCUSAURUS_CODE_TABS--> + +#### Sample response + +A successful request returns an HTTP `200 OK` message code and an empty response body. ## Automatic compaction configuration -`GET /druid/coordinator/v1/config/compaction` +### Get all automatic compaction configurations + +Retrieves all automatic compaction configurations. Returns a `compactionConfigs` object containing the active automatic compaction configuration of all datasources. + +You can use this endpoint to retrieve `compactionTaskSlotRatio` and `maxCompactionTaskSlots` values for managing resource allocation of compaction tasks. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction</code> + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully retrieved automatic compaction configurations* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- + +#### Sample request + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> + +```shell +curl "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction"; +``` + +<!--HTTP--> + +```HTTP +GET /druid/coordinator/v1/config/compaction HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` + +<!--END_DOCUSAURUS_CODE_TABS--> + +#### Sample response + +<details> + <summary>Click to show sample response</summary> -Returns all automatic compaction configs. +```json +{ + "compactionConfigs": [ + { + "dataSource": "wikipedia_hour", + "taskPriority": 25, + "inputSegmentSizeBytes": 100000000000000, + "maxRowsPerSegment": null, + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "maxRowsInMemory": null, + "appendableIndexSpec": null, + "maxBytesInMemory": null, + "maxTotalRows": null, + "splitHintSpec": null, + "partitionsSpec": { + "type": "dynamic", + "maxRowsPerSegment": 5000000, + "maxTotalRows": null + }, + "indexSpec": null, + "indexSpecForIntermediatePersists": null, + "maxPendingPersists": null, + "pushTimeout": null, + "segmentWriteOutMediumFactory": null, + "maxNumConcurrentSubTasks": null, + "maxRetry": null, + "taskStatusCheckPeriodMs": null, + "chatHandlerTimeout": null, + "chatHandlerNumRetries": null, + "maxNumSegmentsToMerge": null, + "totalNumMergeTasks": null, + "maxColumnsToMerge": null, + "type": "index_parallel", + "forceGuaranteedRollup": false + }, + "granularitySpec": { + "segmentGranularity": "DAY", + "queryGranularity": null, + "rollup": null + }, + "dimensionsSpec": null, + "metricsSpec": null, + "transformSpec": null, + "ioConfig": null, + "taskContext": null + }, + { + "dataSource": "wikipedia", + "taskPriority": 25, + "inputSegmentSizeBytes": 100000000000000, + "maxRowsPerSegment": null, + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "maxRowsInMemory": null, + "appendableIndexSpec": null, + "maxBytesInMemory": null, + "maxTotalRows": null, + "splitHintSpec": null, + "partitionsSpec": { + "type": "dynamic", + "maxRowsPerSegment": 5000000, + "maxTotalRows": null + }, + "indexSpec": null, + "indexSpecForIntermediatePersists": null, + "maxPendingPersists": null, + "pushTimeout": null, + "segmentWriteOutMediumFactory": null, + "maxNumConcurrentSubTasks": null, + "maxRetry": null, + "taskStatusCheckPeriodMs": null, + "chatHandlerTimeout": null, + "chatHandlerNumRetries": null, + "maxNumSegmentsToMerge": null, + "totalNumMergeTasks": null, + "maxColumnsToMerge": null, + "type": "index_parallel", + "forceGuaranteedRollup": false + }, + "granularitySpec": { + "segmentGranularity": "DAY", + "queryGranularity": null, + "rollup": null + }, + "dimensionsSpec": null, + "metricsSpec": null, + "transformSpec": null, + "ioConfig": null, + "taskContext": null + } + ], + "compactionTaskSlotRatio": 0.1, + "maxCompactionTaskSlots": 2147483647, + "useAutoScaleSlots": false +} +``` +</details> -`GET /druid/coordinator/v1/config/compaction/{dataSource}` +### Get automatic compaction configuration -Returns an automatic compaction config of a dataSource. +Retrieves the automatic compaction configuration of a datasource. -`GET /druid/coordinator/v1/config/compaction/{dataSource}/history?interval={interval}&count={count}` +#### URL -Returns the history of the automatic compaction config for a dataSource. Optionally accepts `interval` and `count` -query string parameters to filter by interval and limit the number of results respectively. If the dataSource does not -exist or there is no compaction history for the dataSource, an empty list is returned. +<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction/:dataSource</code> + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully retrieved configuration for datasource* + +<!--404 NOT FOUND--> + +*Invalid datasource or datasource does not have automatic compaction enabled* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- + +#### Sample request + +The following example retrieves the automatic compaction configuration for datasource `wikipedia_hour`. + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> + +```shell +curl "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction/wikipedia_hour"; +``` + +<!--HTTP--> + +```HTTP +GET /druid/coordinator/v1/config/compaction/wikipedia_hour HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` + +<!--END_DOCUSAURUS_CODE_TABS--> + +#### Sample response + +<details> + <summary>Click to show sample response</summary> + +```json +{ + "dataSource": "wikipedia_hour", + "taskPriority": 25, + "inputSegmentSizeBytes": 100000000000000, + "maxRowsPerSegment": null, + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "maxRowsInMemory": null, + "appendableIndexSpec": null, + "maxBytesInMemory": null, + "maxTotalRows": null, + "splitHintSpec": null, + "partitionsSpec": { + "type": "dynamic", + "maxRowsPerSegment": 5000000, + "maxTotalRows": null + }, + "indexSpec": null, + "indexSpecForIntermediatePersists": null, + "maxPendingPersists": null, + "pushTimeout": null, + "segmentWriteOutMediumFactory": null, + "maxNumConcurrentSubTasks": null, + "maxRetry": null, + "taskStatusCheckPeriodMs": null, + "chatHandlerTimeout": null, + "chatHandlerNumRetries": null, + "maxNumSegmentsToMerge": null, + "totalNumMergeTasks": null, + "maxColumnsToMerge": null, + "type": "index_parallel", + "forceGuaranteedRollup": false + }, + "granularitySpec": { + "segmentGranularity": "DAY", + "queryGranularity": null, + "rollup": null + }, + "dimensionsSpec": null, + "metricsSpec": null, + "transformSpec": null, + "ioConfig": null, + "taskContext": null +} +``` +</details> + +### Get automatic compaction configuration history + +Retrieves the history of the automatic compaction configuration for a datasource. Returns an empty list if the datasource does not exist or there is no compaction history for the datasource. The response contains a list of objects with the following keys: -* `globalConfig`: A json object containing automatic compaction config that applies to the entire cluster. -* `compactionConfig`: A json object containing the automatic compaction config for the datasource. -* `auditInfo`: A json object that contains information about the change made - like `author`, `comment` and `ip`. +* `globalConfig`: A JSON object containing automatic compaction configuration that applies to the entire cluster. +* `compactionConfig`: A JSON object containing the automatic compaction configuration for the datasource. +* `auditInfo`: A JSON object that contains information about the change made, such as `author`, `comment` or `ip`. * `auditTime`: The date and time when the change was made. -`POST /druid/coordinator/v1/config/compaction/taskslots?ratio={someRatio}&max={someMaxSlots}` +#### URL + +<code class="getAPI">GET</code> <code>/druid/coordinator/v1/config/compaction/:dataSource/history</code> + +#### Query parameters +* `interval` (optional) + * Type: ISO-8601 + * Limit the results within a specified interval. Use `/` as the delimiter for the interval string. +* `count` (optional) + * Type: Int + * Limit the number of results. + +#### Responses + +<!--DOCUSAURUS_CODE_TABS--> + +<!--200 SUCCESS--> + +*Successfully retrieved configuration history* + +<!--400 BAD REQUEST--> + +*Invalid `count` value* + +<!--END_DOCUSAURUS_CODE_TABS--> + +--- + +#### Sample request + +<!--DOCUSAURUS_CODE_TABS--> + +<!--cURL--> + +```shell +curl "http://ROUTER_IP:ROUTER_PORT/druid/coordinator/v1/config/compaction/wikipedia_hour/history"; +``` + +<!--HTTP--> + +```HTTP +GET /druid/coordinator/v1/config/compaction/wikipedia_hour/history HTTP/1.1 +Host: http://ROUTER_IP:ROUTER_PORT +``` + +<!--END_DOCUSAURUS_CODE_TABS--> + +#### Sample response + +<details> + <summary>Click to show sample response</summary> + +```json +[ + { + "globalConfig": { + "compactionTaskSlotRatio": 0.1, + "maxCompactionTaskSlots": 2147483647, + "useAutoScaleSlots": false + }, + "compactionConfig": { + "dataSource": "wikipedia_hour", + "taskPriority": 25, + "inputSegmentSizeBytes": 100000000000000, + "maxRowsPerSegment": null, + "skipOffsetFromLatest": "P1D", + "tuningConfig": null, + "granularitySpec": { + "segmentGranularity": "DAY", + "queryGranularity": null, + "rollup": null + }, + "dimensionsSpec": null, + "metricsSpec": null, + "transformSpec": null, + "ioConfig": null, + "taskContext": null + }, + "auditInfo": { + "author": "", + "comment": "", + "ip": "127.0.0.1" + }, + "auditTime": "2023-07-31T18:15:19.302Z" + }, + { + "globalConfig": { + "compactionTaskSlotRatio": 0.1, + "maxCompactionTaskSlots": 2147483647, + "useAutoScaleSlots": false + }, + "compactionConfig": { + "dataSource": "wikipedia_hour", + "taskPriority": 25, + "inputSegmentSizeBytes": 100000000000000, + "maxRowsPerSegment": null, + "skipOffsetFromLatest": "PT0S", + "tuningConfig": { + "maxRowsInMemory": null, + "appendableIndexSpec": null, + "maxBytesInMemory": null, + "maxTotalRows": null, + "splitHintSpec": null, + "partitionsSpec": { + "type": "dynamic", + "maxRowsPerSegment": 5000000, + "maxTotalRows": null + }, + "indexSpec": null, + "indexSpecForIntermediatePersists": null, + "maxPendingPersists": null, + "pushTimeout": null, + "segmentWriteOutMediumFactory": null, + "maxNumConcurrentSubTasks": null, + "maxRetry": null, + "taskStatusCheckPeriodMs": null, + "chatHandlerTimeout": null, + "chatHandlerNumRetries": null, + "maxNumSegmentsToMerge": null, + "totalNumMergeTasks": null, + "maxColumnsToMerge": null, + "type": "index_parallel", + "forceGuaranteedRollup": false + }, + "granularitySpec": { + "segmentGranularity": "DAY", + "queryGranularity": null, + "rollup": null + }, + "dimensionsSpec": null, + "metricsSpec": null, + "transformSpec": null, + "ioConfig": null, + "taskContext": null + }, + "auditInfo": { + "author": "", + "comment": "", + "ip": "127.0.0.1" + }, + "auditTime": "2023-07-31T18:16:16.362Z" + } +] +``` +</details> + +## Automatic compaction status + +### Get segments awaiting compaction + +Returns the total size of segments awaiting compaction for a given datasource. The specified datasource must have automatic compaction enabled. + +#### URL + +<code class="getAPI">GET</code> <code>/druid/coordinator/v1/compaction/progress?dataSource=:dataSource</code> + +#### Query parameter +* `dataSource` (required) + * Type: String + * Name of the datasource for this status information Review Comment: ```suggestion * Name of the datasource for this status information. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
