...
Each test is configurable to restrict it (without causing an error) in the grouper-ws.properties (grouper.properties in 2.2+). If you want to customize the number of minutes since a SUCCESS should be detected in loader jobs, you can do that as well. These settings are in the grouper-ws.properties (grouper.properties in 2.2+)
Note, there is a lot of intelligent caching here so that repeated hits do not do queries each time.
...
| Code Block |
|---|
#if ignore tests. Note, in job names, invalid chars need to be replaced with underscore (e.g. colon) #anything in this regex: [^a-zA-Z0-9._-] ws.diagnostic.ignore.memoryTest = false ws.diagnostic.ignore.dbTest_grouper = false ws.diagnostic.ignore.source_jdbc = false ws.diagnostic.ignore.loader_CHANGE_LOG_changeLogTempToChangeLog = false ws.diagnostic.ignore.loader_MAINTENANCE__grouperReport = false #number of minute that can go by without a success before an error is thrown ws.diagnostic.minutesSinceLastSuccess.loader_SQL_GROUP_LIST__aStem_aGroup2 = 60 |
Trivial option
Exclude/include jobs by URL param
You can includeOnly jobs in the URL by comma separated param (2.2.3+ and 2.2.2.api.patch.6)Use this to do checks often, or when there is a cluster, you can use this on all nodes, and a deeper check on one node only
https://url.to.grouper.edu/grouperWsgrouper/status?diagnosticType=trivial
Note, this is a success, but since there was an error recently, it is displayed
| Code Block |
|---|
Server: mchyzer-PC, grouperVersion: 1.6.0, up since: 2010/05/17 02:19, 0 requests
SUCCESS memoryTest: Allocating 100000 bytes to an array to make sure not out of memory (11ms elapsed)
Diagnostics errors since start: 3 (11ms elapsed)
Last diagnostics error date: 2010/05/17 02:23:27
Last diagnostics error message:
There was an error in the diagnostic task DiagnosticLoaderJobTest, Loader job CHANGE_LOG_changeLogTempToChangeLog
:Cant find a success since: 2010/05/17 01:38:50.000, expecting one in the last 30 minutes
java.lang.RuntimeException: Cant find a success since: 2010/05/17 01:38:50.000, expecting one in the last 30 minutes
at edu.internet2.middleware.grouper.ws.status.DiagnosticLoaderJobTest.doTask(DiagnosticLoaderJobTest.java:103)
at edu.internet2.middleware.grouper.ws.status.DiagnosticTask.executeTask(DiagnosticTask.java:44)
at edu.internet2.middleware.grouper.ws.status.GrouperStatusServlet.doGet(GrouperStatusServlet.java:129)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:617)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:717)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)
at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:433)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:128)
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:293)
at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:849)
at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:583)
at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:454)
at java.lang.Thread.run(Thread.java:619)
|
DB option
| Code Block |
|---|
SUCCESS loader_CHANGE_LOG_changeLogTempToChangeLog: Loader job CHANGE_LOG_changeLogTempToChangeLog ignored in config since URL param contains includeOnly which doesn't have 'loader_CHANGE_LOG_changeLogTempToChangeLog' (46ms elapsed)
SUCCESS loader_MAINTENANCE_cleanLogs: Not checking, there was a success from before: 2016/01/31 11:45:13.000, expecting one in the last 3120 minutes (46ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_syncGroups: Not checking, there was a success from before: 2016/01/31 15:14:00.000, expecting one in the last 30 minutes (46ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_grouperRules: Loader job CHANGE_LOG_consumer_grouperRules ignored in config since URL param contains includeOnly which doesn't have 'loader_CHANGE_LOG_consumer_grouperRules' (46ms elapsed)
SUCCESS loader_SQL_SIMPLE__loader:owner__9178d7d636de49d6b271d12ca351dc19: Not checking, there was a success from before: 2016/01/31 13:40:04.000, expecting one in the last 3120 minutes (46ms elapsed)
|
You can exclude jobs in the URL by comma separated param (2.2.3+ and 2.2.2.api.patch.6)
| Code Block |
|---|
SUCCESS loader_CHANGE_LOG_changeLogTempToChangeLog: Not checking, there was a success from before: 2016/01/31 15:14:50.000, expecting one in the last 30 minutes (31ms elapsed)
SUCCESS loader_MAINTENANCE_cleanLogs: Loader job MAINTENANCE_cleanLogs ignored in config since URL param contains exclude which has 'loader_MAINTENANCE_cleanLogs' (31ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_syncGroups: Loader job CHANGE_LOG_consumer_syncGroups ignored in config since URL param contains exclude which has 'loader_CHANGE_LOG_consumer_syncGroups' (31ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_grouperRules: Not checking, there was a success from before: 2016/01/31 15:14:02.000, expecting one in the last 30 minutes (31ms elapsed)
SUCCESS loader_SQL_SIMPLE__loader:owner__9178d7d636de49d6b271d12ca351dc19: Loader job SQL_SIMPLE__loader:owner__9178d7d636de49d6b271d12ca351dc19 ignored in config since URL param contains exclude which has 'loader_SQL_SIMPLE__loader:owner__9178d7d636de49d6b271d12ca351dc19' (31ms elapsed)
|
Trivial option
Use this to do checks often, or when there is a cluster, you can use this on all nodes, and a deeper check on one node onlyThis will do a lightweight query to the registry, and the memory query
https://url.to.grouper.edu/grouperWs/status?diagnosticType=dbtrivial
Note, this is a success, but since there was an error recently, it is displayed
| Code Block |
|---|
Server: mchyzer-PC, grouperVersion: 1.6.0, up since: 2010/05/17 02:19, 0 requests SUCCESS memoryTest: Allocating 100000 bytes to an array to make sure not out of memory (20ms11ms elapsed) SUCCESS dbTest_grouper: Retrieved object from database (28ms elapsed) Diagnostics errors since start: 3 (28ms elapsed) |
Subject sources
This will do a find by ID on all sources, and the DB test, and the memory test. Note that the same sources.xml settings in each source that configure the Grouper startup settings will apply here as well. i.e. you can skip a source, or set the ID to search for.
| Code Block |
|---|
<init-param>
<param-name>findSubjectByIdOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>subjectIdToFindOnCheckConfig</param-name>
<param-value>someSubjectIdWhichMightExistOrWhatever</param-value>
</init-param>
<init-param>
<param-name>findSubjectByIdentifiedOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>subjectIdentifierToFindOnCheckConfig</param-name>
<param-value>someSubjectIdentifierWhichMightExistOrWhatever</param-value>
</init-param>
<init-param>
<param-name>findSubjectByStringOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>stringToFindOnCheckConfig</param-name>
<param-value>someStringWhichMightExistOrWhatever</param-value>
</init-param> |
https://url.to.grouper.edu/grouperWs/status?diagnosticType=sources
Diagnostics errors since start: 3 (11ms elapsed)
Last diagnostics error date: 2010/05/17 02:23:27
Last diagnostics error message:
There was an error in the diagnostic task DiagnosticLoaderJobTest, Loader job CHANGE_LOG_changeLogTempToChangeLog
:Cant find a success since: 2010/05/17 01:38:50.000, expecting one in the last 30 minutes
java.lang.RuntimeException: Cant find a success since: 2010/05/17 01:38:50.000, expecting one in the last 30 minutes
at edu.internet2.middleware.grouper.ws.status.DiagnosticLoaderJobTest.doTask(DiagnosticLoaderJobTest.java:103)
at edu.internet2.middleware.grouper.ws.status.DiagnosticTask.executeTask(DiagnosticTask.java:44)
at edu.internet2.middleware.grouper.ws.status.GrouperStatusServlet.doGet(GrouperStatusServlet.java:129)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:617)
at javax.servlet.http.HttpServlet.service(HttpServlet.java:717)
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:290)
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:206)
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:233)
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:191)
at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:433)
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:128)
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:102)
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:293)
at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:849)
at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.process(Http11Protocol.java:583)
at org.apache.tomcat.util.net.JIoEndpoint$Worker.run(JIoEndpoint.java:454)
at java.lang.Thread.run(Thread.java:619)
|
DB option
This will do a lightweight query to the registry, and the memory query
https://url.to.grouper.edu/grouperWs/status?diagnosticType=db
| Code Block |
|---|
Server: mchyzer-PC, grouperVersion: 1.6.0, up since: 2010/05/17 02:19, 0 requests
SUCCESS memoryTest: Allocating 100000 bytes to an array to make sure not out of memory (20ms elapsed)
SUCCESS dbTest_grouper: Retrieved object from database (28ms elapsed)
Diagnostics errors since start: 3 (28ms elapsed)
|
Subject sources
This will do a find by ID on all sources, and the DB test, and the memory test. Note that the same sources.xml settings in each source that configure the Grouper startup settings will apply here as well. i.e. you can skip a source, or set the ID to search for.
| Code Block |
|---|
<init-param>
<param-name>findSubjectByIdOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>subjectIdToFindOnCheckConfig</param-name>
<param-value>someSubjectIdWhichMightExistOrWhatever</param-value>
</init-param>
<init-param>
<param-name>findSubjectByIdentifiedOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>subjectIdentifierToFindOnCheckConfig</param-name>
<param-value>someSubjectIdentifierWhichMightExistOrWhatever</param-value>
</init-param>
<init-param>
<param-name>findSubjectByStringOnCheckConfig</param-name>
<param-value>true|false</param-value>
</init-param>
<init-param>
<param-name>stringToFindOnCheckConfig</param-name>
<param-value>someStringWhichMightExistOrWhatever</param-value>
</init-param> |
https://url.to.grouper.edu/grouperWs/status?diagnosticType=sources
| Code Block |
|---|
Server: mchyzer-PC, grouperVersion: 1.6.0, up since: 2010/05/17 02:19, 0 requests
SUCCESS memoryTest: Allocating 100000 bytes to an array to make sure not out of memory (37ms elapsed)
SUCCESS dbTest_grouper: Retrieved object from database (40ms elapsed)
SUCCESS source_g:gsa: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (42ms elapsed)
SUCCESS source_jdbc: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (45ms elapsed)
SUCCESS source_g:isa: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (45ms elapsed)
Diagnostics errors since start: 3 (45ms elapsed)
|
Daemon jobs
Note: grouper 2.2.3+ and 2.2.2.api.patch.6 has a diagnostic type of daemonJobsOnly where only daemon (and loader) jobs will be run.
https://url.to.grouper.edu/grouperWs/status?diagnosticType=daemonJobsOnly
| Code Block |
|---|
Server: mchyzer-pc, grouperVersion: 2.2.2, up since: 2016/01/31 15:14, 0 requests
SUCCESS loader_CHANGE_LOG_changeLogTempToChangeLog: Not checking, there was a success from before: 2016/01/31 15:14:50.000, expecting one in the last 30 minutes (65ms elapsed)
SUCCESS loader_MAINTENANCE_cleanLogs: Not checking, there was a success from before: 2016/01/31 11:45:13.000, expecting one in the last 3120 minutes (65ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_syncGroups: Not checking, there was a success from before: 2016/01/31 15:14:00.000, expecting one in the last 30 minutes (66ms elapsed)
SUCCESS loader_CHANGE_LOG_consumer_grouperRules: Not checking, there was a success from before: 2016/01/31 15:14:02.000, expecting one in the last 30 minutes (66ms elapsed)
SUCCESS loader_SQL_SIMPLE__loader:owner__9178d7d636de49d6b271d12ca351dc19: Not checking, there was a success from before: 2016/01/31 13:40:04.000, expecting one in the last 3120 minutes (66ms |
| Code Block |
Server: mchyzer-PC, grouperVersion: 1.6.0, up since: 2010/05/17 02:19, 0 requests SUCCESS memoryTest: Allocating 100000 bytes to an array to make sure not out of memory (37ms elapsed) SUCCESS dbTest_grouper: Retrieved object from database (40ms elapsed) SUCCESS source_g:gsa: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (42ms elapsed) SUCCESS source_jdbc: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (45ms elapsed) SUCCESS source_g:isa: Searched for subject by id: grouperTestSubjectByIdOnStartupASDFGHJ (45ms elapsed) Diagnostics errors since start: 30 (45ms66ms elapsed) |
Loader jobs
"all" This will test all loader jobs (for a success within a certain threshold), do a find by ID on all sources, and the DB test, and the memory test. By default all loader jobs will look for a success within the last 25 hours. The exception is change log jobs which look for a success within the last 30 minutes. This is configurable in the grouper-ws.properties
...