{"id":21031312,"url":"https://github.com/workable/honeybadger-java","last_synced_at":"2025-08-09T00:05:51.591Z","repository":{"id":24197018,"uuid":"27588278","full_name":"Workable/honeybadger-java","owner":"Workable","description":"Java clients to report errors in Honeybadger","archived":false,"fork":false,"pushed_at":"2024-04-12T15:16:24.000Z","size":87,"stargazers_count":0,"open_issues_count":10,"forks_count":2,"subscribers_count":70,"default_branch":"master","last_synced_at":"2025-01-20T15:22:28.716Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","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/Workable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2014-12-05T11:19:58.000Z","updated_at":"2018-12-21T11:06:20.000Z","dependencies_parsed_at":"2024-11-19T12:38:32.126Z","dependency_job_id":"4a9fc8ff-b497-43f5-94d5-00258cdaa913","html_url":"https://github.com/Workable/honeybadger-java","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fhoneybadger-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fhoneybadger-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fhoneybadger-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Workable%2Fhoneybadger-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Workable","download_url":"https://codeload.github.com/Workable/honeybadger-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243471474,"owners_count":20296123,"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":"2024-11-19T12:27:12.615Z","updated_at":"2025-03-13T19:41:32.805Z","avatar_url":"https://github.com/Workable.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Honeybadger-java\n*Java client to report exceptions to [Honeybadger.io](https://www.honeybadger.io)*\n\nExceptions can be captured and dispatched in Honeybadger with the following methods:\n\n- registering a specific [Thread.UncaughtExceptionHandler](https://docs.oracle.com/javase/7/docs/api/java/lang/Thread.UncaughtExceptionHandler.html)\n- registering a custom [Filter](http://docs.oracle.com/javaee/7/api/javax/servlet/Filter.html) for web applications\n- appending events in [log4j](https://logging.apache.org/log4j/1.2/) using the [honeybadger-log4j-appender](honeybadger-log4j-appender)\n\n\n## Usage\n\n### Standalone\nA typical stand-alone implementation may look like:\n\n```java\nimport com.workable.honeybadger.HoneybadgerUncaughtExceptionHandler;\n\npublic static void main(String argv[]) {\n    HoneybadgerUncaughtExceptionHandler.registerAsUncaughtExceptionHandler();\n    // The rest of the application goes here\n}\n```\nThe following system properties should be set to enable error dispatching:\n\nSystem Properties:\n\n - honeybadger.api_key - set this to the (typically 8 character) API key displayed on your Honeybadger interface\n - honeybadger.excluded_sys_props - a comma delinated list of system property\n   keys to exclude from being reported to Honeybadger. This allows you to prevent\n   passwords and other sensitive information from being sent.\n - honeybadger.excluded_exception_classes - a comma delimited list of fully formed\n   class names that will be excluded from error reporting.\n - JAVA_ENV / ENV - set this to configure the application's running environment\n\n### In a servlet container\nA servlet based implemantion may look like:\n\nIn your web.xml file:\n\n```xml\n    \u003c!-- Send all uncaught servlet exceptions and servlet request details to Honeybadger --\u003e\n    \u003cfilter\u003e\n        \u003cfilter-name\u003eHoneybadgerFilter\u003c/filter-name\u003e\n        \u003cfilter-class\u003ecom.workable.honeybadger.servlet.HoneybadgerFilter\u003c/filter-class\u003e\n        \u003cinit-param\u003e\n            \u003cparam-name\u003ehoneybadger.api_key\u003c/param-name\u003e\n            \u003cparam-value\u003eAPI KEY GOES HERE\u003c/param-value\u003e\n        \u003c/init-param\u003e\n        \u003cinit-param\u003e\n            \u003cparam-name\u003ehoneybadger.excluded_sys_props\u003c/param-name\u003e\n            \u003cparam-value\u003ebonecp.password,bonecp.username\u003c/param-value\u003e\n        \u003c/init-param\u003e\n        \u003cinit-param\u003e\n            \u003cparam-name\u003ehoneybadger.excluded_exception_classes\u003c/param-name\u003e\n            \u003cparam-value\u003eorg.apache.catalina.connector.ClientAbortException\u003c/param-value\u003e\n        \u003c/init-param\u003e\n    \u003c/filter\u003e\n    \u003cfilter-mapping\u003e\n        \u003cfilter-name\u003eHoneybadgerFilter\u003c/filter-name\u003e\n        \u003curl-pattern\u003e/*\u003c/url-pattern\u003e\n    \u003c/filter-mapping\u003e\n```\n\n### Log4J\nA typical log4j properties may look like:\n\n```properties\nlog4j.rootLogger=ALL, ConsoleAppender, HoneybadgerAppender\n\nlog4j.appender.HoneybadgerAppender=com.workable.honeybadger.log4j.HoneybadgerAppender\nlog4j.appender.HoneybadgerAppender.layout=org.apache.log4j.EnhancedPatternLayout\nlog4j.appender.HoneybadgerAppender.layout.ConversionPattern=[%-5p] %c - %m%n%throwable{none}\nlog4j.appender.HoneybadgerAppender.threshold=ERROR\n\nlog4j.appender.HoneybadgerAppender.apiKey=XXXXXXXX\nlog4j.appender.HoneybadgerAppender.async=true\nlog4j.appender.HoneybadgerAppender.maxThreads=1\nlog4j.appender.HoneybadgerAppender.queueSize=50000\nlog4j.appender.HoneybadgerAppender.priority=1\n\n\nlog4j.appender.ConsoleAppender=org.apache.log4j.ConsoleAppender\nlog4j.appender.ConsoleAppender.layout=org.apache.log4j.EnhancedPatternLayout\nlog4j.appender.ConsoleAppender.layout.ConversionPattern=[WORKABLE] [%-5p] %c - %m%n%throwable{none}\n```\n### Logback\nA typical logback.xml may look like:\n\n```xml\n\u003cconfiguration\u003e\n    \u003cappender name=\"honeybadger\" class=\"com.workable.honeybadger.logback.HoneybadgerAppender\"\u003e\n        \u003cparam name=\"Threshold\" value=\"ERROR\" /\u003e\n        \u003cparam name=\"apiKey\" value=\"xxxxxx\" /\u003e\n        \u003cencoder\u003e\n            \u003cpattern\u003e%-4relative [%thread] %-5level %logger{35} - %msg %n\u003c/pattern\u003e\n        \u003c/encoder\u003e\n    \u003c/appender\u003e\n    \u003cappender name=\"console\" class=\"ch.qos.logback.core.ConsoleAppender\"\u003e\n        \u003cencoder\u003e\n            \u003cpattern\u003e%-4relative [%thread] %-5level %logger{35} - %msg %n\u003c/pattern\u003e\n        \u003c/encoder\u003e\n    \u003c/appender\u003e\n    \u003clogger name=\"com.workable\"\u003e\n        \u003clevel value=\"DEBUG\"/\u003e\n    \u003c/logger\u003e\n    \u003croot\u003e\n        \u003clevel value=\"INFO\" /\u003e\n        \u003cappender-ref ref=\"honeybadger\" /\u003e\n        \u003cappender-ref ref=\"console\" /\u003e\n    \u003c/root\u003e\n\u003c/configuration\u003e\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkable%2Fhoneybadger-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkable%2Fhoneybadger-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkable%2Fhoneybadger-java/lists"}