Releases: LD4P/qa_server
v2.2.1
Actions Required to Upgrade
Update to qa_server v2.2.1
bundle update qa_server
New Configuration Options
All new configurations are optional.
The two new configurations are:
config.display_performance_graph = false
config.display_performance_datatable = true
It is recommended that you copy the new configurations to keep your local config file in sync with the configurations.
Copy only the new configs...
FROM: lib/generators/qa_server/templates/config/initializers/qa_server.rb
TO: config/initializers/qa_server.rb
Warning: The default values are not backward compatible. In v2.2.0, the performance graphs were displayed with no option to disable them. Some sites experienced difficulty with the graphs, so the display of the graph is now off by default.
To maintain backward compatibility, change config.display_performance_graph
to true
in your local copy of qa_server.rb
.
Changed Log
- config to optionally display of the performance graph/datatable
- add data table view of performance data
v2.2.0
Actions Required to Upgrade
Actions are required for this upgrade to add a new database migration.
Update to qa_server v2.2.0
bundle update qa_server
Updates for Performance Metrics
Database table to store performance data
Pull in one new migration to add the performance_history table. Should add migration: *_create_performance_history.qa_server.rb
rake qa_server:install:migrations
Run migrations
rake db:migrate
QA overrides to write performance data to the database
Update /config/application.rb
to include the following prepend registrations. If this is the first prepend for your application, copy all the lines. Otherwise, just add the two registrations with your existing prepends.
config.to_prepare do
Qa::Authorities::LinkedData::FindTerm.prepend PrependedLinkedData::FindTerm
Qa::Authorities::LinkedData::SearchQuery.prepend PrependedLinkedData::SearchQuery
end
Creating metric graphs from performance data
Prerequisite: ImageMagick This was optional and is now required to be able to produce the performance metric graphs.
Add a directory to hold the images created by Gruff graphing library, if it doesn't already exist.
/app/assets/images/qa_server/charts
View performance metric graphs
The graphs are generated dynamically at request time and are displayed at the bottom of the Monitor Status page in the qa_server UI.
Data can be viewed for a day (last 24 hours), for a month (last 30 days), or for a year (last 12 months). The chart show lines for time to fetch the data from the source authority, time to normalize the data, and the time of the full request which includes the sum of both those times.
Change Log
- add performance graphs to monitor status page
- add ability to fetch a term through the UI
- update authority configs to latest versions
v2.1.0
Change Log
- remove context from mesh_nlm; add direct match to locnames
- fix missing getty ids in linked data auth
- update ldpaths for locnames extended context
- fix oclcfast linked data config to properly configure passing uri instead of id
- update code to work with qa 4.2.0
- update configs to QA_CONFIG_VERSION 2.1
- allow scenarios to specify whether the authority supports extended context for search
- add
encode: true
to search query param for all 2.0 configs - Update locperformance_ld4l_cache_validation.yml
- add parentheses to complex ldpath to fix parse error
- update instructions to work with latest rails new command
v2.0.0
v1.2.3
v1.2.2
Actions Required to Upgrade
There are no actions requires to upgrade to this release.
Change Log
1.2.2 (2018-11-21)
- update data tables to make authority names more prominent
- use consistent titles on each page to make it easier to tell where you are in the app
1.2.1 (2018-11-20)
- update Usage page to describe fetch and show options for retrieving a single term
v1.2.0
Actions Required to Upgrade
Update QA gem to...
gem 'qa', github: 'samvera/questioning_authority', tag: '496aaa34c4aba6d97d11737b229ea66ea4c64639'
See QA 2.2.0 release notes for information on configuring the auth_token for reloading authorities using the API.
Change Log
- update QA which includes...
- extended QA API (e.g. list, reload, fetch)
- fetch/show terms optionally returned as json-ld (default = json for backward compatibility)
- update dependencies for security vulnerabilities
- fix accuracy tests
- default term tests to use fetch instead of show when term identifier is a URI
- get list of authority names from QA AuthorityService
v1.1.0
Released: Oct 31, 2018
Actions Required to Upgrade
Update QA gem to...
gem 'qa', github: 'samvera/questioning_authority', tag: 'f44e597474cd55f64fb31a77bdb39ece81b97fa8'
New Configuration Options
All new configurations are optional and have backward compatible defaults. If you want to set the new configurations, copy the new configurations from...
lib/generators/qa_server/templates/config/initializers/qa_server.rb
Navigation Menu
You can add additional menu items to the navigational menu using configuration config.navmenu_extra_leftitems
. This is most commonly used to add a link to API documentation.
Historical Data on Monitor Status page
There are two ways to display historical data:
- graph - turn on by setting
config.dispaly_historical_graph = true
(default=false) - datatable - turn on by setting
config.dispaly_historical_datatable = true
(default=true)
If you want to show the graph, you will also need to create a .keep file in the following directory in your app to insure this directory exists when the graph is created.
app/assets/images/qa_server/charts/.keep
Change Log
- allow historical data to be displayed as graph or datatable (configuration)
- drive main nav menu from navmenu_presenter (configuration)
- Add better install instructions in README
v1.0.0
This release sees updates to historical data tracking. It now tracks both passing and failing connection tests. And it shows a graph on the Monitor Status page showing connection results over time.
Required Actions:
- migrate database tables with
rake db:migrate
- add ImageMagick prerequisite (see README for link)
- create
app/assets/images/qa_server/charts/.keep
Be sure the following gems are in your Gemfile
gem 'qa', github: 'samvera/questioning_authority', tag: 'e870fc07b991188053d2cd9eeb6a843b896911d8'
gem 'linkeddata'
NOTE: The linkeddata gem is recommended. The ruby-rdf/linkeddata library provides support for a wide range of RDF formats. You can optionally include gems separately that process each RDF format individually. See the README for ruby-rdf/linkeddata for a list of individual gems.
Change Log:
- drive URL base host path from qa engine mount location
- show graph of historical data on monitor status page (prereq: ImageMagick)
- expand historical data to track all test results (passing and failing) (requires: db migrations)
- add bixby to control rubocop styles consistent with Hyrax
- add ability to use configurations to control app features
- fix security vulnerabilities
v0.1.99
First release with ld4l-labs/qa_server app converted to LD4P/qa_server engine. This is an exact match in functionality.
Known to work with QA version:
gem 'qa', github: 'samvera/questioning_authority', tag: '7fc60a1a205430774d32cff9dea9993fe68fcb76'