Merge branch 'master' into 7748-datamanager-dry-run
[arvados.git] / doc / api / schema / Log.html.textile.liquid
1 ---
2 layout: default
3 navsection: api
4 navmenu: Schema
5 title: Log
6
7 ...
8
9 **Log** objects record events that occur in an Arvados cluster. Both user-written pipelines and the Arvados system itself may generate Log events.
10
11 h2. Methods
12
13 See "logs":{{site.baseurl}}/api/methods/logs.html
14
15 h2. Creation
16
17 Any user may create Log entries for any event they find useful. User-generated Logs have no intrinsic meaning to other users or to the Arvados system itself; it is up to each user to choose appropriate log event types and summaries for their project.
18
19 h3. System Logs
20
21 Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.
22
23 h2. Resource
24
25 Each Log has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
26
27 table(table table-bordered table-condensed).
28 |_. Attribute|_. Type|_. Description|_. Example|
29 |object_uuid|string|||
30 |event_at|datetime|||
31 |event_type|string|A user-defined category or type for this event.|@LOGIN@|
32 |summary|text|||
33 |properties|hash|||