# gerrit stream-events

version 2.4.2-12-g4cb2b75

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

  change attribute

patchset

  patchset attribute

uploader

  account attribute

#### Change Abandoned

type

  "change-abandoned"

change

  change attribute

patchset

  patchset attribute

abandoner

  account attribute

#### Change Restored

type

  "change-restored"

change

  change attribute

patchset

  patchset attribute

restorer

  account attribute

#### Change Merged

type

  "change-merged"

change

  change attribute

patchset

  patchset attribute

submitter

  account attribute

#### Comment Added

type

  "comment-added"

change

  change attribute

patchset

  patchset attribute

author

  account attribute

comment

  Comment text author had written

#### Ref Updated

type

  "ref-updated"

submitter

  account attribute

refUpdate

  refupdate attribute

## SEE ALSO

- JSON Data Formats

- Access Controls

Part of Gerrit Code Review