# gerrit stream-events

version v2.11.9-3-g00dab00

## NAME

gerrit stream-events - Monitor events occurring in real time

## 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.

## 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.

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

  change attribute

patchSet

  patchSet attribute

abandoner

  account attribute

reason

  Reason for abandoning the change.

eventCreatedOn

  Time in seconds since the UNIX epoch when this event was created.

### Change Merged

Sent when a change has been merged into the git repository.

type

  "change-merged"

change

  change attribute

patchSet

  patchSet attribute

submitter

  account attribute

newRev

  The resulting revision of the merge.

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

  change attribute

patchSet

  patchSet attribute

restorer

  account attribute

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

  change attribute

patchSet

  patchSet attribute

author

  account attribute

approvals

  All approval attributes granted.

comment

  Review comment cover message.

eventCreatedOn

  Time in seconds since the UNIX epoch when this event was created.

### Draft Published

Sent when a draft change has been published.

type

  "draft-published"

change

  change attribute

patchSet

  patchSet attribute

uploader

  account attribute

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

  change attribute

editor

  account attribute

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.

### Merge Failed

Sent when a change has failed to be merged into the git repository.

type

  "merge-failed"

change

  change attribute

patchSet

  patchSet attribute

submitter

  account attribute

reason

  Reason that the merge failed.

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.

Note that this event is also sent for changes or patch sets uploaded as draft, but is only visible to the change owner, any existing reviewers, and users who belong to a group that is granted the View Drafts capability.

type

  "patchset-created"

change

  change attribute

patchSet

  patchSet attribute

uploader

  account attribute

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

  account attribute

refUpdate

  refUpdate attribute

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

  change attribute

patchSet

  patchSet attribute

reviewer

  account attribute

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

  change attribute

changer

  account attribute

oldTopic

  Topic name before it was changed.

eventCreatedOn

  Time in seconds since the UNIX epoch when this event was created.

## SEE ALSO

- JSON Data Formats

- Access Controls

Part of Gerrit Code Review