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

Solr statistics documentation in DSpace manual and DSDOC is out-of-date, wrong, and inconsistent with dspace.cfg

    XMLWordPrintable

    Details

    • Type: Documentation
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.6.0, 1.6.1, 1.6.2
    • Fix Version/s: 1.7.1
    • Component/s: Documentation
    • Labels:
      None
    • Attachments:
      0
    • Comments:
      9
    • Documentation Status:
      Complete or Committed

      Description

      DSDOC:
      ======

      • refers to solr.spidersfile instead of solr.spiderips.urls and gives an invalid usage instruction (should be replaced with solr.spiderips.urls with usage of org.dspace.statistics.util.StatisticsClient -u to download an update of files from URLs given)
      • misses out documentation for solr.statististics.query.filter.isBot and solr.statistics.query.filter.spiderIp configuration properties
      • misses out documentation for solr.statistics.logBots
      • misses out documentation for solr.resolver.timeout
      • misses out any documentation/usage examples for org.dspace.statistics.util.StatisticsClient CLI utility

      DSpace 1.6.2 Manual:
      =================

      • Section "5.2.49. DSpace SOLR Statistics Configuration" suffers the same problem as DSDOC wiki area

      statistics.items.dc.1=dc.identifier
      statistics.items.dc.2=dc.date.accessioned
      statistics.items.type.1=dcinput
      statistics.items.type.2=date
      statistics.default.start.datepick = 01/01/1977

      • misses out any documentation/usage examples for org.dspace.statistics.util.StatisticsClient CLI utility

      Inconsistent dspace.cfg property naming
      ==============================
      Some properties prefixed with statistics.* (particularly confusing when configuring legacy stats reports)
      Some properties prefixed with solr.* (ie. not solr.statistics.*)
      Some properties prefixed with solr.statistics.* (this seems sensible and I think should be the primary prefix for solr statistics properties)
      Some properties have no prefix at all (eg. useProxies – unless this is used for something other than solr stats?)

      The term "Spider" is used to denote a spider/crawler robot such as Google or Yahoo, not "Bot", but terms are then mixed with property names like 'logBots' and 'isBot' instead. (also appears in places in code)

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              kshepherd Kim Shepherd
              Reporter:
              kshepherd Kim Shepherd
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: