update documents

This commit is contained in:
yulike 2022-12-08 14:56:13 -05:00
parent 5fd6f325e2
commit 9ba4e5da6d
5 changed files with 22 additions and 1 deletions

View File

@ -68,7 +68,28 @@ Go to `dbt_run_scheduled.yml` file and there are 2 things need to be updated
- Here are some commands samples:
- Run it in prod: `'["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod"]'`
- Run multiple commands (It is going to be in parallel to speed up): `'["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod", "dbt run -m ./models/streamline/streamline__blocks_history.sql --target prod"]'`
- Including/excluding models and custom dbt run parameters: THe running command is exactly the same as in the dbt run, just find the corresponding DBT commands and wrapped them inside the `'[""]'` is fine, for example, the excluding command can be something like: `'["dbt run -m ./models/streamline/*.sql --exclude"]'`
- **Run History**: The run history and log can be found in the action history page:
- ![run-history](./images/run-history.png)
### Run it as an ad-hoc job
Go to the Action and click the dbt_run_adhoc and type in the command you want to run, please note here that the command you type cannot includ the `'` at beginning and end, it should look something like: `["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod"]`
![ad-hoc-run](./images/ad-hoc-run.png)
## Set up Datadog for testing alert
We are using the Datadog to set up the connection for failed tests. Here is the reference documentation to the connection between datadog, github action and connection to slack channel: https://docs.datadoghq.com/integrations/slack/?tab=slackapplication.
### Create a Slack Channel for alert
Go to Slack and create a channel, named it as `alerts-xxx(your project)-github-actions` and invite the people you want to invite
### Invite Datadog to the channel
Type `/invite @Datadog` in the chat channel to invite datadog to the channel
### Datadog set up
Go to Datadog and click the Monitor to set up the connection:
- Step 1: Click the Monitors to add new Monitor, click New Monitor button at the top right
- ![datadog-monitor](./images/datadog-monitor.png)
- Step 2: Set up the configuration for under which conditions you want to send the alerts. by changing the filter type you can filter only to your project repo
- ![datadog-monitor-config](./images/datadog-monitor-config.png)
- Step 3: Don't forget to mention your slack channel and the correct people to handle that
- ![datadog-monitor-notify-team](./images/datadog-monitor-notify-team.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

BIN
.github/docs/images/datadog-monitor.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
.github/docs/images/run-history.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB