docs: add docs for slack alerts for schema registry

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9943
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
GitOrigin-RevId: 2b46bb69118a3854bcb66979b325f79b36bac58c
This commit is contained in:
nevermore 2023-07-27 19:38:55 +05:30 committed by hasura-bot
parent 6ef8f9a446
commit 05d2450a39
4 changed files with 34 additions and 7 deletions

View File

@ -85,7 +85,6 @@ The changes between subsequent schemas are computed using the open source
Breaking changes are typically the changes that could potentially break your GraphQL operations (queries, mutations or Breaking changes are typically the changes that could potentially break your GraphQL operations (queries, mutations or
subscriptions) at the GraphQL operation validation layer. subscriptions) at the GraphQL operation validation layer.
For example, if a field `name` is removed from a GraphQL object type `user`, that counts as a breaking change as it For example, if a field `name` is removed from a GraphQL object type `user`, that counts as a breaking change as it
could potentially fail an existing GraphQL operation that queries the `name` field in the `user` type. could potentially fail an existing GraphQL operation that queries the `name` field in the `user` type.
@ -118,10 +117,38 @@ changes took place.
## Alerts ## Alerts
The Schema Registry sends an email to the owner of the project whenever there are any changes in the GraphQL schema of The Schema Registry provides the following options to configure notifications by clicking the bell icon in the Schema Registry page:
the project. You can configure your mailing preferences by clicking the bell icon in the Schema Registry page.
### Email
The Schema Registry sends an email to the **owner** of the project whenever there are any changes in the GraphQL schema of the project.
<Thumbnail <Thumbnail
src="/img/observability/schema-registry/schema-registry-alert-config.png" src="/img/observability/schema-registry/schema-registry-alert-config.png"
alt="Hasura Cloud Schema Registry Alert Config" alt="Hasura Cloud Schema Registry Alert Config"
/> />
### Slack
The Schema Registry sends an aggregate summary of GraphQL schema changes to the configured Slack channel of the respective workspace. Follow these steps to configure Slack alerts:
1. Click the "Add to Slack" button in the Slack tab.
<Thumbnail
src="/img/observability/schema-registry/add-to-slack.png"
alt="Hasura Cloud Schema Registry Add To Slack"
/>
2. Select the Slack channel in your workspace in which you want alerts to appear. Click **Allow** to authorize.
<Thumbnail
src="/img/observability/schema-registry/select-slack-channel.png"
alt="Hasura Cloud Schema Registry Select Slack Channel"
/>
3. Slack alerts should be configured for the selected channel in your workspace. You can choose to disable the alerts by clicking on the delete icon.
<Thumbnail
src="/img/observability/schema-registry/configured-slack-alerts.png"
alt="Hasura Cloud Schema Registry Configured Slack Alerts"
/>

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB