Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-2659

Add configurable "healthcheck" system emailing internals of the repository on regular basis

    Details

    • Attachments:
      0
    • Comments:
      3
    • Documentation Status:
      Complete or Committed

      Description

      Repository maintainers can benefit from regular reports about the state of the system emailed to them.

      Our reporting system creates report like the following (some numbers do not need to make sense because they are from a testing instance) from a number of "health checks".

            1. General Information [took: 0s] [# lines: 6]
              Generated: Fri Jul 17 11:50:07 CEST 2015
              From - Till: 07/10/2015 - 07/17/2015
              Url: https://ufal-point-dev.ms.mff.cuni.cz/repository/xmlui

      Assetstore size: : 384 GB
      Search dir size: : 298 KB
      Log dir size: : 78 MB

      ###############################

            1. Item summary [took: 0s] [# lines: 31]
              Collection [Hehe]: 0
              Collection [LINDAT / CLARIN]: 137
              Collection [LRT + Open Submissions]: 976
              ...
              Resource without policy: 1
              Deleted bitstreams: 73
              Orphan bitstreams: 0 []

      Published items (archived, not withdrawn): 1113
      Withdrawn items: 137
      Not published items (in workspace or workflow mode): 58
      In Stage 1: 31
      In Stage 2: 3
      In Stage 3: 7
      In Stage 4: 2
      In Stage 5: 12
      Waiting for approval (workflow items): 3
      Count bitstream: 695
      Count bundle: 286
      Count collection: 3
      Count community: 3
      Count dcvalue: 21301
      Count eperson: 208
      Count item: 1308
      Count handle: 1274
      Count epersongroup: 15
      Count workflowitem: 3
      Count workspaceitem: 55

      ###############################

            1. User summary [took: 0s] [# lines: 22]
              Users: 208
              Have email: 197
              Self registered: 6
              Can log in (password): 33
              Have 2nd name: 158
              Have lang: 173
              Have 1st name: 142
              Have netid: 6
              ...

      Configuration config/modules/healthcheck.cfg looks like this

          1. Healthcheck module config
      1. names must match plugin.named below
        checks = General Information,\
        Checksum,\
        Embargo items,\
        Item summary,\
        User summary,\
        Log Analyser Check,\
        Additional Information,\
        Assetstore validity,\
        Curation Summary,\
        Logs Check,\
        OAI-PMH validation,\
        PID check,\
        Shibboleth Check,\
        Legal Check,\
        VLO check

      plugin.named.org.dspace.health.Check = \
      org.dspace.health.InfoCheck = General Information,\
      org.dspace.health.ChecksumCheck = Checksum,\
      org.dspace.health.EmbargoCheck = Embargo items,\
      org.dspace.health.ItemCheck = Item summary,\
      org.dspace.health.UserCheck = User summary,\
      org.dspace.health.LogAnalyserCheck = Log Analyser Check,\
      cz.cuni.mff.ufal.health.AdditionalInfoCheck = Additional Information,\
      cz.cuni.mff.ufal.health.AssetstoreValidityCheck = Assetstore validity,\
      cz.cuni.mff.ufal.health.CuratorCheck = Curation Summary,\
      cz.cuni.mff.ufal.health.LogsCheck = Logs Check,\
      cz.cuni.mff.ufal.health.OAIPMHCheck = OAI-PMH validation,\
      cz.cuni.mff.ufal.health.PIDCheck = PID check,\
      cz.cuni.mff.ufal.health.ShibbolethCheck = Shibboleth Check,\
      cz.cuni.mff.ufal.health.SubmissionRightsCheck = Legal Check,\
      cz.cuni.mff.ufal.health.VLOCheck = VLO check

      1. report from the last N days (where dates are applicable)
        last_n_days = 7

      Some of the information is available in Control Panel and other places but the healthcheck system can run for hours (we verify checksums, perform assetstore validity checking and execute predefined curation tasks which in total really takes a couple of hours) and present a comprehensive report.

      Note:
      There is another tool in bin/dspace-info.pl which logs several interesting information but is not easily extensible/configurable with repository specific reports, has not been updated for several years, (is in perl) and is not part of dspace where it should belong.

        Attachments

          Activity

            People

            • Assignee:
              helix84 Ivan Masár
              Reporter:
              vidiecan Jozef (@lindat)
              Reviewer:
              Hardy Pottinger (Inactive)
            • Votes:
              1 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: