Commit graph

132 commits

Author SHA1 Message Date
Vadim Stepanov
d198b932c1
Zendesk inbound integration docs (#1860)
# What this PR does
Add docs & logo for Zendesk integration. Main PR in private repo:
https://github.com/grafana/oncall-private/pull/1772

## Which issue(s) this PR fixes
https://github.com/grafana/oncall-private/issues/1627

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] No changelog (Zendesk integration will be only available in cloud)
2023-05-03 11:38:07 +01:00
Vadim Stepanov
50eb1fed5d
Jira inbound integration docs (#1842)
# What this PR does
Add docs & logo for Jira integration. Main PR in private repo:
https://github.com/grafana/oncall-private/pull/1769

## Which issue(s) this PR fixes
https://github.com/grafana/oncall-private/issues/1620

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] No changelog (Jira integration will be only available in cloud)
2023-05-02 09:37:49 +00:00
Joey Orlando
4967ce8208
update web UI, Slack, and Telegram to allow silencing an acknowledged alert group (#1831)
# What this PR does

https://www.loom.com/share/1a6ef0d00c3b46ca80c120579d512dcc

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated (N/A)
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-04-27 14:52:35 +00:00
Jack Baldry
fb7a4bea13
Use centralized make-docs script from Writers' Toolkit (#1742)
- Adds ability to build multiple projects simultaneously using, for
example, `make docs PROJECTS='grafana grafana-cloud'`.
- Adds `make doc-validator` which runs
[`doc-validator`](https://github.com/grafana/technical-documentation/tree/main/tools/cmd/doc-validator)
on all documentation.

Using a centralized script will help ensure consistency in workflow
across all projects.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-04-24 08:52:43 +00:00
Ildar Iskhakov
6e61643750
Limit number of alertmanager alerts in alert group to autoresolve (#1779)
# What this PR does

This PR set the limit so that workers won't attempt to autoresolve too
big alertmanager alert groups.

## Which issue(s) this PR fixes

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-04-24 05:38:21 +00:00
Matias Bordese
e404d2f4b6
Update shift API to use a default for interval when missing (#1810)
Fixes #1527.
2023-04-21 19:13:09 +00:00
Vadim Stepanov
569c85dab6
Schedule quality docs (#1781)
# What this PR does
Add docs for schedule quality report feature.

## Which issue(s) this PR fixes
https://github.com/grafana/oncall/issues/1552

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-04-19 16:11:22 +01:00
Ildar Iskhakov
9a1eda004c
Merge pull request #1708 from grafana/dev
v1.2.8
2023-04-06 13:43:59 +08:00
Ashley Harrison
b27fb94fbb
Docs: change 'Alerts & incidents' to 'Alerts & IRM' in the docs (#1699)
# What this PR does

- changes `Alerts & incidents` to `Alerts & IRM` in the docs

## Which issue(s) this PR fixes

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-04-05 12:37:04 +00:00
Zach Day
6efff5e11f
Include a note on user working hours (#1679)
Add a note that user working hours are currently hardcoded and will be
updated in a future release

# What this PR does
Adds a note that OnCall working hours are hardcoded and cannot be
customized at the moment.

## Which issue(s) this PR fixes

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-03-30 17:54:21 +03:00
Vadim Stepanov
69a195132d
Merge pull request #1632 from grafana/dev
Dev to main (v1.2.2)
2023-03-27 15:29:43 +01:00
sarah-spang
44171fc7b6
Add label and formatted JSON example (#1465)
# What this PR does
- Updates documentation 

## Which issue(s) this PR fixes
- Removed visible backticks to correct formatting
- Added example of a variable that returns alert labels
- Added details on how to send labels in formatted JSON

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
Co-authored-by: Joey Orlando <joseph.t.orlando@gmail.com>
2023-03-23 17:12:19 +01:00
Ildar Iskhakov
cad8223a58
Update team management docs (#1606)
# What this PR does

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated
2023-03-23 13:15:55 +00:00
Vadim Stepanov
e18c1a5f56
Inbound email OSS docs minor improvements (#1567)
# What this PR does
Updates the [OSS
docs](https://grafana.com/docs/oncall/latest/open-source/#email-setup)
for configuring inbound email setup:
- Separate inbound & outbound email sections so it's easier to reference
- Add info on configuring ESPs to forward emails to OnCall
- Minor formatting changes

## Which issue(s) this PR fixes
Related to https://github.com/grafana/oncall/issues/575

## Checklist
- [x] Documentation added
2023-03-23 08:53:24 +02:00
Joey Orlando
4d655dff60
modify check_escalation_finished_task task (#1266)
# What this PR does

This PR:
- modifies the `check_escalation_finished_task` celery task to:
  - do stricter escalation validation based on the alert group's
escalation snapshot (see the `audit_alert_group_escalation` method in
`engine/apps/alerts/tasks/check_escalation_finished.py` for the
validation logic)
- use a read-only database for querying alert-groups if one is
configured, otherwise use the "default" one
- ping a configurable heartbeat (new env var
`ALERT_GROUP_ESCALATION_AUDITOR_CELERY_TASK_HEARTBEAT_URL` added)
- increase the task frequency from every 10 to every 13 minutes (this
can be configured via an env variable)
  - adds public documentation on how to configure this auditor task
- modifies the local celery startup command to properly take into
consideration all celery related env vars (similar to the ones we use in
`engine/celery_with_exporter.sh`; this made it easier to enable `celery
beat` locally for testing)
- removes the following code:
- removes references to `AlertGroup.estimate_escalation_finish_time` and
marks the model field as deprecated using the [`django-deprecate-fields`
library](https://pypi.org/project/django-deprecate-fields/). This field
was only used for the previous version of this validation task
- `EscalationSnapshotMixin.calculate_eta_for_finish_escalation` was only
used to calculate the value for
`AlertGroup.estimate_escalation_finish_time`
  - `calculate_escalation_finish_time` celery task
  

## Which issue(s) this PR fixes

https://github.com/grafana/oncall-private/issues/1558

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated
2023-03-17 10:14:08 +00:00
Vadim Stepanov
747fbfcb1b
Add regex_match Jinja filter (#1556)
# What this PR does
Adds a new `regex_match` filter to Jinja environment.

## Which issue(s) this PR fixes
This should be useful on its own, and also helpful for
https://github.com/grafana/oncall/pull/1555.

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated
2023-03-16 10:18:49 +00:00
Vadim Stepanov
bd12d38ee0
Public API: allow null escalation chain when creating routes (#1557)
# What this PR does
Allows passing `null` as a value for `escalation_chain` when creating
routes via the public API.

## Which issue(s) this PR fixes
This is needed to unblock https://github.com/grafana/oncall/pull/1555 +
creating a route without an escalation chain is possible in the web UI,
so this PR makes the public API more consistent with the web UI.

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated
2023-03-16 09:40:50 +00:00
Vadim Stepanov
ea60c0d247
Inbound email integration (#837)
This PR add Inbound Email integration.

It designed to support some variety of ESPs, but in prod we will use
Mailgun, so locally I tested it only with mailgun ESP.

**Important:**
To make it work on different clusters I'm planning to provide different
email domains for different regions, like ....@us.oncall.grafana.net,
...@eu.oncall.grafana.net

---------

Co-authored-by: Innokentii Konstantinov <innokenty.konstantinov@grafana.com>
2023-03-16 13:59:21 +08:00
Alyssa Wada
2dacb0ee8a
Add RBAC guidance to users and teams documentation (#1413)
# What this PR does
RBAC for OnCall will be GA with Grafana 9.4 release.
Update [this
doc](https://grafana.com/docs/oncall/latest/configure-user-settings/) to
include details about RBAC for OnCall and link to RBAC-specific docs.

## Which issue(s) this PR fixes
Issue #1399 

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated
2023-03-14 07:08:42 +01:00
Matvey Kukuy
df215d20bf
ALert Flow basic explanation. (#1239)
# What this PR does

Updating docs with basic alert flow explanation.

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [x] Documentation added
- [ ] `CHANGELOG.md` updated

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
Co-authored-by: Ildar Iskhakov <Ildar.iskhakov@grafana.com>
2023-03-09 10:38:20 +08:00
Ildar Iskhakov
2e63a9ff08
Jinja2 based routes (#1319)
# What this PR does

This PR adds the new way to set up routes using jinja2 templating
language

<img width="1174" alt="Screenshot 2023-03-06 at 22 11 13"
src="https://user-images.githubusercontent.com/2262529/223134053-69d43c47-bb2a-4790-a16d-767425017a76.png">
<img width="1175" alt="Screenshot 2023-03-06 at 22 11 34"
src="https://user-images.githubusercontent.com/2262529/223134070-1e5ef82f-021c-4d5d-b255-b19bb3445641.png">


## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated
2023-03-08 16:42:18 +08:00
ak0nst
44e93b6ab4
Email and phone limits now environment variable (#1219)
# What this PR does
Email and phone limits now environment variables:
EMAIL_NOTIFICATIONS_LIMIT=200, PHONE_NOTIFICATIONS_LIMIT=200

## Which issue(s) this PR fixes
#1010

## Checklist

- [ ] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated

---------

Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
2023-03-07 10:48:05 +00:00
Innokentii Konstantinov
6a5e75e083
Fix of templates api behaviour for public and private api (#1408)
# What this PR does

This PR fixes templates behaviour for public and private api. It fix
"reset to default" for templates from messaging backends and some minor
bugs. Also added acknowledge signal and source link templates

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated
2023-03-01 16:32:15 +08:00
Vadim Stepanov
f194df0e99
Add App Store link to web UI (#1328)
# What this PR does
Adds the IPhone mobile app link to web UI.

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated
2023-02-16 10:49:37 +00:00
Matias Bordese
4816242c22
Update docs to include details about direct paging command (#1258) 2023-02-06 09:21:15 -03:00
Ildar Iskhakov
335c8fe65b
Optimize alert and alert group public api endpoints, add filter by id (#1274)
# What this PR does

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
2023-02-03 17:05:08 +08:00
Matvey Kukuy
038310829b
Mobile app documentation draft. (#1207)
# What this PR does

First draft of documentation. @alyssawada please use it as a starting
point :)

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [x] Documentation added
- [ ] `CHANGELOG.md` updated

---------

Co-authored-by: alyssa wada <alyssa.wada@grafana.com>
Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
Co-authored-by: Alyssa Wada <101596687+alyssawada@users.noreply.github.com>
Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
2023-02-02 15:06:28 +00:00
Alyssa Wada
2b2a837991
Add oncall slack commands to docs (#994)
# What this PR does
Adds instruction for Slack commands and message shortcuts to OnCall
docs.

## Which issue(s) this PR fixes
Issue #190

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
Co-authored-by: Joey Orlando <joseph.t.orlando@gmail.com>
Co-authored-by: Matvey Kukuy <Matvey-Kuk@users.noreply.github.com>
2023-01-30 13:56:30 +02:00
Alyssa Wada
6456e78ba6
Fix format issues introduced by markdown linter (#1223)
# What this PR does
Restore proper formatting to lists in schedule docs introduced by PR
#1202

## Checklist

- [ ] Tests updated
- [ ] Documentation added
- [ ] `CHANGELOG.md` updated

Co-authored-by: Joey Orlando <joseph.t.orlando@gmail.com>
2023-01-26 13:59:48 +00:00
Ildar Iskhakov
615a2e8333
Fix markdown formatting in docs (#1202)
# What this PR does

This PR adds `--fix` flag to `markdownlint` pre-commit command and fixes
existing formatting to comply with markdown formatting rules.

## Which issue(s) this PR fixes

## Checklist

- [ ] Tests updated
- [x] Documentation added
- [ ] `CHANGELOG.md` updated
2023-01-24 10:58:38 +01:00
Alyssa Wada
fd75a3e4ad
oncall schedule doc updates v1 (#1197)
This is a first iteration to establish initial on-call schedule doc improvements. Additional docs and content improvements in progress. 

# What this PR does
Updates OnCall docs TOC to provide better on-call schedule documentation
Updates _index.md to describe all on-call schedule options with Grafana
OnCall
Adds web-based schedule guidance to oncall docs
- About web-based schedules
- Create on-call schedule in Grafana OnCall
- Export on-call schedules

## Which issue(s) this PR fixes
Issue #935 
Issue #1078
2023-01-23 14:44:28 -07:00
Michael Derynck
2b31043680
Disable unused home tab (#1145)
Set home_tab_enabled for slack app manifest
2023-01-17 13:13:51 -07:00
Tommy
5bd8fbdef8
Add alert groups state filter (#1133)
# What this PR does
This PR added a new parameter (state) into the alert_group public API to
filter the state of the alert groups

## Which issue(s) this PR fixes
https://github.com/grafana/oncall/issues/684

## Checklist

- [x] Tests updated
- [x] Documentation added
- [x] `CHANGELOG.md` updated

Co-authored-by: Vadim Stepanov <vadimkerr@gmail.com>
2023-01-17 10:28:29 +00:00
Joey Orlando
c08eeb72a3
add precommit rules for markdown/json files (#915)
* add markdownlint precommit steps + fix existing errors

* prettier json linting
2022-12-01 14:26:54 +01:00
Matias Bordese
01d85e8fb9
Add note to docs about required roles to get notifications (#922) 2022-12-01 07:25:47 +01:00
Joey Orlando
78d01df864
One startup command to rule them all (#760)
* Modify `docker-compose-developer` configuration files, and `Makefile`
to support running everything in containers for local development

- Make use of the COMPOSE_PROFILES env var that is supported by
docker-compose to allow swapping-out/turning off certain docker-compose
services.
- add makefile cleanup command. Will remove all docker resources related
to running the project locally
- The "restart grafana container" issue, where users would need
to restart their grafana container when setting up the project for the
first time, is now fixed (make command now runs yarn build:dev before docker-compose startup;
this ensures grafana-plugin/dist is available for grafana container before it starts up)
- The DEVELOPER.md has been updated as well to reflect these new changes. It
has been moved to ./dev/README.md (and references to the old file have
been updated).
- The redis image that is referenced in the docker-compose files
has been pinned to v7.0.5 (latest version as of this commit) to avoid
any surprises w/ future releases.
- remove root .dockerignore in favour of individual .dockerignore files
in ./engine and ./grafana-plugin
2022-11-07 16:34:43 +01:00
alyssa wada
a6b8c6f30e remove manual CTAs and add section shortcode to alert-behavior 2022-11-03 14:11:37 -06:00
alyssa wada
35e37b07e7 Add temporary language to currently empty alert behavior doc until new content is complete 2022-11-03 11:34:32 -06:00
Alyssa Wada
95dcc3b942
Merge pull request #644 from grafana/docs-restucture-1
documentation file restructure phase 1 - restructures existing content to help users navigate Grafana OnCall documentation more easily.
2022-11-03 11:20:16 -06:00
Vadim Stepanov
e2456315af
Allow no-auth SMTP connection for email notifications (#759)
* DEFAULT_FROM_EMAIL -> EMAIL_FROM

* add EMAIL_FROM live setting

* EMAIL_FROM -> EMAIL_FROM_ADDRESS

* merge dev

* add test for get_from_email

* allow live settings to be null on internal API

* remove redundant tests
2022-11-03 16:18:37 +00:00
Jack Baldry
78025c2a60
Fix spelling of Alertmanager
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-27 14:01:07 -04:00
Jack Baldry
e55f7dc951
Merge branch 'dev' into docs-restucture-1 2022-10-27 13:58:26 -04:00
Jack Baldry
87d0a50e03
Ensure canonical URLs match the new page locations
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-26 12:32:47 -04:00
Jack Baldry
7a22410bf6
Remove grafana-cloud absolute aliases
They will only redirect to oncall docs and not to grafana-cloud docs.
Relative aliases will correctly redirect within the grafana-cloud docs.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-26 12:21:59 -04:00
Jack Baldry
9d82521a74
Build grafana-cloud docs with oncall content locally
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-26 11:49:19 -04:00
Jack Baldry
f9b9096fa0
Run prettier on modified files front matter
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-25 10:41:01 -04:00
Jack Baldry
037fa48b8f
Rewrite aliases to be relative
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-25 10:39:05 -04:00
Ildar Iskhakov
a4471fc4d2
Merge pull request #677 from grafana/dev
Merge dev to main
2022-10-20 13:57:11 +08:00
Vadim Stepanov
e67d3519fe
Restore email notifications (#621)
* remove email verification related code

* remove email verification related code

* remove sendgrid callback

* remove sendgrid related code

* remove sendgrid related code

* rename sendgrid app to email

* remove email from built-in channels

* remove email from built-in channels

* remove email from built-in channels

* add email backend: https://github.com/grafana/oncall/pull/50

* add email templater

* add email templater

* convert md to html

* add email settings to live settings

* use task to send email, handle some exceptions to create logs

* remove ERROR_NOTIFICATION_MAIL_DELIVERY_FAILED usage

* add email limit logic

* fix tests

* add docs

* remove old email templates

* remove old email templates

* add template_fields to messaging backend

* add messaging backends templates to public api

* add comment for deprecated fields

* fix test

* fix tests

* disable email by default

* don't retry on SMTPException and TimeoutError

* add tests

* bring email back to public api docs

* return ERROR_NOTIFICATION_MAIL_LIMIT_EXCEEDED

* make template_fields tuple

* build_subject_and_title -> build_subject_and_message

* add one more comment about template deprecation

* use 8 as backend id

* add comment about gaierror and BadHeaderError

* add comment on importing in notify_user_async

* edit oss docs
2022-10-19 12:32:56 +01:00
Jack Baldry
e5513d1275
Fix relref links
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-10-18 14:41:22 -04:00