{"id":26863158,"url":"https://github.com/jsuereth/o11y-by-design","last_synced_at":"2025-05-06T20:27:15.437Z","repository":{"id":283752008,"uuid":"952792036","full_name":"jsuereth/o11y-by-design","owner":"jsuereth","description":"Example code for KubeCon Observability by Design talk.","archived":false,"fork":false,"pushed_at":"2025-04-07T15:32:36.000Z","size":58,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T16:41:30.765Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jsuereth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-21T22:24:20.000Z","updated_at":"2025-04-07T15:32:39.000Z","dependencies_parsed_at":"2025-04-07T16:32:40.637Z","dependency_job_id":"8d6d1236-e198-42a1-b409-07dbe1b6bf0c","html_url":"https://github.com/jsuereth/o11y-by-design","commit_stats":null,"previous_names":["jsuereth/o11y-by-design"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsuereth%2Fo11y-by-design","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsuereth%2Fo11y-by-design/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsuereth%2Fo11y-by-design/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jsuereth%2Fo11y-by-design/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jsuereth","download_url":"https://codeload.github.com/jsuereth/o11y-by-design/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252763391,"owners_count":21800482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-31T02:40:12.051Z","updated_at":"2025-05-06T20:27:15.428Z","avatar_url":"https://github.com/jsuereth.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Observability by Design\n\nThis repository is a demonstration of the capabilities of [OpenTelemetry Weaver](https://github.com/open-telemetry/weaver) for designing your observability.\n\nThe key principle is treating observability (metrics, logs, spans, etc.) just as you would\nan API.\n\nThis project demonstrates the following key capabilities of weaver:\n\n- `weaver registry check`: Ensures defined observability signals match policies (e.g. backwards compatibility)\n- `weaver registry generate`: Creates example applications.\n\n[sides from Observability Day EU 2025 talk](https://docs.google.com/presentation/d/1U36ageT5_oIiPTKGFcR7L0yqJP805zwU/edit?usp=sharing\u0026ouid=116090704407622565882\u0026rtpof=true\u0026sd=true)\n\n## Example Application\n\nThe example application is a dead simple HTTP service that provides \"auction\" capabilities.  New bids are posted to the `/auction/{auction_id}/bid` endpoint.\n\nThis example showed tracking bids via metrics and spans.\n\n- Spans leverage OOTB http semantic conventions from the OpenTelemetry project.\n- Metrics use a newly deifned `auction.bid.count` metric, defined in the `o11y`\n  directory.\n\n## Directory layout\n\n- The `o11y/` direcotry contains all deifned observability signals specific to this application.\n- THe `docs/o11y` directory contains autogenerated documentation about the defined metric.\n- The `go/o11y` directort contains autogenerated Go library that will simplify writing\nall defined metrics in the project.\n- The `policies/` directory contains policies that will be enforced on observability signal definitions.\n- The `templates/registry` directory contains templates for autogenerating documentation and code.\n  - `templates/registry/markdown` contains documenation generatoin templates.\n  - `templates/registry/go` contains Go code generation templates.\n  - `templates/registry/rust` contains Rust code generation templates.\n- `go/` contains the Go example application code.\n\n## Building\n\n1. Generate code for Go: `make generate-go`\n2. Generate code for Rust: `make generate-rust`\n\n## Running\n\n1. Running the Go Example\n   - Move to the go directory: `cd go`\n   - Run the go server `go run .`\n   - In a separate terminal, issue some requests\n     `curl localhost:8080/auction/1/bid` e.g.\n   - Check the prometheus metrics:\n     `curl localhost:2223/metrics`\n2. Running the Rust Example\n   TODO\n\n## Generating Docs\n\nRun `make generate-docs`.\n\nAll docs in the `docs/` directory will be updated.\n\n## Verify Policy\n\nRun `make check` and all defined policies for Weaver will be checked against\ndefined telemetry.\n\n_Note: We recommend inlcuding policy checks in CI/CD pipelines._\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsuereth%2Fo11y-by-design","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjsuereth%2Fo11y-by-design","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjsuereth%2Fo11y-by-design/lists"}