SYNOPSIS
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 the 'Stream Events' global capability.
SCRIPTING
This command is intended to be used in scripts.
OPTIONS
- --subscribe|-s
-
Type of the event to subscribe to. Multiple --subscribe options may be specified to subscribe to multiple events. When this option is provided, only subscribed events are emitted and all other events are ignored. When this option is omitted, all events are emitted.
EXAMPLES
$ ssh -p 29418 review.example.com gerrit stream-events
{"type":"comment-added",change:{"project":"tools/gerrit", ...}, ...}
{"type":"comment-added",change:{"project":"tools/gerrit", ...}, ...}
Only subscribe to specific event types:
$ ssh -p 29418 review.example.com gerrit stream-events \ -s patchset-created -s ref-replicated
SCHEMA
The JSON messages consist of nested objects referencing the change, patchSet, account involved, and other attributes as appropriate.
Note that any field may be missing in the JSON messages, so consumers of this JSON stream should deal with that appropriately.
EVENTS
Change Abandoned
Sent when a change has been abandoned.
- type
-
"change-abandoned"
- change
- patchSet
- abandoner
- reason
-
Reason for abandoning the change.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Change Deleted
Sent when a change has been deleted.
- type
-
"change-deleted"
- change
- deleter
Change Merged
Sent when a change has been merged into the git repository.
- type
-
"change-merged"
- change
- patchSet
- submitter
- newRev
-
The state (revision) of the target branch after the operation that closed the change was completed.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Change Restored
Sent when an abandoned change has been restored.
- type
-
"change-restored"
- change
- patchSet
- restorer
- reason
-
Reason for restoring the change.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Comment Added
Sent when a review comment has been posted on a change.
- type
-
"comment-added"
- change
- patchSet
- author
- approvals
-
All approval attributes granted.
- comment
-
Review comment cover message.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Dropped Output
Sent to notify a client that events have been dropped.
- type
-
"dropped-output"
Hashtags Changed
Sent when the hashtags have been added to or removed from a change.
- type
-
"hashtags-changed"
- change
- editor
- added
-
List of hashtags added to the change
- removed
-
List of hashtags removed from the change
- hashtags
-
List of hashtags on the change after tags were added or removed
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Project Created
Sent when a new project has been created.
- type
-
"project-created"
- projectName
-
The created project name
- projectHead
-
The created project head name
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Patchset Created
Sent when a new change has been uploaded, or a new patch set has been uploaded to an existing change.
- type
-
"patchset-created"
- change
- patchSet
- uploader
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Ref Updated
Sent when a reference is updated in a git repository.
- type
-
"ref-updated"
- submitter
- refUpdate
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Reviewer Added
Sent when a reviewer is added to a change.
- type
-
"reviewer-added"
- change
- patchSet
- reviewer
- adder
-
user that added the reviewer as account attribute
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Reviewer Deleted
Sent when a reviewer (with a vote) is removed from a change.
- type
-
"reviewer-deleted"
- change
- patchSet
- reviewer
-
reviewer that was removed as account attribute
- remover
-
user that removed the reviewer as account attribute
- approvals
-
All approval attributes removed.
- comment
-
Review comment cover message.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Topic Changed
Sent when the topic of a change has been changed.
- type
-
"topic-changed"
- change
- changer
- oldTopic
-
Topic name before it was changed.
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Work In Progress State Changed
Sent when the WIP state of the change has changed.
- type
-
wip-state-changed
- change
- patchSet
- changer
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Private State Changed
Sent when the private state of the change has changed.
- type
-
private-state-changed
- change
- patchSet
- changer
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.
Vote Deleted
Sent when a vote was removed from a change.
- type
-
"vote-deleted"
- change
- patchSet
- reviewer
-
user whose vote was removed as account attribute
- remover
-
user who removed the vote as account attribute
- approvals
-
all votes as approval attributes
- comment
-
Review comment cover message.
Project Head Updated
Sent when project’s head is updated.
- type
-
"project-head-updated"
- oldHead
-
The old project head name
- newHead
-
The new project head name
- eventCreatedOn
-
Time in seconds since the UNIX epoch when this event was created.