Search Manual / 6.3 Content Feeder JMX Managed Beans

Search Manual / Version 2107

6.3 Content Feeder JMX Managed Beans

The Content Feeder exports attributes and operations with the following MBeans, whose attributes and operations are described in more detail in the tables of this section:

Feeder MBean: com.coremedia:type=Feeder,application=content-feeder
UpdateGroupsBackgroundFeed MBean: com.coremedia:type=UpdateGroupsBackgroundFeed,application=content-feeder. This MBean shows the status of updating the index after changes to rights rules in the repository. See also "Configuring updates of rights rule changes" in Section 4.2.3, “Advanced Configuration”.
AdminBackgroundFeed MBean: com.coremedia:type=AdminBackgroundFeed,application=content-feeder. This MBean is related to the reindexing functionality described in Section 3.5, “Reindexing”.
SolrIndexer MBean: com.coremedia:type=SolrIndexer,application=content-feeder, which is described in Section 6.5, “Solr Indexer JMX Managed Beans”.

Depending on active Blueprint features, there can be more available MBeans, that are not listed here.

Feeder MBean Attributes

The following table shows the attributes of MBean com.coremedia:type=Feeder,application=content-feeder:

Attribute	Type	Description
`IndexAverageBatchCreationTime`	Read-only	Average batch creation time in the statistics interval.
`IndexAverageBatchIndexingTime`	Read-only	Average batch indexing time in the statistics interval. If Apache Solr is used, this property is 0 because contents are indexed immediately when they are sent to the search engine. Indexing time is then part of `IndexAverageBatchSendingTime`.
`IndexAverageBatchSendingTime`	Read-only	Average batch sending time in the statistics interval.
`IndexBatches`	Read-only	Number of indexed batches in the statistics interval.
`IndexBytes`	Read-only	Number of indexed bytes in the statistics interval.
`IndexDocuments`	Read-only	Number of indexed documents in the statistics interval.
`IndexDocumentsPerSecond`	Read-only	Number of documents indexed per second in the statistics interval.
`IndexMaxBatchBytes`	Read-only	The maximum batch size in bytes.
`IndexMaxBatchSize`	Read-only	The maximum number of index documents in a batch.
`IndexAverageLagTime`	Read-only	The average delay in seconds of the index documents that represent content and that were indexed in the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. If <n> is `0` or greater than the value of attribute `IndexMaxStatisticInterval`, this attribute will contain the value since the start of the Content Feeder. The difference of the time when a batch was successfully sent and the feedable field freshness are used for each feedable object where feederstate is `SUCCESS`. The set of index documents used to compute this value can be restricted by introducing a `com.coremedia.common.util.Predicate`. This predicate can be injected into the Spring bean `index`. The `include` method accepts an object of type `com.coremedia.cap.feeder.Feedable`. The custom implementation decides whether to include the index document into the computation of this value. To inject a custom predicate use the bean customizer and replace the `BatchStatisticsFeedablePredicate` of the index bean: `<customize:replace id="batchStatisticsFeedablePredicateCustomizer" bean="index" custom-ref="myPredicate" property="batchStatisticsFeedablePredicate" />`
`IndexContentDocuments`	Read-only	The number of index documents that represent content and that were indexed in 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 Content Feeder. The set of index documents used to compute this value can be restricted by introducing a `com.coremedia.common.util.Predicate`. This predicate can be injected into the Spring bean `index`. The `include` method accepts an object of type `com.coremedia.cap.feeder.Feedable`. The custom implementation decides whether to include the index document into the computation of this value. To inject a custom predicate use the bean customizer and replace the `BatchStatisticsFeedablePredicate` of the feeder bean: `<customize:replace id="batchStatisticsFeedablePredicateCustomizer" bean="index" custom-ref="myPredicate" property="batchStatisticsFeedablePredicate" />`
`IndexMaxLagTime`	Read-only	The maximum delay in seconds of the index documents that represent content and that were indexed in the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. If <n> is `0` or greater than the value of attribute `IndexMaxStatisticInterval`, this attribute will contain the value since the start of the Content Feeder. The difference of the time when a batch was successfully sent and the feedable field freshness are used for each feedable object where feederstate is `SUCCESS`. The set of index documents used to compute this value can be restricted by introducing a `com.coremedia.common.util.Predicate`. This predicate can be injected into the Spring bean `index`. The `include` method accepts an object of type `com.coremedia.cap.feeder.Feedable`. The custom implementation decides whether to include the index document into the computation of this value. To inject a custom predicate use the bean customizer and replace the `BatchStatisticsFeedablePredicate` of the index bean: `<customize:replace id="batchStatisticsFeedablePredicateCustomizer" bean="index" custom-ref="myPredicate" property="batchStatisticsFeedablePredicate" />`
`IndexMinLagTime`	Read-only	The minimum delay in seconds of the index documents that represent content and that were indexed in the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. If <n> is `0` or greater than the value of attribute `IndexMaxStatisticInterval`, this attribute will contain the value since the start of the Content Feeder. The difference of the time when a batch was successfully sent and the feedable field freshness are used for each feedable object where feederstate is `SUCCESS`. The set of index documents used to compute this value can be restricted by introducing a `com.coremedia.common.util.Predicate`. This predicate can be injected into the Spring bean `index`. The `include` method accepts an object of type `com.coremedia.cap.feeder.Feedable`. The custom implementation decides whether to include the index document into the computation of this value. To inject a custom predicate use the bean customizer and replace the `BatchStatisticsFeedablePredicate` of the index bean: `<customize:replace id="batchStatisticsFeedablePredicateCustomizer" bean="index" custom-ref="myPredicate" property="batchStatisticsFeedablePredicate" />`
`IndexMaxStatisticInterval`	Read-only	Maximum interval in seconds for the computation of statistics.
`IndexOpenBatches`	Read-only	Number of open batches.
`IndexStatisticInterval`	Read/Write	Time interval in seconds for which the statistics are calculated.
`LastFailure`	Read-only	Last failure that led to a stop of the Content Feeder.
`LatestIndexing`	Read-only	The time when last indexing happened for the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. The set of index documents used to compute this value can be restricted by introducing a `com.coremedia.common.util.Predicate`. This predicate can be injected into the Spring bean `index`. The `include` method accepts an object of type `com.coremedia.cap.feeder.Feedable`. The custom implementation decides whether to include the index document into the computation of this value. To inject a custom predicate use the bean customizer and replace the `BatchStatisticsFeedablePredicate` of the index bean: `<customize:replace id="batchStatisticsFeedablePredicateCustomizer" bean="index" custom-ref="myPredicate" property="batchStatisticsFeedablePredicate" />`
`PendingEvents`	Read-only	The number of events the Content Feeder is behind the most recent event. It is computed as the difference between the sequence number of the Content Server's current timestamp and the sequence number of the timestamp of the last event whose changes have been persisted in the index. Unified API subsequence numbers are not taken into account, that is two Unified API events with the same sequence number (but different subsequence numbers) are counted as single event. Each content is counted as one additional event when the Content Feeder is still initializing. The value of this attribute increases with changes to content, users or groups in the Content Server. It is decreased after the Content Feeder has processed these changes. Note that the value of this attribute may stay at a non-zero value for a short time after starting the Content Feeder and before the next change happens in the Content Server. This only happens if the latest events in the Content Server are user or group changes. This exceptional case does not indicate a lagging Content Feeder.
`PersistedEvents`	Read-only	The number of persisted events for the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. If <n> is zero or greater than the value of attribute `IndexMaxStatisticInterval`, this attribute contains the total number of persisted events since starting the Content Feeder. Persisted events are computed as difference between sequence numbers of timestamps for which all changes have been persisted in the index. Unified API subsequence numbers are not taken into account, that is, two Unified API events with the same sequence number (but different subsequence numbers) are counted as single event. This attribute contains the number of persisted contents as long as the Content Feeder is still initializing.
`PersistedEventsPerSecond`	Read-only	The number of persisted events per second for the last <n> seconds, where <n> is the value of the attribute `IndexStatisticInterval`. If <n> is zero or greater than the value of attribute `IndexMaxStatisticInterval`, this attribute contains the persisted events per second since starting the Content Feeder. Persisted events are computed as difference between sequence numbers of timestamps for which all changes have been persisted in the index. Unified API subsequence numbers are not taken into account, that is, two Unified API events with the same sequence number (but different subsequence numbers) are counted as single event. This attribute contains the persisted contents per second as long as the Content Feeder is still initializing.
`RetryConnectToIndexDelay`	Read-only	The time in seconds between retries to connect to the Search Engine on startup
`State`	Read-only	State of the Content Feeder (stopped, starting, initializing, running, failed).
`StateNumeric`	Read-only	State of the Content Feeder (0=stopped, 1=starting, 2=initializing, 3=running, 4=failed).
`Uptime`	Read-only	Uptime of the Content Feeder in milliseconds.

