Contribute to the DSpace Development Fund

The newly established DSpace Development Fund supports the development of new features prioritized by DSpace Governance. For a list of planned features see the fund wiki page.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Introduction

To complement the developments for the COAR Notify protocol COAR Notify Documentation, the Notify Dashboard has been implemented to monitor the general usage of the COAR Notify protocol across the repository.

The dashboard is accessible to repository administrators only via the menu voice COAR Notify > Dashboard.


The dashboard is organised in three tabs:

  • Metrics

  • Logs/Inbound

  • Logs/Outbound

Metrics

The “Metrics” tab displays data about usage of the COAR Notify protocol, showing the number of received (accepted/processed/failure/untrusted) and generated (delivered/queued/queued for retry/failure) LDNs, and the total number of items involved.

Valid LDN messages coming from UNTRUSTED sources will be counted, and put under the category UNTRUSTED.


Each colored box is clickable:

  • accepted / processed / failure / untrusted / delivered / queued / queued for retry / failure will redirect the user to the corrisponding log’s tab (either inbund or outbound), showing logs already filtered by the corresponding status 

  • Involved items will redirect the user to the Admin Search page, where only involved items, either by incoming or outgoing LDN messages, will be shown in the results list.
    Items can than be further filtered also for any COAR Notify metadata (notify.relation.endorsedBy, datacite.relation.isReviewedBy, and datacite.relation.isReferencedBy) if any is present within an item.



Note: syntatically invalid messages or other attempt to unproperly access the LDN inbox should be checked via the web server log files (this is mainly to avoid any service attack or spam).

Logs/Inbound

In the “Logs/Inbound” tab it’s possible to search and check the individual status of each LDN message sent by the repository.

Logs are listed in a table displaying the following columns:

  • Timestamp

  • Repository item

  • LDN Service

  • Type

  • Status

  • Action


Logs can be scrolled and/or filtered by:

  • Related item

  • LDN Service

  • Queue status

  • Activity stream type

  • COAR Notify type

  • Last processing time

In the logs' table, the value in the “Repository Item” column links to the involved item in the repository.

By clicking on the 'detail' button corresponding to each log, a modal will open displaying all the information of the received LDN message, and it will also be possible to inspect the relevant JSON payload.



In case of messages with a queue status equal to “failed” and “unmapped action”, a second button ”Reprocess” will be displayed. By clicking this button, a request to reprocess the LDN message is triggered.
This allows administrators to reprocess, for instance, messages received from LDN services that have not yet been registered, or whose data (i.e. service URL and IP range) have not been correctly entered in the LDN service registry.

In case of deleted items, LDN services, etc., “n/a” will be shown in the logs' table.

Logs with “Unmapped Action” status don’t display a timestamp, as they have not been processed.

Logs/Oubound

In the “Logs/Outbound” tab it’s possible to search and check the individual status of each LDN message received by the repository.

Logs are listed in a table displaying the following columns:

  • Timestamp

  • Repository item

  • LDN Service

  • Type

  • Status

  • Action



Logs can be scrolled and/or filtered by:

  • Related item

  • LDN Service

  • Queue status

  • Activity stream type

  • COAR Notify type

  • Last processing time


In the logs' table, the value in the “Repository Item” column links to the involved item in the repository.

By clicking on the 'detail' button corresponding to each log, a modal will open displaying all the information of the received LDN message, and it will also be possible to inspect the relevant JSON payload.



In case of messages with a queue status equal to “untrusted” and “failed”, a second button ”Reprocess” will be displayed. By clicking this button, a request to reprocess the message is triggered.
This allows administrators to reprocess messages received from LDN services that have not yet been registered in the repository, or whose data (i.e. service URL and IP range) have not been correctly entered in the LDN service registry.

In case of deleted items, LDN services, etc., “n/a” will be shown in the logs' table.

Logs with “Untrusted” status don’t display a timestamp, as they have not been processed.

Test calls

