Enhanced DistributedObjectAdmin to compare for inconsistencies between instances #426
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * This file belongs to Hoist, an application development toolkit | ||
| * developed by Extremely Heavy Industries (www.xh.io | [email protected]) | ||
| * | ||
| * Copyright © 2022 Extremely Heavy Industries Inc. | ||
| */ | ||
| package io.xh.hoist.admin | ||
|
|
||
| import io.xh.hoist.BaseController | ||
| import io.xh.hoist.security.Access | ||
|
|
||
| @Access(['HOIST_ADMIN_READER']) | ||
| class DistributedObjectAdminController extends BaseController { | ||
| def distributedObjectAdminService | ||
|
|
||
| def getDistributedObjectsReport() { | ||
| renderJSON(distributedObjectAdminService.getDistributedObjectsReport()) | ||
| } | ||
|
|
||
| @Access(['HOIST_ADMIN']) | ||
| def clearObjects() { | ||
| def req = parseRequestJSON() | ||
| distributedObjectAdminService.clearObjects(req.names) | ||
| renderJSON([success: true]) | ||
| } | ||
|
|
||
| @Access(['HOIST_ADMIN']) | ||
| def clearHibernateCaches() { | ||
| distributedObjectAdminService.clearHibernateCaches() | ||
| renderJSON([success: true]) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,247 @@ | ||
| /* | ||
| * This file belongs to Hoist, an application development toolkit | ||
| * developed by Extremely Heavy Industries (www.xh.io | [email protected]) | ||
| * | ||
| * Copyright © 2024 Extremely Heavy Industries Inc. | ||
| */ | ||
| package io.xh.hoist.admin | ||
|
|
||
| import com.hazelcast.cache.impl.CacheProxy | ||
| import com.hazelcast.collection.ISet | ||
| import com.hazelcast.core.DistributedObject | ||
| import com.hazelcast.executor.impl.ExecutorServiceProxy | ||
| import com.hazelcast.map.IMap | ||
| import com.hazelcast.nearcache.NearCacheStats | ||
| import com.hazelcast.replicatedmap.ReplicatedMap | ||
| import com.hazelcast.ringbuffer.impl.RingbufferProxy | ||
| import com.hazelcast.topic.ITopic | ||
| import io.xh.hoist.BaseService | ||
| import io.xh.hoist.cluster.ClusterRequest | ||
| import io.xh.hoist.cluster.DistributedObjectInfo | ||
| import io.xh.hoist.cluster.DistributedObjectsReport | ||
|
|
||
| import javax.cache.expiry.Duration | ||
| import javax.cache.expiry.ExpiryPolicy | ||
|
|
||
| import static io.xh.hoist.util.Utils.appContext | ||
|
|
||
| class DistributedObjectAdminService extends BaseService { | ||
| def grailsApplication | ||
|
|
||
| DistributedObjectsReport getDistributedObjectsReport() { | ||
| def startTimestamp = System.currentTimeMillis(), | ||
| responsesByInstance = clusterService.submitToAllInstances(new ListDistributedObjects()) | ||
| return new DistributedObjectsReport( | ||
| info: responsesByInstance.collectMany {it.value.value}, | ||
| startTimestamp: startTimestamp, | ||
| endTimestamp: System.currentTimeMillis() | ||
| ) | ||
| } | ||
|
|
||
| private List<DistributedObjectInfo> listDistributedObjects() { | ||
| // Services and their resources | ||
| Map<String, BaseService> svcs = grailsApplication.mainContext.getBeansOfType(BaseService.class, false, false) | ||
| def resourceObjs = svcs.collectMany { _, svc -> | ||
| [ | ||
| // Services themselves | ||
| getInfo(obj: svc, name: svc.class.getName(), type: 'Service'), | ||
|
There was a problem hiding this comment. think we could clarify with two methods that each just take a single object, and do type switching as needed -- e.g. getHoistInfo(Object obj) and getHzInfo(DistributedObject obj) -- symmetry! There was a problem hiding this comment. The issue I had with this was the fact that resource objects don't always know their full name - they often use a relative name. So a fully-symmetrical |
||
| // Resources, excluding those that are also DistributedObject | ||
| *svc.resources.findAll { k, v -> !(v instanceof DistributedObject)}.collect { k, v -> | ||
| getInfo(obj: v, name: svc.hzName(k)) | ||
| } | ||
| ] | ||
| }, | ||
| // Distributed objects | ||
| hzObjs = clusterService | ||
| .hzInstance | ||
| .distributedObjects | ||
| .findAll { !(it instanceof ExecutorServiceProxy) } | ||
| .collect { getInfoForObject(it) } | ||
|
|
||
| return [*hzObjs, *resourceObjs].findAll{ it } as List<DistributedObjectInfo> | ||
|
|
||
| } | ||
| static class ListDistributedObjects extends ClusterRequest<List<DistributedObjectInfo>> { | ||
| List<DistributedObjectInfo> doCall() { | ||
| appContext.distributedObjectAdminService.listDistributedObjects() | ||
| } | ||
| } | ||
|
|
||
| void clearObjects(List<String> names) { | ||
|
There was a problem hiding this comment. Lets call this clearHibernateCaches and be specific! Could potentially combine with method below, or rename method below |
||
| def all = clusterService.distributedObjects | ||
| names.each { name -> | ||
| def obj = all.find { it.getName() == name } | ||
| /** Keep in sync with frontend clear set - `DistributedObjectsModel.clearableTypes`. */ | ||
| if (obj instanceof CacheProxy) { | ||
| obj.clear() | ||
| logInfo("Cleared " + name) | ||
| } else { | ||
| logWarn('Cannot clear object - unsupported type', name) | ||
|
There was a problem hiding this comment. obsolete log text -- should be hibernate cache not found. |
||
| } | ||
| } | ||
| } | ||
|
|
||
| void clearHibernateCaches() { | ||
| appContext.beanDefinitionNames | ||
| .findAll { it.startsWith('sessionFactory') } | ||
| .each { appContext.getBean(it)?.cache?.evictAllRegions() } | ||
| } | ||
|
|
||
| Map getAdminStatsForObject(DistributedObject obj) { | ||
| return getInfoForObject(obj)?.adminStats | ||
| } | ||
|
|
||
| DistributedObjectInfo getInfo(Map args) { | ||
| def obj = args.obj, | ||
| comparisonFields = null, | ||
| adminStats = null, | ||
| error = null | ||
|
|
||
| try { | ||
| comparisonFields = obj.hasProperty('comparisonFields') ? obj.comparisonFields : null | ||
| adminStats = obj.hasProperty('adminStats') ? obj.adminStats : null | ||
| } catch (Exception e) { | ||
| def msg = 'Error extracting admin stats' | ||
| logError(msg, e) | ||
| error = "$msg | $e.message" | ||
|
There was a problem hiding this comment. would prefer curly braces on $e.message. |
||
| } | ||
|
|
||
| return new DistributedObjectInfo( | ||
| comparisonFields: comparisonFields, | ||
| adminStats: adminStats, | ||
| error: error, | ||
| *: args | ||
| ) | ||
| } | ||
|
|
||
| DistributedObjectInfo getInfoForObject(DistributedObject obj) { | ||
| switch (obj) { | ||
| case ReplicatedMap: | ||
| def stats = obj.getReplicatedMapStats() | ||
| return new DistributedObjectInfo( | ||
| comparisonFields: ['size'], | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'ReplicatedMap', | ||
| size : obj.size(), | ||
| lastUpdateTime: stats.lastUpdateTime ?: null, | ||
| lastAccessTime: stats.lastAccessTime ?: null, | ||
|
|
||
| hits : stats.hits, | ||
| gets : stats.getOperationCount, | ||
| puts : stats.putOperationCount | ||
| ] | ||
| ) | ||
| case IMap: | ||
| def stats = obj.getLocalMapStats() | ||
| return new DistributedObjectInfo( | ||
| comparisonFields: ['size'], | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'IMap', | ||
| size : obj.size(), | ||
| lastUpdateTime : stats.lastUpdateTime ?: null, | ||
| lastAccessTime : stats.lastAccessTime ?: null, | ||
|
|
||
| ownedEntryCount: stats.ownedEntryCount, | ||
| hits : stats.hits, | ||
| gets : stats.getOperationCount, | ||
| sets : stats.setOperationCount, | ||
| puts : stats.putOperationCount, | ||
| nearCache : getNearCacheStats(stats.nearCacheStats), | ||
| ] | ||
| ) | ||
| case ISet: | ||
| def stats = obj.getLocalSetStats() | ||
| return new DistributedObjectInfo( | ||
| comparisonFields: ['size'], | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'ISet', | ||
| size : obj.size(), | ||
| lastUpdateTime: stats.lastUpdateTime ?: null, | ||
| lastAccessTime: stats.lastAccessTime ?: null, | ||
| ] | ||
| ) | ||
| case ITopic: | ||
| def stats = obj.getLocalTopicStats() | ||
| return new DistributedObjectInfo( | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'Topic', | ||
| publishOperationCount: stats.publishOperationCount, | ||
| receiveOperationCount: stats.receiveOperationCount | ||
| ] | ||
| ) | ||
| case RingbufferProxy: | ||
| return new DistributedObjectInfo( | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'Ringbuffer', | ||
| size : obj.size(), | ||
| capacity: obj.capacity() | ||
| ] | ||
| ) | ||
| case CacheProxy: | ||
| def evictionConfig = obj.cacheConfig.evictionConfig, | ||
| expiryPolicy = obj.cacheConfig.expiryPolicyFactory.create(), | ||
| stats = obj.localCacheStatistics | ||
| return new DistributedObjectInfo( | ||
| comparisonFields: ['size'], | ||
| adminStats: [ | ||
| name : obj.getName(), | ||
| type : 'Hibernate Cache', | ||
| size : obj.size(), | ||
| lastUpdateTime : stats.lastUpdateTime ?: null, | ||
| lastAccessTime : stats.lastAccessTime ?: null, | ||
|
|
||
| ownedEntryCount : stats.ownedEntryCount, | ||
| cacheHits : stats.cacheHits, | ||
| cacheHitPercentage: stats.cacheHitPercentage?.round(0), | ||
| config : [ | ||
| size : evictionConfig.size, | ||
| maxSizePolicy : evictionConfig.maxSizePolicy, | ||
| evictionPolicy: evictionConfig.evictionPolicy, | ||
| expiryPolicy : formatExpiryPolicy(expiryPolicy) | ||
| ] | ||
| ] | ||
| ) | ||
| default: | ||
| return new DistributedObjectInfo( | ||
| adminStats: [ | ||
| name: obj.getName(), | ||
| type: obj.class.toString() | ||
| ] | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| //-------------------- | ||
| // Implementation | ||
| //-------------------- | ||
| private Map getNearCacheStats(NearCacheStats stats) { | ||
| if (!stats) return null | ||
| [ | ||
| ownedEntryCount : stats.ownedEntryCount, | ||
| lastPersistenceTime: stats.lastPersistenceTime, | ||
| hits : stats.hits, | ||
| misses : stats.misses, | ||
| ratio : stats.ratio.round(2) | ||
| ] | ||
| } | ||
|
|
||
| private Map formatExpiryPolicy(ExpiryPolicy policy) { | ||
| def ret = [:] | ||
| if (policy.expiryForCreation) ret.creation = formatDuration(policy.expiryForCreation) | ||
| if (policy.expiryForAccess) ret.access = formatDuration(policy.expiryForAccess) | ||
| if (policy.expiryForUpdate) ret.update = formatDuration(policy.expiryForUpdate) | ||
| return ret | ||
| } | ||
|
|
||
|
|
||
| private String formatDuration(Duration duration) { | ||
| if (duration.isZero()) return 0 | ||
| if (duration.isEternal()) return 'eternal' | ||
| return duration.timeUnit.toSeconds(duration.durationAmount) + 's' | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see below re: naming of these two endpoints to be more specific.