{"id":10114410,"url":"https://aws-observability.github.io/aws-o11y-recipes","last_synced_at":"2025-09-03T03:31:16.425Z","repository":{"id":39915935,"uuid":"389581832","full_name":"aws-observability/aws-o11y-recipes","owner":"aws-observability","description":"recipes for observability solutions at AWS ","archived":true,"fork":false,"pushed_at":"2023-01-11T14:23:43.000Z","size":29674,"stargazers_count":112,"open_issues_count":20,"forks_count":38,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-05-23T04:28:39.007Z","etag":null,"topics":["amazon-web-services","aws","cloudwatch","fluentbit","grafana","observability","opentelemetry","prometheus"],"latest_commit_sha":null,"homepage":"https://aws-observability.github.io/observability-best-practices/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aws-observability.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-26T09:40:29.000Z","updated_at":"2024-02-26T16:31:35.000Z","dependencies_parsed_at":"2023-02-09T03:16:31.895Z","dependency_job_id":null,"html_url":"https://github.com/aws-observability/aws-o11y-recipes","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aws-observability/aws-o11y-recipes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-observability%2Faws-o11y-recipes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-observability%2Faws-o11y-recipes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-observability%2Faws-o11y-recipes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-observability%2Faws-o11y-recipes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aws-observability","download_url":"https://codeload.github.com/aws-observability/aws-o11y-recipes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-observability%2Faws-o11y-recipes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273384849,"owners_count":25095976,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["amazon-web-services","aws","cloudwatch","fluentbit","grafana","observability","opentelemetry","prometheus"],"created_at":"2024-05-23T04:05:41.867Z","updated_at":"2025-09-03T03:31:14.713Z","avatar_url":"https://github.com/aws-observability.png","language":"Go","funding_links":[],"categories":["Misc"],"sub_categories":[],"readme":"## IMPORTANT NOTE\n\nThis repo has been archived and the project merged into https://github.com/aws-observability/observability-best-practices. \n\n***\n\n## AWS o11y recipes\n\nSee [aws-observability.github.io/aws-o11y-recipes/][recipes-live].\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.\n\n## License\n\nThis library is licensed under the MIT-0 License. See the LICENSE file.\n\n## Writing recipes\n\nTo write recipes we're using [MkDocs][mkdocs] with the [Material][mkdocs-material]\ntheme. MkDocs is a static site generator, converting the Markdown files you\nedit to static HTML pages which are then served as via GitHub pages\n\n### Local preview\n\nIn order to locally preview the recipes site you need to have MkDocs installed:\n\n* Make sure to upgrade pip installer\n```\npip3 install --upgrade pip\npip --version\n```\n\n* Install mkdocs\n```\npip install mkdocs\n```\n\n* Validate mkdocs setup\n```\npip check mkdocs\npip show mkdocs\n```\n\n* Depending on python version and OS configuration, execute mkdocs by running one of the following commands\n```\n$ python -m mkdocs [OPTIONS] COMMAND [ARGS]...\n```\n```\n$ mkdocs [OPTIONS] COMMAND [ARGS]...\n```\n\nFurther, we depend on the Material theme and some plugins you can install as follows:\n\n```\npip install mkdocs-material mkdocs-awesome-pages-plugin mkdocs-macros-plugin\n```\n\nTo generate a local preview do:\n\n```\n$ mkdocs serve\nINFO     -  Building documentation...\nINFO     -  Cleaning site directory\n...\n```\n\nNow head over to `http://127.0.0.1:8000/aws-o11y-recipes/` where you should\nfind the local preview of the recipes site.\n\nIf you are looking for formatting tips, check out the [Material theme\nreference][material-formatting].\n\nNote the following when writing a recipe:\n\n* The recipes are located in the [docs/recipes/][recipes-home].\n* The name of the recipe follows in general the dimensions, for example,\n  `ec2-eks-metrics-go-adot-ampamg.md` indicates a recipe for an EKS on EC2 setup,\n  showing how to ingest metrics from a Go app into AMP and consume in AMG.\n* If you have any supporting files such as YAML manifests or scripts, create a\n  directory with the same name as the recipe Markdown file, so in above case you\n  would find a directory `docs/recipes/ec2-eks-metrics-go-adot-ampamg/` that\n  contains YAML files used in the recipes.\n* Put all your images, be it a screen shot or the like, into the \n  [docs/images][recipes-images] directory.\n* When you create a new recipe, don't forget to link it from one of the\n  top-level pages found in the `docs/` directory. For example, above recipe\n  you could add to `amg.md`, `amp.md`, and `eks.md`.\n\n**IMPORTANT** Before you send in a PR, make sure that the local preview with\n`mkdocs serve` renders OK, that is, all images are shown and the rest of the\nformatting, such as code, displays as you would expect.\n\n### Publishing\n\nOnce you PR the repo, we will review and test the recipes and the merge of\nyour PR kicks of a [GitHub action][publishing-ghaction] that publishes your \nrecipe automatically.\n\n[recipes-live]: https://aws-observability.github.io/aws-o11y-recipes/\n[mkdocs]: https://www.mkdocs.org/\n[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/\n[material-formatting]: https://squidfunk.github.io/mkdocs-material/reference/formatting/\n[recipes-home]: https://github.com/aws-observability/aws-o11y-recipes/tree/main/docs/recipes\n[recipes-images]: https://github.com/aws-observability/aws-o11y-recipes/tree/main/docs/images\n[publishing-ghaction]: https://github.com/aws-observability/aws-o11y-recipes/actions/workflows/main.yml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/aws-observability.github.io%2Faws-o11y-recipes","html_url":"https://awesome.ecosyste.ms/projects/aws-observability.github.io%2Faws-o11y-recipes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/aws-observability.github.io%2Faws-o11y-recipes/lists"}