Search Manual / Version 2406.1
Table Of Contents
The CAE Feeder exports multiple JMX MBeans. The following overview
describes attributes and operations of the MBeans CaeFeeder, Feeder,
and ProactiveEngine.
The MBean SolrIndexer is described in Section 6.5, “Solr Indexer JMX Managed Beans”.
The CAE Feeder exports more MBeans and attributes, which aren't documented in
detail here.
CaeFeeder MBean
| Operation | Parameter | Description |
|---|---|---|
| reindexContent |
|
Triggers reindexing of the content with the given ID. The ID can be the numeric content
ID or in a format like coremedia:///cap/content/42.
|
| reindexByQuery |
| Triggers reindexing of all contents that fulfill the given UAPI query, and the configuration of base folders and content types for the CAE Feeder. Warning: This can be a very expensive operation, if many contents are reindexed. |
| reindexByType |
| Triggers reindexing of all contents of the given type and subtypes, if configured for the CAE Feeder. Warning: This can be a very expensive operation, if many contents are reindexed. |
Table 6.7. JMX operations of the CaeFeeder MBean
Feeder MBean
| Attribute | Type | Unit | Description |
|---|---|---|---|
|
| read-only | milliseconds |
The average creation time of persisted batches for the last
<n> seconds, where
<n> is the value of the attribute
The creation time is the time span between the time the first entry was put into a batch and the time the batch was ready for sending to the CoreMedia Search Engine. |
|
| read-only | milliseconds |
The average sending time of persisted batches for the last
<n> seconds, where
<n> is the value of the attribute
The sending time indicates how long it took to actually send the batch to the
CoreMedia Search Engine, that is, the time it took to invoke the
|
|
| read-only | milliseconds |
The average processing time of persisted batches for the last
<n> seconds, where
<n> is the value of the attribute
The processing time is the time span between the time a batch was successfully sent to the
CoreMedia Search Engine and the time when the Feeder received a
callback from the Search Engine which
indicates that the batch has been processed. Callbacks are only used with custom
|
|
| read-only | milliseconds |
The average persisting time of batches for the last
<n> seconds, where
<n> is the value of the attribute
The persisting time is the time span between the time a batch was processed by the
CoreMedia Search Engine and the time when the Feeder received a
callback from the Search Engine which indicates that the batch has
been persisted. Callbacks are only used with custom |
|
| read-only | byte |
The sum of the byte size of persisted batches for the last
<n> seconds, where
<n> is the value of the attribute
Note that byte computation is a rough estimate only. |
|
| read-only | batches | The number of persisted batches for the last <n> seconds, where <n>
is the value of the attribute BatchStatisticsIntervalSeconds. If
<n> is 0, this attribute
will contain the value since the start of the Feeder. |
|
| read-only | batch entries / second |
The number of persisted batch entries per second in the last
<n> seconds, where
<n> is the value of the attribute
Batch entries are basically creations, updates or removals of index documents. Note that this value decreases if the Feeder is idle. |
|
| read-only | batch entries |
The number of persisted batch entries for the last
<n> seconds, where
<n> is the value of the attribute
Batch entries are basically creations, updates or removals of index documents. |
|
| read/write | seconds | The time in seconds used to compute statistic values for other attributes. If
the value is 0 or greater than
BatchStatisticsMaxIntervalSeconds, the time since the start of the
Feeder is used. |
|
| read/write | seconds | The maximum value that can be used for
BatchStatisticsIntervalSeconds. It defines how long statistic data
will be kept by the Feeder. You cannot recover statistics for the past by increasing
the value. |
|
| read/write | seconds | The time interval in seconds in which the Feeder writes statistics to its log file (log level INFO). |
|
| read-only | callback objects |
The number of pending com.coremedia.cap.feeder.FeederCallback objects in the internal callback queue. |
|
| read-only | batch entries |
The number of batch entries that are currently deferred. New batch entries will be deferred as long as a batch with an entry that affects the same index document is currently being sent to the Search Engine or was not yet persisted by the Search Engine. Batch entries are basically creations, updates or removals of index documents. |
|
| read/write | objects |
The number of |
|
| read-only | objects |
The number of pending |
|
| read/write | milliseconds | The time to wait before the CAE Feeder
retries to access the source data after errors. This is used if custom code calls
method execute of com.coremedia.cap.feeder.Feeder.
|
|
| read-only | seconds |
The average delay in seconds of the index documents that represent content beans
and that were indexed in the last
<n> seconds, where
<n> is the value of the attribute
The set of index documents used to compute this value can be restricted by introducing a
To inject a custom predicate use the bean customizer and replace the
|
|
| read-only | documents |
The number of index documents that represent content beans and that were indexed in the last
<n> seconds, where
<n> is the value of the attribute
The set of index documents used to compute this value can be restricted by introducing a
To inject a custom predicate use the bean customizer and replace the
|
|
| read-only | seconds |
The maximum delay in seconds of the index documents that represent content beans and
that were indexed in the last
<n> seconds, where
<n> is the value of the attribute
The set of index documents used to compute this value can be restricted by introducing a
To inject a custom predicate use the bean customizer and replace the
|
|
| read-only | seconds |
The minimum delay in seconds of the index documents that represent content beans
and that were indexed in the last
<n> seconds, where
<n> is the value of the attribute
The set of index documents used to compute this value can be restricted by introducing a
To inject a custom predicate use the bean customizer and replace the
|
|
| read-only | date and time |
The time when last indexing happened for the last
<n> seconds, where
<n> is the value of the attribute
The set of index documents used to compute this value can be restricted by introducing a
To inject a custom predicate use the bean customizer and replace the
|
|
| read/write | batch entries |
The maximum number of entries in a batch. It is sent to the Search Engine when the maximum number is reached.
It defaults to the configured property |
|
| read/write | byte |
The maximum size of a batch in bytes. The CAE Feeder sends a batch to the Search Engine if its maximum size would be exceeded when adding more entries.
It defaults to the configured property Note that byte computation is a rough estimate only. |
|
| read/write | batches |
The maximum number of batches indexed in parallel. This setting is not used with the default integration of Apache Solr but only with custom implementations of the com.coremedia.cap.feeder.index.async.AsyncIndexer interface. The CAE Feeder does not call the index method of the AsyncIndexer interface to index another batch if the maximum number of parallel batches has been reached. The method will not be called until a callback about the persistence of one of these batches has been received.
It defaults to the configured property |
|
| read/write | batches |
The maximum number of batches processed by the Indexer in parallel. This setting is not used with the default integration of Apache Solr but only with custom implementations of the com.coremedia.cap.feeder.index.async.AsyncIndexer interface. The CAE Feeder does not call the index method of the AsyncIndexer interface to index another batch if the configured number of currently processed batches has been reached. The method will not be called until a callback about completed processing or persistence of one of these batches has been received.
It defaults to the configured property |
|
| read-only | batches | The number of currently open batches which have been passed to a custom implementation of the com.coremedia.cap.feeder.index.async.AsyncIndexer interface but for which the CAE Feeder has not received a persisted callback yet. |
|
| read-only | batches | The number of currently processed batches which have been passed to a custom implementation of the com.coremedia.cap.feeder.index.async.AsyncIndexer interface but for which the CAE Feeder has not received a processed callback yet. |
|
| read/write | milliseconds |
The CAE Feeder sends a batch which only contains retried entries and
is not full with regard to the
It defaults to the configured property |
| read/write | milliseconds |
The maximum time in milliseconds between the time the CAE
Feeder received an error from the Search Engine and the
time, the CAE Feeder tries to send the failed entry as part of a
batch to the Search Engine again. The time is exceeded if
It defaults to the configured property |
|
| read/write | milliseconds |
The CAE Feeder sends a batch which is not full with regard to the
It defaults to the configured property |
|
| read/write | milliseconds |
The maximum time in milliseconds between the points in time where the CAE
Feeder receives a request from a client and sends this request as part of a batch to the
Search Engine. The time is exceeded if
It defaults to the configured property |
|
| read-only | date and time | The time when the CAE Feeder was started. |
Table 6.8. Attributes of the Feeder MBean
ProactiveEngine MBean
| Attribute | Type | Unit | Description |
|---|---|---|---|
|
| read-only | number |
The total number of "keys" that need to be kept up-to-date by the CAE Feeder. This is the sum of the number of Content Beans selected for feeding (that is, beans that have been sent or need to be sent to the search engine) plus the number of used fragment keys as described in Section 5.4.5, “Using Revalidating Fragments”. The value is initialized when the CAE Feeder is started. It increases if new content is created that needs to be indexed. |
|
| read-only | number |
The number of "keys" whose latest evaluation is still up-to-date. This is a subset of the total number of
keys returned by attribute The value decreases after content has changed and when the CAE Feeder needs to recompute data that is then sent to the search engine.
The difference of |
Table 6.9. Attributes of the ProactiveEngine MBean
