Skip to content

Commit

Permalink
docs: документация по новым env переменным Sentry
Browse files Browse the repository at this point in the history
  • Loading branch information
mxseev committed Jul 12, 2022
1 parent a751818 commit fdae6e1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
4 changes: 4 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
SENTRY_URL=
SENTRY_ORG=
SENTRY_PROJECT=
SENTRY_AUTH_TOKEN=
NEXT_PUBLIC_SENTRY_ENV=
NEXT_PUBLIC_SENTRY_DSN=
NEXT_PUBLIC_LOGDNA_APP=
Expand Down
6 changes: 5 additions & 1 deletion docs/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Для работы приложения необходимо заполнить следующие env переменные (через командную строку или `.env` файл):

- `SENTRY_URL`: URL до инстанса Sentry (обычно `https://sentry.io`)
- `SENTRY_ORG`: название организации в Sentry
- `SENTRY_PROJECT`: название проекта в Sentry
- `SENTRY_AUTH_TOKEN`: токен от Sentry
- `NEXT_PUBLIC_SENTRY_ENV`: окружение в Sentry (development/production/etc)
- `NEXT_PUBLIC_SENTRY_DSN`: DSN URL от Sentry
- `NEXT_PUBLIC_LOGDNA_APP`: название приложение в logDNA, желательно с окончанием текущего окружения (-dev/-prod/-etc)
Expand All @@ -11,4 +15,4 @@

### Файл `src/env.ts`

В этом файле (и только в нём) производится чтение env переменных всего приложения, а уже из него они пробрасываются дальше. То есть чтение `process.env` вне этого файла запрещено.
В этом файле (и только в нём) производится чтение env переменных всего приложения, а уже из него они пробрасываются дальше. То есть чтение `process.env` вне этого файла запрещено.
4 changes: 2 additions & 2 deletions src/pages/api/test.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import {NextApiHandler} from "next"
import {Sentry, withSentry} from "@gooditworks/monitoring/next"
import {withSentry} from "@gooditworks/monitoring/next"

const testHandler: NextApiHandler = (request, response) => {
if (request.query.throw) {
Sentry.captureException(new Error(`triggered test exception: ${request.query.throw}`))
throw new Error("test error happen")
}

return response.status(200).json({success: true})
Expand Down

0 comments on commit fdae6e1

Please sign in to comment.