9741bab652
Change-Id: I40bf406a5c54b9caf2b45b127b282f9fe4b84aa1 Signed-off-by: Maciej Żenczykowski <maze@google.com>
123 lines
2.7 KiB
Plaintext
123 lines
2.7 KiB
Plaintext
gerrit stream-events
|
|
====================
|
|
|
|
NAME
|
|
----
|
|
gerrit stream-events - Monitor events occuring in real time
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'ssh' -p <port> <host> 'gerrit stream-events'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Provides a portal into the major events occuring on the server,
|
|
outputing activity data in real-time to the client. Events are
|
|
filtered by the caller's access permissions, ensuring the caller
|
|
only receives events for changes they can view on the web, or in
|
|
the project repository.
|
|
|
|
Event output is in JSON, one event per line.
|
|
|
|
ACCESS
|
|
------
|
|
Any user who has configured an SSH key.
|
|
|
|
SCRIPTING
|
|
---------
|
|
This command is intended to be used in scripts.
|
|
|
|
EXAMPLES
|
|
--------
|
|
|
|
-----
|
|
$ ssh -p 29418 review.example.com gerrit stream-events
|
|
{"type":"comment-added",change:{"project":"tools/gerrit", ...}, ...}
|
|
{"type":"comment-added",change:{"project":"tools/gerrit", ...}, ...}
|
|
-----
|
|
|
|
SCHEMA
|
|
------
|
|
The JSON messages consist of nested objects referencing the *change*,
|
|
*patchset*, *account* involved, and other attributes as appropriate.
|
|
The currently supported message types are *patchset-created*,
|
|
*comment-added*, *change-merged*, and *change-abandoned*.
|
|
|
|
Note that any field may be missing in the JSON messages, so consumers of
|
|
this JSON stream should deal with that appropriately.
|
|
|
|
Events
|
|
~~~~~~
|
|
Patchset Created
|
|
^^^^^^^^^^^^^^^^
|
|
type:: "patchset-created"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchset:: link:json.html#patchset[patchset attribute]
|
|
|
|
uploader:: link:json.html#account[account attribute]
|
|
|
|
Change Abandoned
|
|
^^^^^^^^^^^^^^^^
|
|
type:: "change-abandoned"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchset:: link:json.html#patchset[patchset attribute]
|
|
|
|
abandoner:: link:json.html#account[account attribute]
|
|
|
|
Change Restored
|
|
^^^^^^^^^^^^^^^^
|
|
type:: "change-restored"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchset:: link:json.html#patchset[patchset attribute]
|
|
|
|
restorer:: link:json.html#account[account attribute]
|
|
|
|
Change Merged
|
|
^^^^^^^^^^^^^
|
|
type:: "change-merged"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchset:: link:json.html#patchset[patchset attribute]
|
|
|
|
submitter:: link:json.html#account[account attribute]
|
|
|
|
Comment Added
|
|
^^^^^^^^^^^^^
|
|
type:: "comment-added"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchset:: link:json.html#patchset[patchset attribute]
|
|
|
|
author:: link:json.html#account[account attribute]
|
|
|
|
comment:: Comment text author had written
|
|
|
|
Ref Updated
|
|
^^^^^^^^^^^
|
|
type:: "ref-updated"
|
|
|
|
submitter:: link:json.html#account[account attribute]
|
|
|
|
refUpdate:: link:json.html#refupdate[refupdate attribute]
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
* link:json.html[JSON Data Formats]
|
|
* link:access-control.html[Access Controls]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|