# gerrit stream-events

version v2.10.2-17-g190d5ac

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

  change attribute

patchSet

  patchSet attribute

uploader

  account attribute

#### Draft Published

type

  "draft-published"

change

  change attribute

patchSet

  patchSet attribute

uploader

  account attribute

#### Change Abandoned

type

  "change-abandoned"

change

  change attribute

patchSet

  patchSet attribute

abandoner

  account attribute

reason

  Reason for abandoning the change.

#### Change Restored

type

  "change-restored"

change

  change attribute

patchSet

  patchSet attribute

restorer

  account attribute

reason

  Reason for restoring the change.

#### Change Merged

type

  "change-merged"

change

  change attribute

patchSet

  patchSet attribute

submitter

  account attribute

#### Merge Failed

type

  "merge-failed"

change

  change attribute

patchSet

  patchSet attribute

submitter

  account attribute

reason

  Reason that the merge failed.

#### Comment Added

type

  "comment-added"

change

  change attribute

patchSet

  patchSet attribute

author

  account attribute

approvals

  All approval attributes granted.

comment

  Comment text author had written

#### Ref Updated

type

  "ref-updated"

submitter

  account attribute

refUpdate

  refUpdate attribute

#### Reviewer Added

type

  "reviewer-added"

change

  change attribute

patchSet

  patchSet attribute

reviewer

  account attribute

#### Topic Changed

type

  "topic-changed"

change

  change attribute

changer

  account attribute

oldTopic

  Topic name before it was changed.

## SEE ALSO

- JSON Data Formats

- Access Controls

Part of Gerrit Code Review