€cdocutils.nodes
document
q)q}q(U nametypesq}qX
���event loggingqNsUsubstitution_defsq}qUparse_messagesq ]q
Ucurrent_sourceq NU
decorationq NUautofootnote_startq
KUnameidsq}qhU
event-loggingqsUchildrenq]qcdocutils.nodes
section
q)q}q(U rawsourceqU�UparentqhUsourceqXg���/var/lib/jenkins/jobs/Metacat_stable/workspace/METACAT_2_7_2/docs/user/metacat/source/event-logging.rstqUtagnameqUsectionqU
attributesq }q (Udupnamesq ]Uclassesq ]Ubackrefsq ]Uidsq!]q"haUnamesq#]q$hauUlineq%KUdocumentq&hh]q'(cdocutils.nodes
title
q()q)}q*(hX
���Event Loggingq+hhhhhUtitleq,h }q-(h ]h ]h ]h!]h#]uh%Kh&hh]q.cdocutils.nodes
Text
q/X
���Event Loggingq0…q1}q2(hh+hh)ubaubcdocutils.nodes
paragraph
q3)q4}q5(hX…��Metacat keeps an internal log of events (such as insertions, updates, deletes,
and reads) that can be accessed with the getlog action. Using the getlog action,
event reports can be output from Metacat in XML format, and/or customized to
include only certain events: events from a particular IP address, user, event
type, or that occurred after a specified start date or before an end date.q6hhhhhU paragraphq7h }q8(h ]h ]h ]h!]h#]uh%Kh&hh]q9h/X…��Metacat keeps an internal log of events (such as insertions, updates, deletes,
and reads) that can be accessed with the getlog action. Using the getlog action,
event reports can be output from Metacat in XML format, and/or customized to
include only certain events: events from a particular IP address, user, event
type, or that occurred after a specified start date or before an end date.q:…q;}q<(hh6hh4ubaubh3)q=}q>(hXs���The following URL is used to return the basic log- an XML-formatted log of all
events since the log was initiated::hhhhhh7h }q?(h ]h ]h ]h!]h#]uh%K
h&hh]q@h/Xr���The following URL is used to return the basic log- an XML-formatted log of all
events since the log was initiated:qA…qB}qC(hXr���The following URL is used to return the basic log- an XML-formatted log of all
events since the log was initiated:hh=ubaubcdocutils.nodes
literal_block
qD)qE}qF(hX6���http://some.metacat.host/context/metacat?action=getloghhhhhU
literal_blockqGh }qH(U xml:spaceqIUpreserveqJh!]h ]h ]h ]h#]uh%K
h&hh]qKh/X6���http://some.metacat.host/context/metacat?action=getlogqL…qM}qN(hU�hhEubaubh3)qO}qP(hX»���Note that you must be logged in to Metacat using the HTTP interface or you
will get an error message. For more information about logging in, please see
Logging In with the HTTP Interface.qQhhhhhh7h }qR(h ]h ]h ]h!]h#]uh%Kh&hh]qSh/X»���Note that you must be logged in to Metacat using the HTTP interface or you
will get an error message. For more information about logging in, please see
Logging In with the HTTP Interface.qT…qU}qV(hhQhhOubaubhD)qW}qX(hX��<!-- Example of XML Log -->
<?xml version="1.0"?>
<log>
<logEntry><entryid>44</entryid><ipAddress>34.237.20.142</ipAddress><principal>uid=jones,
o=NCEAS,dc=ecoinformatics,dc=org</principal><docid>esa.2.1</docid><event>insert</event>
<dateLogged>2004-09-08 19:08:18.16</dateLogged></logEntry>
<logEntry><entryid>47</entryid><ipAddress>34.237.20.142</ipAddress><principal>uid=jones,o=NCEAS,
dc=ecoinformatics,dc=org</principal><docid>esa.3.1</docid><event>insert</event><dateLogged>2004-
09-14 19:50:40.61</dateLogged></logEntry>
</log>hhhhhhGh }qY(hIhJh!]h ]h ]h ]h#]uh%Kh&hh]qZh/X��<!-- Example of XML Log -->
<?xml version="1.0"?>
<log>
<logEntry><entryid>44</entryid><ipAddress>34.237.20.142</ipAddress><principal>uid=jones,
o=NCEAS,dc=ecoinformatics,dc=org</principal><docid>esa.2.1</docid><event>insert</event>
<dateLogged>2004-09-08 19:08:18.16</dateLogged></logEntry>
<logEntry><entryid>47</entryid><ipAddress>34.237.20.142</ipAddress><principal>uid=jones,o=NCEAS,
dc=ecoinformatics,dc=org</principal><docid>esa.3.1</docid><event>insert</event><dateLogged>2004-
09-14 19:50:40.61</dateLogged></logEntry>
</log>q[…q\}q](hU�hhWubaubh3)q^}q_(hX«���The basic log can be quite extensive. To subset the report, restrict the
matching events using parameters. Query parameters can be combined to further
restrict the report.q`hhhhhh7h }qa(h ]h ]h ]h!]h#]uh%K h&hh]qbh/X«���The basic log can be quite extensive. To subset the report, restrict the
matching events using parameters. Query parameters can be combined to further
restrict the report.qc…qd}qe(hh`hh^ubaubcdocutils.nodes
table
qf)qg}qh(hU�hhhhhUtableqih }qj(h ]h ]h ]h!]h#]uh%Nh&hh]qkcdocutils.nodes
tgroup
ql)qm}qn(hU�h }qo(h!]h ]h ]h ]h#]UcolsKuhhgh]qp(cdocutils.nodes
colspec
qq)qr}qs(hU�h }qt(h!]h ]h ]h ]h#]UcolwidthK uhhmh]hUcolspecquubhq)qv}qw(hU�h }qx(h!]h ]h ]h ]h#]UcolwidthK5uhhmh]hhuubcdocutils.nodes
thead
qy)qz}q{(hU�h }q|(h ]h ]h ]h!]h#]uhhmh]q}cdocutils.nodes
row
q~)q}q€(hU�h }q(h ]h ]h ]h!]h#]uhhzh]q‚(cdocutils.nodes
entry
qƒ)q„}q…(hU�h }q†(h ]h ]h ]h!]h#]uhhh]q‡h3)qˆ}q‰(hX ���ParameterqŠhh„hhhh7h }q‹(h ]h ]h ]h!]h#]uh%K%h]qŒh/X ���Parameterq…qŽ}q(hhŠhhˆubaubahUentryqubhƒ)q‘}q’(hU�h }q“(h ]h ]h ]h!]h#]uhhh]q”h3)q•}q–(hX���Description and Valuesq—hh‘hhhh7h }q˜(h ]h ]h ]h!]h#]uh%K%h]q™h/X���Description and Valuesqš…q›}qœ(hh—hh•ubaubahhubehUrowqubahUtheadqžubcdocutils.nodes
tbody
qŸ)q }q¡(hU�h }q¢(h ]h ]h ]h!]h#]uhhmh]q£(h~)q¤}q¥(hU�h }q¦(h ]h ]h ]h!]h#]uhh h]q§(hƒ)q¨}q©(hU�h }qª(h ]h ]h ]h!]h#]uhh¤h]q«h3)q¬}q(hX ���ipAddressq®hh¨hhhh7h }q¯(h ]h ]h ]h!]h#]uh%K'h]q°h/X ���ipAddressq±…q²}q³(hh®hh¬ubaubahhubhƒ)q´}qµ(hU�h }q¶(h ]h ]h ]h!]h#]uhh¤h]q·h3)q¸}q¹(hX3���Restrict the report to this IP Address (repeatable)qºhh´hhhh7h }q»(h ]h ]h ]h!]h#]uh%K'h]q¼h/X3���Restrict the report to this IP Address (repeatable)q½…q¾}q¿(hhºhh¸ubaubahhubehhubh~)qÀ}qÁ(hU�h }qÂ(h ]h ]h ]h!]h#]uhh h]qÃ(hƒ)qÄ}qÅ(hU�h }qÆ(h ]h ]h ]h!]h#]uhhÀh]qÇh3)qÈ}qÉ(hX ���principalqÊhhÄhhhh7h }qË(h ]h ]h ]h!]h#]uh%K)h]qÌh/X ���principalqÍ…qÎ}qÏ(hhÊhhÈubaubahhubhƒ)qÐ}qÑ(hU�h }qÒ(h ]h ]h ]h!]h#]uhhÀh]qÓh3)qÔ}qÕ(hX-���Restrict the report to this user (repeatable)qÖhhÐhhhh7h }q×(h ]h ]h ]h!]h#]uh%K)h]qØh/X-���Restrict the report to this user (repeatable)qÙ…qÚ}qÛ(hhÖhhÔubaubahhubehhubh~)qÜ}qÝ(hU�h }qÞ(h ]h ]h ]h!]h#]uhh h]qß(hƒ)qà}qá(hU�h }qâ(h ]h ]h ]h!]h#]uhhÜh]qãh3)qä}qå(hX���docidqæhhàhhhh7h }qç(h ]h ]h ]h!]h#]uh%K+h]qèh/X���docidqé…qê}që(hhæhhäubaubahhubhƒ)qì}qí(hU�h }qî(h ]h ]h ]h!]h#]uhhÜh]qïh3)qð}qñ(hX.���Restrict the report to this docid (repeatable)qòhhìhhhh7h }qó(h ]h ]h ]h!]h#]uh%K+h]qôh/X.���Restrict the report to this docid (repeatable)qõ…qö}q÷(hhòhhðubaubahhubehhubh~)qø}qù(hU�h }qú(h ]h ]h ]h!]h#]uhh h]qû(hƒ)qü}qý(hU�h }qþ(h ]h ]h ]h!]h#]uhhøh]qÿh3)r���}r��(hX���eventr��hhühhhh7h }r��(h ]h ]h ]h!]h#]uh%K-h]r��h/X���eventr��…r��}r��(hj��hj���ubaubahhubhƒ)r��}r ��(hU�h }r
��(h ]h ]h ]h!]h#]uhhøh]r ��h3)r ��}r
��(hXX���Restrict the report to this event type (repeatable)
Values: insert, update, delete, readr��hj��hhhh7h }r��(h ]h ]h ]h!]h#]uh%K-h]r��h/XX���Restrict the report to this event type (repeatable)
Values: insert, update, delete, readr��…r��}r��(hj��hj ��ubaubahhubehhubh~)r��}r��(hU�h }r��(h ]h ]h ]h!]h#]uhh h]r��(hƒ)r��}r��(hU�h }r��(h ]h ]h ]h!]h#]uhj��h]r��h3)r ��}r ��(hX���startr ��hj��hhhh7h }r ��(h ]h ]h ]h!]h#]uh%K0h]r ��h/X���startr!��…r"��}r#��(hj ��hj ��ubaubahhubhƒ)r$��}r%��(hU�h }r&��(h ]h ]h ]h!]h#]uhj��h]r'��h3)r(��}r)��(hXH���Restrict the report to events after this date
Value: YYYY-MM-DD+hh:mm:ssr*��hj$��hhhh7h }r+��(h ]h ]h ]h!]h#]uh%K0h]r,��h/XH���Restrict the report to events after this date
Value: YYYY-MM-DD+hh:mm:ssr-��…r.��}r/��(hj*��hj(��ubaubahhubehhubh~)r0��}r1��(hU�h }r2��(h ]h ]h ]h!]h#]uhh h]r3��(hƒ)r4��}r5��(hU�h }r6��(h ]h ]h ]h!]h#]uhj0��h]r7��h3)r8��}r9��(hX���endr:��hj4��hhhh7h }r;��(h ]h ]h ]h!]h#]uh%K3h]r<��h/X���endr=��…r>��}r?��(hj:��hj8��ubaubahhubhƒ)r@��}rA��(hU�h }rB��(h ]h ]h ]h!]h#]uhj0��h]rC��h3)rD��}rE��(hXJ���Restrict the report to events before this date.
Value: YYYY-MM-DD+hh:mm:ssrF��hj@��hhhh7h }rG��(h ]h ]h ]h!]h#]uh%K3h]rH��h/XJ���Restrict the report to events before this date.
Value: YYYY-MM-DD+hh:mm:ssrI��…rJ��}rK��(hjF��hjD��ubaubahhubehhubehUtbodyrL��ubehUtgrouprM��ubaubh3)rN��}rO��(hX0���To view only the 'read' events, use a URL like::rP��hhhhhh7h }rQ��(h ]h ]h ]h!]h#]uh%K7h&hh]rR��h/X/���To view only the 'read' events, use a URL like:rS��…rT��}rU��(hX/���To view only the 'read' events, use a URL like:hjN��ubaubhD)rV��}rW��(hXA���http://some.metacat.host/context/metacat?action=getlog&event=readhhhhhhGh }rX��(hIhJh!]h ]h ]h ]h#]uh%K9h&hh]rY��h/XA���http://some.metacat.host/context/metacat?action=getlog&event=readrZ��…r[��}r\��(hU�hjV��ubaubh3)r]��}r^��(hXE���To view only the events for a particular IP address, use a URL like::r_��hhhhhh7h }r`��(h ]h ]h ]h!]h#]uh%K<h&hh]ra��h/XD���To view only the events for a particular IP address, use a URL like:rb��…rc��}rd��(hXD���To view only the events for a particular IP address, use a URL like:hj]��ubaubhD)re��}rf��(hXK���http://some.metacat.host/context/metacat?action=getlog&ipaddress=107.9.1.31hhhhhhGh }rg��(hIhJh!]h ]h ]h ]h#]uh%K>h&hh]rh��h/XK���http://some.metacat.host/context/metacat?action=getlog&ipaddress=107.9.1.31ri��…rj��}rk��(hU�hje��ubaubh3)rl��}rm��(hX:���To view only the events for a given user, use a URL like::rn��hhhhhh7h }ro��(h ]h ]h ]h!]h#]uh%KAh&hh]rp��h/X9���To view only the events for a given user, use a URL like:rq��…rr��}rs��(hX9���To view only the events for a given user, use a URL like:hjl��ubaubhD)rt��}ru��(hXm���http://some.metacat.host/context/metacat?action=getlog&principal=uid=johndoe,o=NCEAS,dc=ecoinformatics,dc=orghhhhhhGh }rv��(hIhJh!]h ]h ]h ]h#]uh%KCh&hh]rw��h/Xm���http://some.metacat.host/context/metacat?action=getlog&principal=uid=johndoe,o=NCEAS,dc=ecoinformatics,dc=orgrx��…ry��}rz��(hU�hjt��ubaubh3)r{��}r|��(hXC���To view only the events for a particular document, use a URL like::r}��hhhhhh7h }r~��(h ]h ]h ]h!]h#]uh%KFh&hh]r��h/XB���To view only the events for a particular document, use a URL like:r€��…r��}r‚��(hXB���To view only the events for a particular document, use a URL like:hj{��ubaubhD)rƒ��}r„��(hXD���http://some.metacat.host/context/metacat?action=getlog&docid=knb.5.1hhhhhhGh }r…��(hIhJh!]h ]h ]h ]h#]uh%KHh&hh]r†��h/XD���http://some.metacat.host/context/metacat?action=getlog&docid=knb.5.1r‡��…rˆ��}r‰��(hU�hjƒ��ubaubh3)rŠ��}r‹��(hX<���To view only the events after a given date, use a URL like::rŒ��hhhhhh7h }r��(h ]h ]h ]h!]h#]uh%KKh&hh]rŽ��h/X;���To view only the events after a given date, use a URL like:r��…r��}r‘��(hX;���To view only the events after a given date, use a URL like:hjŠ��ubaubhD)r’��}r“��(hXP���http://some.metacat.host/context/metacat?action=getlog&start=2004-09-15+12:00:00hhhhhhGh }r”��(hIhJh!]h ]h ]h ]h#]uh%KMh&hh]r•��h/XP���http://some.metacat.host/context/metacat?action=getlog&start=2004-09-15+12:00:00r–��…r—��}r˜��(hU�hj’��ubaubh3)r™��}rš��(hX=���To view only the events before a given date, use a URL like::r›��hhhhhh7h }rœ��(h ]h ]h ]h!]h#]uh%KPh&hh]r��h/X<���To view only the events before a given date, use a URL like:rž��…rŸ��}r ��(hX<���To view only the events before a given date, use a URL like:hj™��ubaubhD)r¡��}r¢��(hXN���http://some.metacat.host/context/metacat?action=getlog&end=2004-09-15+12:00:00hhhhhhGh }r£��(hIhJh!]h ]h ]h ]h#]uh%KRh&hh]r¤��h/XN���http://some.metacat.host/context/metacat?action=getlog&end=2004-09-15+12:00:00r¥��…r¦��}r§��(hU�hj¡��ubaubh3)r¨��}r©��(hX]���To view the 'insert' events for September 2004 (i.e., to combine parameters) use a URL like::rª��hhhhhh7h }r«��(h ]h ]h ]h!]h#]uh%KUh&hh]r¬��h/X\���To view the 'insert' events for September 2004 (i.e., to combine parameters) use a URL like:r��…r®��}r¯��(hX\���To view the 'insert' events for September 2004 (i.e., to combine parameters) use a URL like:hj¨��ubaubhD)r°��}r±��(hXu���http://some.metacat.host/context/metacat?action=getlog&event=insert&start=2004-09-01+12:00:00&end=2004-09-30+23:59:59hhhhhhGh }r²��(hIhJh!]h ]h ]h ]h#]uh%KWh&hh]r³��h/Xu���http://some.metacat.host/context/metacat?action=getlog&event=insert&start=2004-09-01+12:00:00&end=2004-09-30+23:59:59r´��…rµ��}r¶��(hU�hj°��ubaubeubahU�U transformerr·��NU
footnote_refsr¸��}r¹��Urefnamesrº��}r»��Usymbol_footnotesr¼��]r½��Uautofootnote_refsr¾��]r¿��Usymbol_footnote_refsrÀ��]rÁ��U citationsrÂ��]rÃ��h&hU current_linerÄ��NUtransform_messagesrÅ��]rÆ��UreporterrÇ��NUid_startrÈ��KU
autofootnotesr��]r��U
citation_refsr��}r��Uindirect_targetsr��]r��Usettingsr��(cdocutils.frontend
Values
rÐ��orÑ��}rÒ��(Ufootnote_backlinksrÓ��KUrecord_dependenciesrÔ��NU rfc_base_urlrÕ��U https://tools.ietf.org/html/rÖ��U tracebackr×��ˆUpep_referencesrØ��NUstrip_commentsrÙ��NU
toc_backlinksr��hU
language_coder��Uenr��U datestampr��NU report_levelr��KU _destinationr��NU
halt_levelr�KU
strip_classesrá��Nh,NU error_encoding_error_handlerrâ��Ubackslashreplacerã��Udebugrä��NUembed_stylesheetrå��‰U output_encoding_error_handlerræ��Ustrictrç��U
sectnum_xformr�KUdump_transformsr�NU
docinfo_xformrê��KUwarning_streamrë��NUpep_file_url_templaterì��Upep-%04drí��Uexit_status_levelrî��KUconfigrï��NUstrict_visitorrð��NUcloak_email_addressesrñ��ˆU trim_footnote_reference_spacerò��‰Uenvró��NUdump_pseudo_xmlrô��NUexpose_internalsrõ��NUsectsubtitle_xformrö��‰U source_linkr÷��NUrfc_referencesrø��NUoutput_encodingrù��Uutf-8rú��U
source_urlrû��NUinput_encodingrü��U utf-8-sigrý��U_disable_configrþ��NU id_prefixrÿ��U�U tab_widthr���KUerror_encodingr��UUTF-8r��U_sourcer��hUgettext_compactr��ˆU generatorr��NUdump_internalsr��NU smart_quotesr��‰U pep_base_urlr��U https://www.python.org/dev/peps/r ��Usyntax_highlightr
��Ulongr ��U input_encoding_error_handlerr ��j�Uauto_id_prefixr
��Uidr��Udoctitle_xformr��‰Ustrip_elements_with_classesr��NU
_config_filesr��]Ufile_insertion_enabledr��ˆU raw_enabledr��KU
dump_settingsr��NubUsymbol_footnote_startr��K�Uidsr��}r��hhsUsubstitution_namesr��}r��hh&h }r��(h ]h!]h ]Usourcehh ]h#]uU footnotesr��]r ��Urefidsr ��}r ��ub.