{"id":21657264,"url":"https://github.com/cantido/telemetry_metrics_logger","last_synced_at":"2025-04-11T22:13:00.675Z","repository":{"id":41785073,"uuid":"313109940","full_name":"Cantido/telemetry_metrics_logger","owner":"Cantido","description":"A telemetry_metrics reporter that prints to the Logger","archived":false,"fork":false,"pushed_at":"2025-03-11T22:35:54.000Z","size":122,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T22:12:54.878Z","etag":null,"topics":["beam-telemetry","elixir","metrics","telemetry"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/telemetry_metrics_logger","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Cantido.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-15T19:45:52.000Z","updated_at":"2025-03-11T22:35:50.000Z","dependencies_parsed_at":"2024-01-11T20:28:05.980Z","dependency_job_id":"27511873-c716-44bf-a9af-9faf23decc36","html_url":"https://github.com/Cantido/telemetry_metrics_logger","commit_stats":{"total_commits":50,"total_committers":4,"mean_commits":12.5,"dds":0.5,"last_synced_commit":"51eaac310340b9a5ddaa4bb2f8c5323717caf03b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cantido%2Ftelemetry_metrics_logger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cantido%2Ftelemetry_metrics_logger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cantido%2Ftelemetry_metrics_logger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Cantido%2Ftelemetry_metrics_logger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Cantido","download_url":"https://codeload.github.com/Cantido/telemetry_metrics_logger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487684,"owners_count":21112190,"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":["beam-telemetry","elixir","metrics","telemetry"],"created_at":"2024-11-25T09:20:20.110Z","updated_at":"2025-04-11T22:13:00.637Z","avatar_url":"https://github.com/Cantido.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TelemetryMetricsLogger\n\nA [`telemetry_metrics`](https://github.com/beam-telemetry/telemetry_metrics) reporter that prints to the `Logger`.\n\nThis is different from the built-in console reporter for two reasons:\n\n1. This reporter prints to the logger, instead of standard output\n2. This reporter calculates metrics and prints a periodic report, instead of printing every configured event immediately\n\n## Installation\n\nThis package can be installed by adding `telemetry_metrics_logger` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:telemetry_metrics_logger, \"~\u003e 0.1\"}\n  ]\nend\n```\n\nThe docs can be found at [https://hexdocs.pm/telemetry_metrics_logger](https://hexdocs.pm/telemetry_metrics_logger).\n\n## Usage\n\nFor example, imagine the given metrics:\n\n```elixir\nmetrics = [\n  last_value(\"vm.memory.binary\", unit: :byte),\n  counter(\"vm.memory.total\"),\n  summary(\"phoenix.endpoint.stop.duration\", unit: {:native, :millisecond})\n]\n```\n\nA this reporter can be started as a child of your supervision tree like this:\n\n```elixir\n{TelemetryMetricsLogger, metrics: metrics, interval: 60}\n```\n\nThen, every sixty seconds, you will see a report like this:\n\n```\n12:31:54.492 [info]  Telemetry report 2020-11-09T17:48:00Z\n  Event [:vm, :memory]\n    Measurement \"binary\"\n      Last value: 100 B\n    Measurement \"total\"\n      Counter: 1\n  Event [:phoenix, :endpoint, :stop]\n    Measurement \"duration\"\n      Summary:\n        Average: 101 ms\n        Min: 52 ms\n        Max: 127 ms\n```\n\n## Maintainer\n\nThis project was developed by [Rosa Richter](https://github.com/Cantido).\nYou can get in touch with her on [Keybase.io](https://keybase.io/cantido).\n\n## Contributing\n\nQuestions and pull requests are more than welcome.\nI follow Elixir's tenet of bad documentation being a bug,\nso if anything is unclear, please [file an issue](https://github.com/Cantido/telemetry_metrics_logger/issues/new)!\nIdeally, my answer to your question will be in an update to the docs.\n\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md) for all the details you could ever want about helping me with this project.\n\nNote that this project is released with a Contributor [Code of Conduct](code_of_conduct.md).\nBy participating in this project you agree to abide by its terms.\n\n## License\n\nMIT License\n\nCopyright 2020 Rosa Richter\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcantido%2Ftelemetry_metrics_logger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcantido%2Ftelemetry_metrics_logger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcantido%2Ftelemetry_metrics_logger/lists"}