com.lucidworks.apollo.component

Class CollectionMetricHelper

java.lang.Object

com.lucidworks.apollo.component.CollectionMetricHelper

public class CollectionMetricHelper
extends java.lang.Object

Encapsulates various interesting statistics involving collections. The rationale behind this class: we have various classes that can look up information about collections from various sources -- ZookeeperAPI, CollectionAPI, MBeanAPI. So if you are looking for something about a collection you need to know some implementation details about where that information is available. This is an attempt to abstract away those implementation details, so that you have one place to go to get information about a collection. The client-facing frontend for this is CollectionResource. If we want to poll Solr's JMX endpoints or other stat sources to track # of requests over time and similar time-series stats, this is a potential place to do it.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionMetricHelper.RequestsAndTime

Constructor Summary

Constructors

Constructor and Description
CollectionMetricHelper(SearchClusterComponent searchClusterComponent, CollectionComponent collectionComponent, ClientComponent clientComponent)

Method Summary

Modifier and Type	Method and Description
CollectionMetricHelper.RequestsAndTime	getAggregatedSearchStats(com.lucidworks.apollo.common.models.Collection collection) Returns a "RequestsAndTime" object that aggregates the # of requests and the total time across all nodes for the given collection.
CollectionMetricHelper.RequestsAndTime	getAggregatedSearchStats(SolrClient solrClient, java.lang.String collection)
long	getNumberOfDocuments(SolrClient solrClient, java.lang.String solrCollectionName)
CollectionMetricHelper.RequestsAndTime	getTrackedCollectionSearchStats()

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionMetricHelper

public CollectionMetricHelper(SearchClusterComponent searchClusterComponent,
                              CollectionComponent collectionComponent,
                              ClientComponent clientComponent)

Method Detail

getTrackedCollectionSearchStats

public CollectionMetricHelper.RequestsAndTime getTrackedCollectionSearchStats()
                                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getAggregatedSearchStats

public CollectionMetricHelper.RequestsAndTime getAggregatedSearchStats(com.lucidworks.apollo.common.models.Collection collection)
                                                                throws java.lang.Exception

Returns a "RequestsAndTime" object that aggregates the # of requests and the total time across all nodes for the given collection. Takes sharding and replicas into account.

Parameters:

collection -

Returns:

Throws:

java.lang.Exception

getAggregatedSearchStats

public CollectionMetricHelper.RequestsAndTime getAggregatedSearchStats(SolrClient solrClient,
                                                                       java.lang.String collection)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

getNumberOfDocuments

public long getNumberOfDocuments(SolrClient solrClient,
                                 java.lang.String solrCollectionName)
                          throws SolrAPIException,
                                 java.io.IOException

Throws:

SolrAPIException

java.io.IOException