Table 6.1. JMX attributes of the Feeder MBean

Feeder MBean Operations

The following table shows the operations of MBean com.coremedia:type=Feeder,application=content-feeder:

Operation	Parameter	Description
stop		Stop the Content Feeder
clearCollection		Clears the Search Engine index. The Content Feeder must have been stopped with the stop operation before. All contents will be reindexed when the Content Feeder is restarted.

Table 6.2. JMX operations of the Feeder MBean

UpdateGroupsBackgroundFeed MBean Attributes

The following table shows the attributes of MBean com.coremedia:type=UpdateGroupsBackgroundFeed,application=content-feeder.

Attribute	Type	Description
`CurrentPendingContents`	Read-only	The number of contents in the currently processed folder still to be reindexed after rights rule changes.
`PendingFolders`	Read-only	The IDs of all pending folders which are not yet reindexed completely due to rights rule changes. The Content Feeder may already have started indexing contents from the first returned folder.

Table 6.3. JMX attributes of the UpdateGroupsBackgroundFeed MBean

UpdateGroupsBackgroundFeed MBean Operations

The following table shows the operations of MBean com.coremedia:type=UpdateGroupsBackgroundFeed,application=content-feeder:

Operation	Parameter	Description
estimatePendingContents		Returns the total number of contents still to be reindexed after rights rule changes, that is, the number of contents in the folders returned by JMX attribute `PendingFolders`. This is an expensive operation.