Accessing and browsing the COAR Notify Dashboard

  • Login as an Admin. A “COAR Notify > Dashboard” menu entry should be included in the administrative menu

  • After clicking on “Dashboard”, the landing page will display three tabs: Metrics, Logs/Inbound, and Logs/Outbound.

  • As a default, the Metrics tab will be displayed as landing page and it will displays the following statistics, grouped in colored boxes (Metrics tab):

    • Number of received LDNs split by Accepted, Processed, Failure, and Untrusted

    • Number of generated LDNs split by Delivered, Queued, Queued for retry, and Failure

    • The total number of items involved, distinguished by received and sent LDNs

  • Click on the “Accepted” box in the “Number of received LDN” section

  • The page will shift to the “Logs/Inbound” tab, with the table showing only messages with an Accepted status. The number of messages will match the number displayed in the Accepted box of the Metrics tab

  • Browse back to the Metrics tab

  • Click on the “Involved items” box in the “Number of received LDN” section

  • The user will be redirected to the Admin Search page, where only items involved in incoming LDN messages will be listed, and it will be possible to filter them by COAR Notify metadata, if any is present in an item

  • Browse back to the COAR Notify > Dashboard

  • Browse to the Logs/Inbound tab

  • The page will present a table listing the logs of all inbound LDN messages, with filters facets on the left side

  • Each log will have a corresponding button “Detail”, which will open a modal displaying the LDN message information and the related JSON payload

  • Logs with status “Failed” and “Unmapped Action” will display also a “Reprocess” button

  • Browse to the Logs/Outbound tab

  • The page will present a table listing the logs of all outbound LDN messages, with filters facets on the left side

  • Each log will have a corresponding button “Detail”, which will open a modal displaying the LDN message information and the related JSON payload

  • Logs with status “Failed” and “Untrusted” will display also a “Reprocess” button

Number of received LDN from a TRUSTED source

  • Access the Metric tab in the COAR Notify Dashboard

  • Drop a valid COAR LDN message from a TRUSTED source to the DSpace inbox

  • The number of received LDNs should be incresed by one

  • Wait up to 2 minutes and refresh the page 

  • The number of processed LDNs should be increased by one

Number of received LDN from a UNTRUSTED source

  • Access the Metric tab in the COAR Notify Dashboard

  • Drop a valid COAR LDN message from an UNTRUSTED source to the DSpace inbox

  • The number of received LDNs should be incresed by one

  • Wait up to 2 minutes and refresh the page 

  • The number of LDN messages from UNTRUSTED source should be increased by one

Number of failing LDN messages from a TRUSTED source

  • Access the Metric tab in the COAR Notify Dashboard

  • Drop a valid COAR LDN message from a TRUSTED source to the DSpace inbox related to a not existing DSpace item

  • The number of received LDNs should be incresed by one

  • Wait up to 2 minutes and refresh the page 

  • The number of failing LDN messages should be increased by one

Number of generated LDN

  • Access the Metric tab in the COAR Notify Dashboard

  • Submit an item and request a review from a registered LDN service (alternatively, submit an item in a collection for which the request review/endorsement/ingest to a set LDN service is handled automatically)

  • The number of generated LDN should be incresed by one (in the queued category)

  • Wait up to 2 minutes and refresh the page 

  • The number of generated LDN should be incresed by one (in the delivered category)

Logs of all the outgoing LDN messages

  • Access the Logs/Outbound tab in the COAR Notify Dashboard

  • The page should lists all outbound LDN messages, paginated, sorted by date descending, with the possibility to filter by Related item, LDN Service, Queue status, Activity stream type, COAR Notify type, and Last processing time

  • Submit an item and request a review from a registered LDN service (alternatively, submit an item in a collection for which the request review/endorsement/ingest to a set LDN service is handled automatically)

  • Filter by the LDN service, selecting the LDN service target of the request review

  • Check that the logs include the messages sent to the selected LDN service

  • Filter by Related item, selecting the title of the submitted item

  • Check that the logs include the messages related to the submitted item

Logs of all the incoming LDN messages

  • Access the Logs/Inbound tab in the COAR Notify Dashboard

  • The page should lists all inbound LDN messages, paginated, sorted by date descending, with the possibility to filter by Related item, LDN Service, Queue status, Activity stream type, COAR Notify type, and Last processing time

  • Submit an item and request a review from a registered LDN service (alternatively, submit an item in a collection for which the request review/endorsement/ingest to a set LDN service is handled automatically)

  • Emulate the Notify Service external system sending us an Announce Review LDN Message as described in COAR Notify Documentation#TestingAnnounceReviewagainstcurrentrepository

  • Wait up to 2 minutes and refresh the page

  • Filter by the LDN service, selecting the LDN service target of the request review

  • Check that the logs include the messages sent by the selected LDN service

  • Filter by Related item, selecting the title of the submitted item

  • Check that the logs include the messages related to the submitted item, including the simulated Announce Review message



  • No labels

All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license, unless otherwise noted.