Chronopolis:logformat: Difference between revisions
From Adapt
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
=Log Format= | |||
Chronopolis log files are lists of json events which follow the following spec. | |||
; provider (Required): String name of data provider | ; provider (Required): String name of data provider | ||
; collection (Required): String name of collection | ; collection (Required): String name of collection | ||
Line 11: | Line 15: | ||
=Log Types= | =Log Types= | ||
==COPY:1.0== | ==COPY:1.0== | ||
Version 1 of a copy event. This is should be used when either a transfer between chronopolis partners occur, or transfer from one media to another within a partner. | |||
;Attribtues | |||
;source (Required): source url of file to be copied | |||
;destination (Required): destination of file | |||
;transport (Required): name of tool or protocol used for transfer | |||
;retry (Required): number of retries before successful or failed copy | |||
;error (Optional): JSON list of errors | |||
=Example= | |||
<pre> | |||
{ | |||
"provider": "CDL", | |||
"collection": "state", | |||
"version": "1.0" | |||
"log-type": "COPY:1.0", | |||
"result": "SUCCESS", | |||
"item": "/data/county/aboutCollection.txt", | |||
"session": 57692, | |||
"timestamp": 1286286360, | |||
operation-details: | |||
{ | |||
"source": "srb://chron-umiacs/home/srbChron-umiacs.umiacs/cdl/county/data/county/aboutCollection.txt", | |||
"destination": "irods://chron-umiacs/home/srbChron-umiacs.umiacs/cdl/county/data/county/aboutCollection.txt", | |||
"retry-attempts": 3 | |||
} | |||
} | |||
</pre> |
Revision as of 20:45, 18 October 2010
Log Format
Chronopolis log files are lists of json events which follow the following spec.
- provider (Required)
- String name of data provider
- collection (Required)
- String name of collection
- version (Required)
- version number for required elements (1.0)
- log-type (Required)
- versioned description of log entry type (ie, COPY:1.0)
- result (Required)
- One of (SUCCESS,FAIL,INFORMATION)
- timestamp (Required)
- long, timestamp of log event
- item (Optional)
- String, relative path to item from collection root (Optional)
- session (Optional)
- long, session id if there are other log events w/in an action
- operation-details (Optional)
- json object dependent on log-type
Log Types
COPY:1.0
Version 1 of a copy event. This is should be used when either a transfer between chronopolis partners occur, or transfer from one media to another within a partner.
- Attribtues
- source (Required)
- source url of file to be copied
- destination (Required)
- destination of file
- transport (Required)
- name of tool or protocol used for transfer
- retry (Required)
- number of retries before successful or failed copy
- error (Optional)
- JSON list of errors
Example
{ "provider": "CDL", "collection": "state", "version": "1.0" "log-type": "COPY:1.0", "result": "SUCCESS", "item": "/data/county/aboutCollection.txt", "session": 57692, "timestamp": 1286286360, operation-details: { "source": "srb://chron-umiacs/home/srbChron-umiacs.umiacs/cdl/county/data/county/aboutCollection.txt", "destination": "irods://chron-umiacs/home/srbChron-umiacs.umiacs/cdl/county/data/county/aboutCollection.txt", "retry-attempts": 3 } }