docs(observability): document the dashboards, alerts and local stack #993
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| test: | |
| name: Run on Ubuntu | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone the code | |
| uses: actions/checkout@v7 | |
| - name: Setup Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version-file: go.mod | |
| - name: Running Tests | |
| run: | | |
| go mod tidy | |
| make test | |
| - name: Running Scaffold Gate | |
| run: make test-scaffold | |
| observability: | |
| name: Alerts and dashboards | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone the code | |
| uses: actions/checkout@v7 | |
| - name: Setup Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version-file: go.mod | |
| # promtool is not part of `make all` so that contributors without it can | |
| # still run everything else. Bump PROMETHEUS_VERSION by hand. | |
| - name: Install promtool | |
| env: | |
| PROMETHEUS_VERSION: "3.14.0" | |
| run: | | |
| mkdir -p "$HOME/.local/bin" | |
| curl -sSfL "https://github.com/prometheus/prometheus/releases/download/v$PROMETHEUS_VERSION/prometheus-$PROMETHEUS_VERSION.linux-amd64.tar.gz" \ | |
| | tar -xz --strip-components=1 -C "$HOME/.local/bin" "prometheus-$PROMETHEUS_VERSION.linux-amd64/promtool" | |
| echo "$HOME/.local/bin" >> "$GITHUB_PATH" | |
| - name: Test alerts | |
| run: make test-alerts | |
| - name: Lint dashboards | |
| run: make lint-dashboards |