Skip to content
This repository was archived by the owner on Jan 7, 2026. It is now read-only.

Post: Monitoring with GitHub actions#14

Open
ds0nt wants to merge 3 commits into
manabie-com:mainfrom
ds0nt:monitoring-with-github-actions
Open

Post: Monitoring with GitHub actions#14
ds0nt wants to merge 3 commits into
manabie-com:mainfrom
ds0nt:monitoring-with-github-actions

Conversation

@ds0nt

@ds0nt ds0nt commented Apr 1, 2022

Copy link
Copy Markdown
Contributor

No description provided.


Github actions has a CRON schedule trigger we can use run scripts on a custom schedule. It's pretty cool that Github Actions can run jobs on a CRON schedule, and we can use this ability to cover some of our dev-ops needs.

For example, we used this to check if any of our domain certificates were close to their expiry. Each day, a github action runs at 10:45, checks if our certificates are dangerously close to expiring, and posts to our `#monitoring` Slack if any of them are.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, we used this to check if any of our domain certificates were close to their expiry. Each day, a github action runs at 10:45, checks if our certificates are dangerously close to expiring, and posts to our `#monitoring` Slack if any of them are.
For example, we use this to check if any of our domain certificates are close to their expiry. Each day, a github action runs at 10:45, checks if our certificates are dangerously close to expiring, and posts to our `#monitoring` Slack if any of them are.

probably should use present tense I think


name: check_weather
on:
schedule: # run at 010:45 UTC daily

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
schedule: # run at 010:45 UTC daily
schedule: # run at 10:45 UTC daily


This is a simple monitoring flow really; Run Check -> Alert if Problem.

To do this, were going to use three Github actions.

@anhpngt anhpngt Apr 18, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To do this, were going to use three Github actions.
To do this, we are going to use a Github action with 3 sequential jobs.

```yaml
# github/workflows/check_weather.yml`

name: check_weather

@anhpngt anhpngt Apr 18, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous section was talking about certificate expiry, but this section is checking weather instead. This flow is a bit awkward and confusing to me.

Maybe we can add this paragraph:

For simplification and to focus on Github Action, the following example checks and 
reports bad weather instead of our server's certificate. In practice, we can use the 
example to check anything necessary.

shell: bash
run: ./check-weather.sh

# post results

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# post results
# post results
# note that this step only runs when the previous step fails

```
Once your ready to run your workflow, make sure it's merged into your main github branch, for us it's `develop`.

Then it will run on it's CRON schedule, and you can also dispatch it manually from the actions page to run the check immediately.

@anhpngt anhpngt Apr 18, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Then it will run on it's CRON schedule, and you can also dispatch it manually from the actions page to run the check immediately.
Then it will run on its CRON schedule, and you can also trigger it manually from the actions page to run the check immediately.

@anhpngt

anhpngt commented Apr 18, 2022

Copy link
Copy Markdown
Contributor

I finished with my comments. Not much really 😂

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants