1ecac16e29
In a couple of places the "patchSet" field was incorrectly spelled as "patchset" (with lower case s). Change-Id: I2b58a0fcfcc6ac5bea24fbdd162a1a2a6317afe5
174 lines
3.9 KiB
Plaintext
174 lines
3.9 KiB
Plaintext
gerrit stream-events
|
|
====================
|
|
|
|
NAME
|
|
----
|
|
gerrit stream-events - Monitor events occurring in real time
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'ssh' -p <port> <host> 'gerrit stream-events'
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
Provides a portal into the major events occurring on the server,
|
|
outputting 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
|
|
------
|
|
Caller must be a member of the privileged 'Administrators' group,
|
|
or have been granted
|
|
link:access-control.html#capability_streamEvents[the 'Stream Events' global capability].
|
|
|
|
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*,
|
|
*draft-published*, *change-abandoned*, *change-restored*,
|
|
*change-merged*, *merge-failed*, *comment-added*, *ref-updated* and
|
|
*reviewer-added*.
|
|
|
|
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]
|
|
|
|
Draft Published
|
|
^^^^^^^^^^^^^^^
|
|
type:: "draft-published"
|
|
|
|
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]
|
|
|
|
reason:: Reason for abandoning the change.
|
|
|
|
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]
|
|
|
|
reason:: Reason for restoring the change.
|
|
|
|
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]
|
|
|
|
Merge Failed
|
|
^^^^^^^^^^^^
|
|
type:: "merge-failed"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchSet:: link:json.html#patchSet[patchSet attribute]
|
|
|
|
submitter:: link:json.html#account[account attribute]
|
|
|
|
reason:: Reason that the merge failed.
|
|
|
|
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]
|
|
|
|
approvals:: All link:json.html#approval[approval attributes] granted.
|
|
|
|
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]
|
|
|
|
Reviewer Added
|
|
^^^^^^^^^^^^^^
|
|
type:: "reviewer-added"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
patchSet:: link:json.html#patchSet[patchSet attribute]
|
|
|
|
reviewer:: link:json.html#account[account attribute]
|
|
|
|
Topic Changed
|
|
^^^^^^^^^^^^^
|
|
type:: "topic-changed"
|
|
|
|
change:: link:json.html#change[change attribute]
|
|
|
|
changer:: link:json.html#account[account attribute]
|
|
|
|
oldTopic:: Topic name before it was changed.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
* link:json.html[JSON Data Formats]
|
|
* link:access-control.html[Access Controls]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|