org.graylog2.indexer.searches

Class Searches

java.lang.Object

org.graylog2.indexer.searches.Searches

@Singleton
public class Searches
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Searches.DateHistogramInterval
static class	Searches.TermsStatsOrder

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGG_CARDINALITY
static String	AGG_EXTENDED_STATS
static String	AGG_FILTER
static String	AGG_HISTOGRAM
static String	AGG_STATS
static String	AGG_TERMS
static String	AGG_TERMS_STATS
static String	AGG_VALUE_COUNT
static String	STACKED_TERMS_AGG_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Searches(Configuration configuration, IndexRangeService indexRangeService, com.codahale.metrics.MetricRegistry metricRegistry, StreamService streamService, Indices indices, IndexSetRegistry indexSetRegistry, io.searchbox.client.JestClient jestClient, ScrollResult.Factory scrollResultFactory)

Method Summary

Modifier and Type	Method and Description
CountResult	count(String query, TimeRange range)
CountResult	count(String query, TimeRange range, String filter)
org.elasticsearch.search.aggregations.AbstractAggregationBuilder	createTermsBuilder(String field, List<String> stackedFields, int size, org.elasticsearch.search.aggregations.bucket.terms.Terms.Order termsOrder)
static Optional<String>	extractStreamId(String filter) Extracts the last stream id from the filter string passed as part of the elasticsearch query.
HistogramResult	fieldHistogram(String query, String field, Searches.DateHistogramInterval interval, String filter, TimeRange range, boolean includeCardinality)
HistogramResult	fieldHistogram(String query, String field, Searches.DateHistogramInterval interval, String filter, TimeRange range, boolean includeStats, boolean includeCardinality)
FieldStatsResult	fieldStats(String field, String query, String filter, TimeRange range)
FieldStatsResult	fieldStats(String field, String query, String filter, TimeRange range, boolean includeCardinality, boolean includeStats, boolean includeCount)
FieldStatsResult	fieldStats(String field, String query, TimeRange range)
HistogramResult	histogram(String query, Searches.DateHistogramInterval interval, String filter, TimeRange range)
HistogramResult	histogram(String query, Searches.DateHistogramInterval interval, TimeRange range)
ScrollResult	scroll(String query, TimeRange range, int limit, int offset, List<String> fields, String filter)
SearchResult	search(SearchesConfig config)
SearchResult	search(String query, String filter, TimeRange range, int limit, int offset, Sorting sorting)
SearchResult	search(String query, TimeRange range, int limit, int offset, Sorting sorting)
TermsResult	terms(String field, int size, String query, String filter, TimeRange range)
TermsResult	terms(String field, int size, String query, String filter, TimeRange range, Sorting.Direction sorting)
TermsResult	terms(String field, int size, String query, TimeRange range)
TermsResult	terms(String field, List<String> stackedFields, int size, String query, String filter, TimeRange range, Sorting.Direction sorting)
TermsHistogramResult	termsHistogram(String field, List<String> stackedFields, int size, String query, String filter, TimeRange range, Searches.DateHistogramInterval interval, Sorting.Direction sorting)
TermsStatsResult	termsStats(String keyField, String valueField, Searches.TermsStatsOrder order, int size, String query, String filter, TimeRange range)
TermsStatsResult	termsStats(String keyField, String valueField, Searches.TermsStatsOrder order, int size, String query, TimeRange range)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AGG_TERMS

public static final String AGG_TERMS

See Also:

Constant Field Values

AGG_STATS

public static final String AGG_STATS

See Also:

Constant Field Values

AGG_TERMS_STATS

public static final String AGG_TERMS_STATS

See Also:

Constant Field Values

AGG_FILTER

public static final String AGG_FILTER

See Also:

Constant Field Values

AGG_HISTOGRAM

public static final String AGG_HISTOGRAM

See Also:

Constant Field Values

AGG_EXTENDED_STATS

public static final String AGG_EXTENDED_STATS

See Also:

Constant Field Values

AGG_CARDINALITY

public static final String AGG_CARDINALITY

See Also:

Constant Field Values

AGG_VALUE_COUNT

public static final String AGG_VALUE_COUNT

See Also:

Constant Field Values

STACKED_TERMS_AGG_SEPARATOR

public static final String STACKED_TERMS_AGG_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

