Initial commit

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -0,0 +1,31 @@
+name: CI
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '1.17'
+      - uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-v1-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-v1-
+      - name: tests
+        run: scripts/cibuild
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage.out
+          flags: micro

.gitignore

@@ -0,0 +1,6 @@
+example/weather/services/forecaster/cmd/forecaster/forecaster
+example/weather/services/locator/cmd/locator/locator
+example/weather/services/front/cmd/front/front
+example/weather/.overmind.sock
+example/weather/bin/*
+coverage.out

README.md

@@ -0,0 +1,27 @@
+# clue: Microservice Instrumentation
+
+[![Build Status](https://github.com/goadesign/clue/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/goadesign/clue/actions?query=branch%3Amain+event%3Apush)
+[![codecov](https://codecov.io/gh/goadesign/clue/branch/main/graph/badge.svg?token=HVP4WT1PS6)](https://codecov.io/gh/goadesign/clue)
+
+## Overview
+
+This repository contains microservice instrumentation packages covering the
+following topics:
+
+* Logging: the [log](log/) package provides a context-based logging API that
+  intelligently selects what to log.
+* Metrics: the [instrument](instrument/) package makes it possible for Goa
+  services to expose a Prometheus compatible `/metrics` HTTP endpoint.
+* Health checks: the [health](health/) package provides a simple way for
+  services to expose a health check endpoint.
+* Dependency mocks: the [mock](mock/) package provides a way to mock
+  downstream dependencies for testing.
+* Tracing: the [trace](trace/) package conforms to the
+  [OpenTelemetry](https://opentelemetry.io/) specification to trace requests.
+
+Consult the package-specific READMEs for more information.
+
+## Example
+
+The repository contains a [fully functional example](example/weather)
+comprised of three instrumented Goa microservices.

codecov.yaml

@@ -0,0 +1,2 @@
+ignore:
+  - '**/testsvc/**'

example/weather/Procfile

@@ -0,0 +1,3 @@
+forecaster: bin/forecaster -debug
+locator: bin/locator -debug
+front: bin/front -debug