Versions Compared

Old Version 6

changes.mady.by.user Jim Blake

Saved on

compared with

New Version 7

changes.mady.by.user Jim Blake

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The diagnostic tools are enabled and controlled by settings within VIVO. These settings may be changed interactively, without restarting VIVO. The settings may also be read from a file, so they will be in effect as VIVO is starting up.

Terms

Developer Mode

When the diagnostic tools are enabled, VIVO is said to be running in "Developer Mode".  This reflects the fact that all of the developer settings are ignored unless the tools as a whole are enabled.

Developer Settings

These are parameters that control the diagnostic tools. They may be set interactively, using the Developer Panel, or read from the developer.settings file at startup.

The Developer Panel

When VIVO is in developer mode, the Developer Panel appears on every page. This serves two purposes:

  1. It enables you to change the Developer Settings without navigating away from your current page.
  2. It provides a visual reminder that VIVO is in Developer Mode. If a production instance were accidentally configured to run in Developer Mode, it would be easily noticed.

No Developer PanelDeveloper Panel (closed)

 

Entering Developer Mode

developer.properties file

When VIVO starts up, it looks for a file in the home directory, named developer.properties. If the file is found, the settings are read from it. Any settings that are not found in the file keep their default values. If the file is not found, then all settings keep their default values until set interactively.

...

The VIVO distribution includes an example.developer.properties file.  It contains descriptions of all of the settings, with examples. You can rename example.developer.properties to developer.properties, and uncomment the settings you want to use.

Interactively entering developer mode

Log in as a system administrator (or root). Go to the Site Administration page. Click on Activate developer panel.

...

In the panelInsert HTML comments and start and end of templates
In the filedeveloper.insertFreemarkerDelimiters
Effect

If true, you may view the HTML source for a VIVO page to see which Freemarker templates were used to create each portion of the page.

Code Block
languagexml
...
<!-- FM_BEGIN view-search-default.ftl -->
<a href="/vivo/display/n2252" title="individual name">Oswald, Jeremiah</a>
        <span class="display-title">Faculty Member</span>
<p class="snippet"></p><!-- FM_END view-search-default.ftl -->
...

SPARQL Query settings

In the panel LOG each query
In the filedeveloper.loggingRDFService.enable
Effect 
In the panel 
In the filedeveloper.

Write an entry to the log for each SPARQL query, assuming that INFO-level logging is enabled for the RDFServiceLogger. Each entry includes

  • The time spent executing the query
  • The name of the method on RDFService that received the query
  • The format of the result stream from RDFService
  • The text of the query.

The remaining settings in this area can be used to restrict which queries are logged, or to include more information for each query.

Effect 

In the panel Add stack trace
In the filedeveloper.loggingRDFService.stackTrace
Effect Each log entry will include a stack trace. The trace is abridged so it starts after the ApplicationFilterChain, omits any Jena classes, and ends at the RDFService.
In the panel Restrict by query string
In the filedeveloper.loggingRDFService.queryRestriction
Effect Set this to a regular expression. A query will be logged only if the text of the query matches the regular expression, in whole or in part.
 
In the panel Restrict by calling stack
In the filedeveloper.loggingRDFService.stackRestriction
EffectSet this to a regular expression. A query will be logged only if the abridged calling stack matches the regular expression, in whole or in part.

Page configuration settings

In the panel Log the use of custom list view XML files.
In the filedeveloper.pageContents.logCustomListView
Effect Write an entry to the log each time a property is displayed using a list view other than the default lists view.
In the panel Log the use of custom short views in search, index and browse pages.
In the filedeveloper.pageContents.logCustomShortView
Effect 
In the panel 
In the filedeveloper.
Effect 
Write an entry to the log each time a search result is displayed using a short view other than the default view for that context.

Language support settings

In the panelDefeat the cache of language property filesIn the panel 
In the filedeveloper.i18n.defeatCache
Effect If true, the language property files are re-loaded each time they are called for. If false, the language property files are loaded only once, when VIVO starts up.
In the panel
In the panel Log the retrieval of language strings
In the filedeveloper.i18n.logStringRequests.
Effect Write an entry to the log each time a language-specific string is retrieved from one of the language property files.

 

...

 

 

...