Searches

@Inject
public Searches(Configuration configuration,
                        IndexRangeService indexRangeService,
                        com.codahale.metrics.MetricRegistry metricRegistry,
                        StreamService streamService,
                        Indices indices,
                        IndexSetRegistry indexSetRegistry,
                        io.searchbox.client.JestClient jestClient,
                        ScrollResult.Factory scrollResultFactory)

Method Detail

count

public CountResult count(String query,
                         TimeRange range)

count

public CountResult count(String query,
                         TimeRange range,
                         String filter)

scroll

public ScrollResult scroll(String query,
                           TimeRange range,
                           int limit,
                           int offset,
                           List<String> fields,
                           String filter)

search

public SearchResult search(String query,
                           TimeRange range,
                           int limit,
                           int offset,
                           Sorting sorting)

search

public SearchResult search(String query,
                           String filter,
                           TimeRange range,
                           int limit,
                           int offset,
                           Sorting sorting)

search

public SearchResult search(SearchesConfig config)

createTermsBuilder

public org.elasticsearch.search.aggregations.AbstractAggregationBuilder createTermsBuilder(String field,
                                                                                           List<String> stackedFields,
                                                                                           int size,
                                                                                           org.elasticsearch.search.aggregations.bucket.terms.Terms.Order termsOrder)

terms

public TermsResult terms(String field,
                         List<String> stackedFields,
                         int size,
                         String query,
                         String filter,
                         TimeRange range,
                         Sorting.Direction sorting)

terms

public TermsResult terms(String field,
                         int size,
                         String query,
                         String filter,
                         TimeRange range,
                         Sorting.Direction sorting)

terms

public TermsResult terms(String field,
                         int size,
                         String query,
                         String filter,
                         TimeRange range)

terms

public TermsResult terms(String field,
                         int size,
                         String query,
                         TimeRange range)

termsHistogram

public TermsHistogramResult termsHistogram(String field,
                                           List<String> stackedFields,
                                           int size,
                                           String query,
                                           String filter,
                                           TimeRange range,
                                           Searches.DateHistogramInterval interval,
                                           Sorting.Direction sorting)

termsStats

public TermsStatsResult termsStats(String keyField,
                                   String valueField,
                                   Searches.TermsStatsOrder order,
                                   int size,
                                   String query,
                                   String filter,
                                   TimeRange range)

termsStats

public TermsStatsResult termsStats(String keyField,
                                   String valueField,
                                   Searches.TermsStatsOrder order,
                                   int size,
                                   String query,
                                   TimeRange range)

fieldStats

public FieldStatsResult fieldStats(String field,
                                   String query,
                                   TimeRange range)

fieldStats

public FieldStatsResult fieldStats(String field,
                                   String query,
                                   String filter,
                                   TimeRange range)

fieldStats

public FieldStatsResult fieldStats(String field,
                                   String query,
                                   String filter,
                                   TimeRange range,
                                   boolean includeCardinality,
                                   boolean includeStats,
                                   boolean includeCount)

histogram

public HistogramResult histogram(String query,
                                 Searches.DateHistogramInterval interval,
                                 TimeRange range)

histogram

public HistogramResult histogram(String query,
                                 Searches.DateHistogramInterval interval,
                                 String filter,
                                 TimeRange range)

fieldHistogram

public HistogramResult fieldHistogram(String query,
                                      String field,
                                      Searches.DateHistogramInterval interval,
                                      String filter,
                                      TimeRange range,
                                      boolean includeCardinality)

fieldHistogram

public HistogramResult fieldHistogram(String query,
                                      String field,
                                      Searches.DateHistogramInterval interval,
                                      String filter,
                                      TimeRange range,
                                      boolean includeStats,
                                      boolean includeCardinality)

extractStreamId

public static Optional<String> extractStreamId(String filter)

Extracts the last stream id from the filter string passed as part of the elasticsearch query. This is used later to pass to possibly existing message decorators for stream-specific configurations. The assumption is that usually (when listing/searching messages for a stream) only a single stream filter is passed. When this is not the case, only the last stream id will be taked into account. This is currently a workaround. A better solution would be to pass the stream id which is supposed to be the scope for a search query as a separate parameter.

Parameters:

filter - the filter string like "streams:xxxyyyzzz"

Returns:

the optional stream id