doc/api/schema/Log.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: Log
   6
   7 ...
   8
   9 h1. Log
  10
  11 **Log** objects record events that occur in an Arvados cluster. Both user-written pipelines and the Arvados system itself may generate Log events.
  12
  13 h2. Methods
  14
  15 See "REST methods for working with Arvados resources":/api/methods.html
  16
  17 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/log@
  18
  19 h2. Creation
  20
  21 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.
  22
  23 h3. System Logs
  24
  25 At the time of this writing, the Arvados system uses Logs only to record interactive user shell logins (event type @LOGIN@).
  26
  27 h2. Resources
  28
  29 Each Log has, in addition to the usual "attributes of Arvados resources":/api/resources.html:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Attribute|_. Type|_. Description|_. Example|
  33 |object_kind|string|||
  34 |object_uuid|string|||
  35 |event_at|datetime|||
  36 |event_type|string|A user-defined category or type for this event.|@LOGIN@|
  37 |summary|text|||
  38 |info|Hash|||
  39 |updated_at|datetime|||