Deprecate dimensions / metrics APIs on brokers (#6361)

* Deprecate dimensions / metrics APIs on brokers

* add segmentMetadataQuery link

* add more doc
This commit is contained in:
Jihoon Son 2018-09-24 17:56:38 -07:00 committed by Fangjin Yang
parent ee7b565469
commit 99428e20d2
2 changed files with 14 additions and 0 deletions

View File

@ -425,10 +425,22 @@ druid.query.segmentMetadata.defaultHistory
Returns the dimensions of the datasource. Returns the dimensions of the datasource.
<div class="note caution">
This API is deprecated and will be removed in future releases. Please use [SegmentMetadataQuery](../querying/segmentmetadataquery.html) instead
which provides more comprehensive information and supports all dataSource types including streaming dataSources. It's also encouraged to use [INFORMATION_SCHEMA tables](../querying/sql.html#retrieving-metadata)
if you're using SQL.
</div>
* `/druid/v2/datasources/{dataSourceName}/metrics` * `/druid/v2/datasources/{dataSourceName}/metrics`
Returns the metrics of the datasource. Returns the metrics of the datasource.
<div class="note caution">
This API is deprecated and will be removed in future releases. Please use [SegmentMetadataQuery](../querying/segmentmetadataquery.html) instead
which provides more comprehensive information and supports all dataSource types including streaming dataSources. It's also encouraged to use [INFORMATION_SCHEMA tables](../querying/sql.html#retrieving-metadata)
if you're using SQL.
</div>
* `/druid/v2/datasources/{dataSourceName}/candidates?intervals={comma-separated-intervals-in-ISO8601-format}&numCandidates={numCandidates}` * `/druid/v2/datasources/{dataSourceName}/candidates?intervals={comma-separated-intervals-in-ISO8601-format}&numCandidates={numCandidates}`
Returns segment information lists including server locations for the given datasource and intervals. If "numCandidates" is not specified, it will return all servers for each interval. Returns segment information lists including server locations for the given datasource and intervals. If "numCandidates" is not specified, it will return all servers for each interval.

View File

@ -220,6 +220,7 @@ public class ClientInfoResource
return result; return result;
} }
@Deprecated
@GET @GET
@Path("/{dataSourceName}/dimensions") @Path("/{dataSourceName}/dimensions")
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@ -253,6 +254,7 @@ public class ClientInfoResource
return dims; return dims;
} }
@Deprecated
@GET @GET
@Path("/{dataSourceName}/metrics") @Path("/{dataSourceName}/metrics")
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)