{"id":13531510,"url":"https://github.com/envylabs/faraday-detailed_logger","last_synced_at":"2025-11-11T20:36:39.132Z","repository":{"id":18254637,"uuid":"21410121","full_name":"envylabs/faraday-detailed_logger","owner":"envylabs","description":"A detailed request and response logger for Faraday.","archived":false,"fork":false,"pushed_at":"2025-08-29T18:32:06.000Z","size":243,"stargazers_count":60,"open_issues_count":0,"forks_count":12,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-11-03T05:13:07.149Z","etag":null,"topics":["faraday","logger","logging","middleware","ruby"],"latest_commit_sha":null,"homepage":"http://rubygems.org/gems/faraday-detailed_logger","language":"Ruby","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/envylabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2014-07-02T03:19:31.000Z","updated_at":"2025-09-12T17:09:43.000Z","dependencies_parsed_at":"2024-01-14T01:53:53.660Z","dependency_job_id":"310a4234-3b6b-4f50-b85f-0f9a73c5bbed","html_url":"https://github.com/envylabs/faraday-detailed_logger","commit_stats":{"total_commits":428,"total_committers":7,"mean_commits":"61.142857142857146","dds":0.3621495327102804,"last_synced_commit":"112c0b05621407f2803177976b6439c36f9caba6"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/envylabs/faraday-detailed_logger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/envylabs%2Ffaraday-detailed_logger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/envylabs%2Ffaraday-detailed_logger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/envylabs%2Ffaraday-detailed_logger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/envylabs%2Ffaraday-detailed_logger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/envylabs","download_url":"https://codeload.github.com/envylabs/faraday-detailed_logger/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/envylabs%2Ffaraday-detailed_logger/sbom","scorecard":{"id":378491,"data":{"date":"2025-08-11","repo":{"name":"github.com/envylabs/faraday-detailed_logger","commit":"cec0a8d497adf6b8ec88abfccfde5140dcadf959"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-please.yml:9","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/release-please.yml:24","Warn: no topLevel permission defined: .github/workflows/release-please.yml:1","Warn: no topLevel permission defined: .github/workflows/tests.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/release-please.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/release-please.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/tests.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/tests.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/envylabs/faraday-detailed_logger/tests.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v2.5.0 not signed: https://api.github.com/repos/envylabs/faraday-detailed_logger/releases/57781350","Warn: release artifact v2.5.0 does not have provenance: https://api.github.com/repos/envylabs/faraday-detailed_logger/releases/57781350"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: MIT License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 9 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T14:49:04.269Z","repository_id":18254637,"created_at":"2025-08-18T14:49:04.269Z","updated_at":"2025-08-18T14:49:04.269Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":283927972,"owners_count":26918076,"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-11-11T02:00:06.610Z","response_time":65,"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":["faraday","logger","logging","middleware","ruby"],"created_at":"2024-08-01T07:01:03.577Z","updated_at":"2025-11-11T20:36:39.105Z","avatar_url":"https://github.com/envylabs.png","language":"Ruby","funding_links":[],"categories":["Middleware"],"sub_categories":[],"readme":"# Faraday::DetailedLogger\n\n[![Gem Version](https://badge.fury.io/rb/faraday-detailed_logger.svg)](https://badge.fury.io/rb/faraday-detailed_logger)\n[![Tests](https://github.com/envylabs/faraday-detailed_logger/actions/workflows/tests.yml/badge.svg)](https://github.com/envylabs/faraday-detailed_logger/actions/workflows/tests.yml)\n\nA Faraday middleware used for providing debug- and info-level logging\ninformation. The request and response logs follow very closely with cURL output\nfor ease of understanding.\n\n**Caution:** Be careful about your log level settings when using this\nmiddleware, _especially_ in a production environment. With a DEBUG level log\nenabled, there will be information security concerns.\n\nAt a DEBUG level, the request and response headers and their bodies will be\nlogged. This means that if you have Authorization information or API keys in\nyour headers or are passing around sensitive information in the bodies, only an\nINFO level or above should be used.\n\nNo headers or bodies are logged at an INFO or greater log level.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'faraday-detailed_logger'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install faraday-detailed_logger\n```\n\n## Usage\n\nOnce required, the logger can be added to any Faraday connection by inserting\nit into your connection's request/response stack:\n\n```ruby\nrequire 'faraday'\nrequire 'faraday/detailed_logger'\n\nconnection = Faraday.new(url: 'http://sushi.com') do |faraday|\n  faraday.request  :url_encoded\n  faraday.response :detailed_logger # \u003c-- Inserts the logger into the connection.\n  faraday.adapter  Faraday.default_adapter\nend\n```\n\nBy default, the Faraday::DetailedLogger will log to STDOUT. If this is not your\ndesired log location, simply provide any Logger-compatible object as a\nparameter to the middleware definition:\n\n```ruby\nrequire 'faraday'\nrequire 'faraday/detailed_logger'\nrequire 'logger'\n\nmy_logger = Logger.new('logfile.log')\nmy_logger.level = Logger::INFO\n\nconnection = Faraday.new(url: 'http://sushi.com') do |faraday|\n  faraday.request  :url_encoded\n  faraday.response :detailed_logger, my_logger # \u003c-- sets a custom logger.\n  faraday.adapter  Faraday.default_adapter\nend\n```\n\nOr, perhaps use your Rails logger:\n\n```ruby\nfaraday.response :detailed_logger, Rails.logger\n```\n\nFurther, you might like to tag logged output to make it easily located in your\nlogs:\n\n```ruby\nfaraday.response :detailed_logger, Rails.logger, 'Sushi Request'\n```\n\n### Example output\n\nBecause logs generally work best with a single line of data per entry, the\nDEBUG-level output which contains the headers and bodies is inspected prior to\nlogging. This crushes down and slightly manipulates the multi-line output one\nwould expect when performing a verbose cURL operation into a log-compatible\nsingle line.\n\nBelow is a contrived example showing how this works. Presuming cURL generated\nthe following request and received the associated response:\n\n```bash\n$ curl -v -d \"requestbody=content\" http://sushi.com/temaki\n\u003e GET /temaki HTTP/1.1\n\u003e User-Agent: Faraday::DetailedLogger\n\u003e Host: sushi.com\n\u003e Content-Type: application/x-www-form-urlencoded\n\u003e \n\u003e requestbody=content\n\u003e\n\u003c HTTP/1.1 200 OK\n\u003c Content-Type: application/json\n\u003c \n\u003c {\"order_id\":\"1\"}\n```\n\nThe Faraday::DetailedLogger would log something similar to the following, with\nDEBUG-level logging enabled:\n\n```plain\nPOST http://sushi.com/nigirizushi\n\"User-Agent: Faraday::DetailedLogger\\nContent-Type: application/x-www-form-urlencoded\\n\\nrequestbody=content\"\nHTTP 200\n\"Content-Type: application/json\\n\\n{\\\"order_id\\\":\\\"1\\\"}\"\n```\n\n#### Request logging\n\nLog output for the request-portion of an HTTP interaction:\n\n```plain\nPOST http://sushi.com/temaki\n\"User-Agent: Faraday v0.9.0\\nAccept: application/json\\nContent-Type: application/json\\n\\n{\\\"name\\\":\\\"Polar Bear\\\",\\\"ingredients\\\":[\\\"Tuna\\\",\\\"Salmon\\\",\\\"Cream Cheese\\\",\\\"Tempura Flakes\\\"],\\\"garnish\\\":\\\"Eel Sauce\\\"}\"\n```\n\nThe POST line is logged at an INFO level just before the request is transmitted\nto the remote system. The second line containing the request headers and body\nare logged at a DEBUG level.\n\n#### Response logging\n\nLog output for the response-portion of an HTTP interaction:\nResponse portion:\n\n```plain\nHTTP 202\n\"server: nginx\\ndate: Tue, 01 Jul 2014 21:56:52 GMT\\ncontent-type: application/json\\ncontent-length: 17\\nconnection: close\\nstatus: 202 Accepted\\n\\n{\\\"order_id\\\":\\\"1\\\"}\"\n```\n\nThe HTTP status line is logged at an INFO level at the same time the response\nis returned from the remote system. The second line containing the response\nheaders and body are logged at a DEBUG level.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/envylabs/faraday-detailed_logger.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License][].\n\n### Dependency Licensing\n\nThe dependencies and sub-dependencies of this gem are checked to be available\nfor Private Use, Commercial Use, Modification, and Distribution:\n\n* [2-Clause BSD License][]\n* [Apache 2.0 License][]\n* [MIT License][]\n* [Ruby License][]\n\n[2-Clause BSD License]: https://opensource.org/licenses/BSD-2-Clause\n[Apache 2.0 License]: https://opensource.org/licenses/Apache-2.0\n[MIT License]: https://opensource.org/licenses/MIT\n[Ruby License]: https://en.wikipedia.org/wiki/Ruby_License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenvylabs%2Ffaraday-detailed_logger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenvylabs%2Ffaraday-detailed_logger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenvylabs%2Ffaraday-detailed_logger/lists"}