# get-sentry-event-data

> CLI to retrieve event data from Sentry

Latest version **3.0.2** (published 2019-06-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-sentry-event-data
pnpm add get-sentry-event-data
yarn add get-sentry-event-data
bun add get-sentry-event-data
```

Provides the command `get-sentry-event-data`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2019-06-19 |
| First published | 2016-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 6 |
| Unpacked size | 50.9 KB |
| Known vulnerabilities | 0 (+9 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | busbud-dev |
| Keywords | sentry |

## Links

- npm: https://www.npmjs.com/package/get-sentry-event-data
- Repository: https://github.com/busbud/get-sentry-event-data
- Homepage: https://github.com/busbud/get-sentry-event-data#readme
- Issues: https://github.com/busbud/get-sentry-event-data/issues
- npm.io page: https://npm.io/package/get-sentry-event-data

## Dependencies (6)

- [urijs](https://npm.io/package/urijs.md) 1.16.1
- [request](https://npm.io/package/request.md) 2.88.0
- [bluebird](https://npm.io/package/bluebird.md) 3.5.4
- [commander](https://npm.io/package/commander.md) 2.20.0
- [tsc-watch](https://npm.io/package/tsc-watch.md) 2.1.2
- [request-promise](https://npm.io/package/request-promise.md) 3.0.0

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 3.0.2 (latest) — 2019-06-19
- 3.0.1 — 2019-04-19
- 3.0.0 — 2019-04-19
- 2.2.1 — 2018-03-07
- 2.2.0 — 2017-03-02
- 2.1.0 — 2017-01-13
- 2.0.0 — 2016-10-24
- 1.0.0 — 2016-06-06

## README

# get-sentry-event-data

CLI tool for retrieving event data from Sentry.

## Usage

`get-sentry-event-data` iterates over a Sentry issue's events and emits each event's `context` as JSON so you can use your tool chain (like [`jq`](https://stedolan.github.io/jq/)) to create custom reports to accelerate your investigation of issues.

```sh
# install
npm install --global get-sentry-event-data

# run it
get-sentry-event-data 108098418 \
 | jq -s -r '.[] | map([.origin_xid,.destination_xid] | @tsv) | .[]' \
 | sort | uniq -c \
 | sort -r
```

Also included are the `tags`, but converted into map instead of the original `[{key: "key1", value: "value1"]` format, preferring `{key1: "value1"}`.

`dateCreated` and `dateReceived` are present to provide timing information.

In summary, the following data is emitted by the tool

```js
[
  {
    context: {}, // original Sentry format
    tags: {
      // reformatted Sentry tag list
      key1: 'value1',
      key2: 'value2'
    },
    dateCreated: 'YYYY-MM-DDTHH:mm:ssZ',
    dateReceived: 'YYYY-MM-DDTHH:mm:ssZ'
  },
  {
    context: {},
    tags: {
      key1: 'value1',
      key2: 'value2'
    },
    dateCreated: 'YYYY-MM-DDTHH:mm:ssZ',
    dateReceived: 'YYYY-MM-DDTHH:mm:ssZ'
  }
];
```

## Setup

You'll need a Sentry token to retrieve data from the Sentry API. To create one, follow these steps:

- Visit https://app.getsentry.com/api/new-token/
- Select at least the `event:read` permission
- Create an environment variable `SENTRY_API_TOKEN` setting it to the newly created token

You're now ready to use `get-sentry-event-data`!

## Options

- `-p, --pages [pages]`: number of pages to fetch. defaults to 1

- `-o, --organisation [organisation]`: organisation. required for extended events

- `-n, --project-name [project-name]`: project name. required for extended events

- `-x, --extended-event`: enable extended event

---
_Source: https://npm.io/package/get-sentry-event-data · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._