Table 6.4. JMX operations of the UpdateGroupsBackgroundFeed MBean

AdminBackgroundFeed MBean Attributes

The following tables show the attributes of MBean com.coremedia:type=AdminBackgroundFeed,application=content-feeder.

Attribute	Type	Description
`NumberOfPendingContents`	Read-only	The number of contents left for triggered reindexing.
`State`	Read-only	A string that describes the internal state of the background feed.

Table 6.5. JMX attributes of the AdminBackgroundFeed MBean

AdminBackgroundFeed MBean Operations

The following table shows the operations of MBean com.coremedia:type=AdminBackgroundFeed,application=content-feeder:

Operation	Parameter	Description
reindexAll	optional: comma-separated list of aspect IDs for partial update	Triggers reindexing of all contents. If no aspects are specified, the whole contents get reindexed. If aspects are specified, partial updates are used.
reindexByQuery	Unified API query string optional: comma-separated list of aspect IDs for partial update	Triggers reindexing of all contents that fulfill the given UAPI query. If no aspects are specified, the whole contents get reindexed. If aspects are specified, partial updates are used.
reindexByType	content type name optional: comma-separated list of aspect IDs for partial update	Triggers reindexing of all contents of the given type and subtypes. If no aspects are specified, the whole contents get reindexed. If aspects are specified, partial updates are used.
cancel		Cancels reindexing triggered by this interface.

Table 6.6. JMX operations of the AdminBackgroundFeed MBean

Search Results

Table Of Contents

Filter