/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see <http://www.gnu.org/licenses/>.
*/
package org.graylog2.rest.resources.search;
import com.codahale.metrics.annotation.Timed;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.apache.shiro.authz.annotation.RequiresAuthentication;
import org.glassfish.jersey.server.ChunkedOutput;
import org.graylog2.decorators.DecoratorProcessor;
import org.graylog2.indexer.results.ScrollResult;
import org.graylog2.indexer.searches.Searches;
import org.graylog2.indexer.searches.SearchesConfig;
import org.graylog2.indexer.searches.Sorting;
import org.graylog2.plugin.cluster.ClusterConfigService;
import org.graylog2.plugin.indexer.searches.timeranges.AbsoluteRange;
import org.graylog2.plugin.indexer.searches.timeranges.InvalidRangeParametersException;
import org.graylog2.plugin.indexer.searches.timeranges.TimeRange;
import org.graylog2.rest.MoreMediaTypes;
import org.graylog2.rest.models.search.responses.FieldStatsResult;
import org.graylog2.rest.models.search.responses.HistogramResult;
import org.graylog2.rest.models.search.responses.TermsResult;
import org.graylog2.rest.models.search.responses.TermsStatsResult;
import org.graylog2.rest.resources.search.responses.SearchResponse;
import org.graylog2.shared.security.RestPermissions;
import org.hibernate.validator.constraints.NotEmpty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.inject.Inject;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.Locale;
import java.util.Optional;
@RequiresAuthentication
@Api(value = "Search/Absolute", description = "Message search")
@Path("/search/universal/absolute")
public class AbsoluteSearchResource extends SearchResource {
private static final Logger LOG = LoggerFactory.getLogger(AbsoluteSearchResource.class);
@Inject
public AbsoluteSearchResource(Searches searches,
ClusterConfigService clusterConfigService,
DecoratorProcessor decoratorProcessor) {
super(searches, clusterConfigService, decoratorProcessor);
}
@GET
@Timed
@ApiOperation(value = "Message search with absolute timerange.",
notes = "Search for messages using an absolute timerange, specified as from/to " +
"with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.")
@Produces(MediaType.APPLICATION_JSON)
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided.")
})
public SearchResponse searchAbsolute(
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "from", value = "Timerange start. See description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "limit", value = "Maximum number of messages to return.", required = false) @QueryParam("limit") int limit,
@ApiParam(name = "offset", value = "Offset", required = false) @QueryParam("offset") int offset,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter,
@ApiParam(name = "fields", value = "Comma separated list of fields to return", required = false) @QueryParam("fields") String fields,
@ApiParam(name = "sort", value = "Sorting (field:asc / field:desc)", required = false) @QueryParam("sort") String sort,
@ApiParam(name = "decorate", value = "Run decorators on search result", required = false) @QueryParam("decorate") @DefaultValue("true") boolean decorate) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
final Sorting sorting = buildSorting(sort);
final List<String> fieldList = parseOptionalFields(fields);
TimeRange timeRange = buildAbsoluteTimeRange(from, to);
final SearchesConfig searchesConfig = SearchesConfig.builder()
.query(query)
.filter(filter)
.fields(fieldList)
.range(timeRange)
.limit(limit)
.offset(offset)
.sorting(sorting)
.build();
final Optional<String> streamId = Searches.extractStreamId(filter);
return buildSearchResponse(searches.search(searchesConfig), timeRange, decorate, streamId);
}
@GET
@Timed
@ApiOperation(value = "Message search with absolute timerange.",
notes = "Search for messages using an absolute timerange, specified as from/to " +
"with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.")
@Produces(MoreMediaTypes.TEXT_CSV)
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided.")
})
public ChunkedOutput<ScrollResult.ScrollChunk> searchAbsoluteChunked(
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "from", value = "Timerange start. See description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "limit", value = "Maximum number of messages to return.", required = false) @QueryParam("limit") int limit,
@ApiParam(name = "offset", value = "Offset", required = false) @QueryParam("offset") int offset,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter,
@ApiParam(name = "fields", value = "Comma separated list of fields to return", required = true) @QueryParam("fields") String fields) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
final List<String> fieldList = parseFields(fields);
final TimeRange timeRange = buildAbsoluteTimeRange(from, to);
final ScrollResult scroll = searches
.scroll(query, timeRange, limit, offset, fieldList, filter);
return buildChunkedOutput(scroll, limit);
}
@GET
@Path("/export")
@Timed
@ApiOperation(value = "Export message search with absolute timerange.",
notes = "Search for messages using an absolute timerange, specified as from/to " +
"with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss.")
@Produces(MoreMediaTypes.TEXT_CSV)
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided.")
})
public Response exportSearchAbsoluteChunked(
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "from", value = "Timerange start. See description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "limit", value = "Maximum number of messages to return.", required = false) @QueryParam("limit") int limit,
@ApiParam(name = "offset", value = "Offset", required = false) @QueryParam("offset") int offset,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter,
@ApiParam(name = "fields", value = "Comma separated list of fields to return", required = true) @QueryParam("fields") String fields) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
final String filename = "graylog-search-result-absolute-" + from + "-" + to + ".csv";
return Response
.ok(searchAbsoluteChunked(query, from, to, limit, offset, filter, fields))
.header("Content-Disposition", "attachment; filename=" + filename)
.build();
}
@GET
@Path("/terms")
@Timed
@ApiOperation(value = "Most common field terms of a query using an absolute timerange.")
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided.")
})
@Produces(MediaType.APPLICATION_JSON)
public TermsResult termsAbsolute(
@ApiParam(name = "field", value = "Message field of to return terms of", required = true)
@QueryParam("field") @NotEmpty String field,
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "size", value = "Maximum number of terms to return", required = false) @QueryParam("size") int size,
@ApiParam(name = "from", value = "Timerange start. See search method description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See search method description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
return buildTermsResult(searches.terms(field, size, query, filter, buildAbsoluteTimeRange(from, to)));
}
@GET
@Path("/termsstats")
@Timed
@ApiOperation(value = "Ordered field terms of a query computed on another field using an absolute timerange.")
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided.")
})
@Produces(MediaType.APPLICATION_JSON)
public TermsStatsResult termsStatsAbsolute(
@ApiParam(name = "key_field", value = "Message field of to return terms of", required = true)
@QueryParam("key_field") @NotEmpty String keyField,
@ApiParam(name = "value_field", value = "Value field used for computation", required = true)
@QueryParam("value_field") @NotEmpty String valueField,
@ApiParam(name = "order", value = "What to order on (Allowed values: TERM, REVERSE_TERM, COUNT, REVERSE_COUNT, TOTAL, REVERSE_TOTAL, MIN, REVERSE_MIN, MAX, REVERSE_MAX, MEAN, REVERSE_MEAN)", required = true)
@QueryParam("order") @NotEmpty String order,
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "size", value = "Maximum number of terms to return", required = false) @QueryParam("size") int size,
@ApiParam(name = "from", value = "Timerange start. See search method description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See search method description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
return buildTermsStatsResult(
searches.termsStats(keyField,
valueField,
Searches.TermsStatsOrder.valueOf(order.toUpperCase(Locale.ENGLISH)),
size,
query,
filter,
buildAbsoluteTimeRange(from, to)
));
}
@GET
@Path("/stats")
@Timed
@ApiOperation(value = "Field statistics for a query using an absolute timerange.",
notes = "Returns statistics like min/max or standard deviation of numeric fields " +
"over the whole query result set.")
@Produces(MediaType.APPLICATION_JSON)
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided."),
@ApiResponse(code = 400, message = "Field is not of numeric type.")
})
public FieldStatsResult statsAbsolute(
@ApiParam(name = "field", value = "Message field of numeric type to return statistics for", required = true)
@QueryParam("field") @NotEmpty String field,
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "from", value = "Timerange start. See search method description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See search method description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
return buildFieldStatsResult(fieldStats(field, query, filter, buildAbsoluteTimeRange(from, to)));
}
@GET
@Path("/histogram")
@Timed
@ApiOperation(value = "Datetime histogram of a query using an absolute timerange.")
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided."),
@ApiResponse(code = 400, message = "Invalid interval provided.")
})
@Produces(MediaType.APPLICATION_JSON)
public HistogramResult histogramAbsolute(
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "interval", value = "Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)", required = true)
@QueryParam("interval") @NotEmpty String interval,
@ApiParam(name = "from", value = "Timerange start. See search method description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See search method description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
interval = interval.toUpperCase(Locale.ENGLISH);
validateInterval(interval);
return buildHistogramResult(
searches.histogram(
query,
Searches.DateHistogramInterval.valueOf(interval),
filter,
buildAbsoluteTimeRange(from, to)
)
);
}
@GET
@Path("/fieldhistogram")
@Timed
@ApiOperation(value = "Field value histogram of a query using an absolute timerange.")
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid timerange parameters provided."),
@ApiResponse(code = 400, message = "Invalid interval provided."),
@ApiResponse(code = 400, message = "Field is not of numeric type.")
})
@Produces(MediaType.APPLICATION_JSON)
public HistogramResult fieldHistogramAbsolute(
@ApiParam(name = "query", value = "Query (Lucene syntax)", required = true)
@QueryParam("query") @NotEmpty String query,
@ApiParam(name = "field", value = "Field of whose values to get the histogram of", required = true)
@QueryParam("field") @NotEmpty String field,
@ApiParam(name = "interval", value = "Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)", required = true)
@QueryParam("interval") @NotEmpty String interval,
@ApiParam(name = "from", value = "Timerange start. See search method description for date format", required = true) @QueryParam("from") String from,
@ApiParam(name = "to", value = "Timerange end. See search method description for date format", required = true) @QueryParam("to") String to,
@ApiParam(name = "filter", value = "Filter", required = false) @QueryParam("filter") String filter,
@ApiParam(name = "cardinality", value = "Calculate the cardinality of the field as well", required = false) @QueryParam("cardinality") boolean includeCardinality
) {
checkSearchPermission(filter, RestPermissions.SEARCHES_ABSOLUTE);
interval = interval.toUpperCase(Locale.ENGLISH);
validateInterval(interval);
return buildHistogramResult(fieldHistogram(field, query, interval, filter, buildAbsoluteTimeRange(from, to),
includeCardinality));
}
private TimeRange buildAbsoluteTimeRange(String from, String to) {
try {
return restrictTimeRange(AbsoluteRange.create(from, to));
} catch (InvalidRangeParametersException e) {
LOG.warn("Invalid timerange parameters provided. Returning HTTP 400.");
throw new BadRequestException("Invalid timerange parameters provided", e);
}
}
}