{"id":22989187,"url":"https://github.com/cookpad/puree-android","last_synced_at":"2025-04-05T06:06:13.839Z","repository":{"id":20221627,"uuid":"23493353","full_name":"cookpad/puree-android","owner":"cookpad","description":"A log collector for Android","archived":false,"fork":false,"pushed_at":"2021-05-10T08:10:32.000Z","size":2031,"stargazers_count":484,"open_issues_count":2,"forks_count":63,"subscribers_count":35,"default_branch":"master","last_synced_at":"2025-03-29T05:05:21.114Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://cookpad.github.io/puree-android/","language":"Java","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/cookpad.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.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}},"created_at":"2014-08-30T14:30:02.000Z","updated_at":"2024-10-12T05:48:02.000Z","dependencies_parsed_at":"2022-07-25T07:02:03.986Z","dependency_job_id":null,"html_url":"https://github.com/cookpad/puree-android","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookpad%2Fpuree-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookpad%2Fpuree-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookpad%2Fpuree-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cookpad%2Fpuree-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cookpad","download_url":"https://codeload.github.com/cookpad/puree-android/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294536,"owners_count":20915340,"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-12-15T04:16:42.699Z","updated_at":"2025-04-05T06:06:13.823Z","avatar_url":"https://github.com/cookpad.png","language":"Java","funding_links":[],"categories":["Libs","日志库","Logger"],"sub_categories":["\u003cA NAME=\"Utility\"\u003e\u003c/A\u003eUtility"],"readme":"# Puree [![Build Status](https://travis-ci.org/cookpad/puree-android.svg?branch=master)](https://travis-ci.org/cookpad/puree-android) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Puree-brightgreen.svg?style=flat)](https://android-arsenal.com/details/1/1170) [![Release](https://jitpack.io/v/cookpad/puree-android.svg)](https://jitpack.io/cookpad/puree-android)\n\n# Description\n\nPuree is a log collector which provides the following features:\n\n- Filtering: Enable to interrupt process before sending log. You can add common params to logs, or the sampling of logs.\n- Buffering: Store logs to buffers and send them later.\n- Batching: Send logs in a single request with `PureeBufferedOutput`.\n- Retrying: Retry to send logs after backoff time if sending logs fails.\n\n![](./images/overview.png)\n\nPuree helps you unify your logging infrastructure.\n\n## Installation\n\nThis is published on `jitpack` and you can use Puree as:\n\n```groovy\n// build.gradle\nbuildscript {\n    repositories {\n        maven { url 'https://jitpack.io' }\n    }\n    ...\n}\n\n// app/build.gradle\ndependencies {\n    implementation \"com.github.cookpad:puree-android:$latestVersion\"\n}\n```\n\n## Usage\n\n### Initialize\n\nConfigure Puree with `PureeConfiguration` in `Application#onCreate()`, which registers\npairs of what and where.\n\n```java\npublic class MyApplication extends Application {\n    @Override\n    public void onCreate() {\n        Puree.initialize(buildConfiguration(this));\n    }\n\n    public static PureeConfiguration buildConfiguration(Context context) {\n        PureeFilter addEventTimeFilter = new AddEventTimeFilter();\n        return new PureeConfiguration.Builder(context)\n                .pureeSerializer(new PureeGsonSerializer())\n                .executor(Executors.newScheduledThreadPool(1)) // optional\n                .register(ClickLog.class, new OutLogcat())\n                .register(ClickLog.class, new OutBufferedLogcat().withFilters(addEventTimeFilter))\n                .build();\n    }\n}\n```\n\nSee also: [demo/PureeConfigurator.java](demo/src/main/java/com/example/puree/logs/PureeConfigurator.java)\n\n### Definition of PureeLog objects\n\nPuree requires that clients supply an implementation of `PureeSerializer` to be able to serialize the logs. For instance, this is an implementation that uses Gson parser:\n\n```java\npublic class PureeGsonSerializer implements PureeSerializer {\n    private Gson gson = new Gson();\n\n    @Override\n    public String serialize(Object object) {\n        return gson.toJson(object);\n    }\n}\n```\n\nA log class is just a POJO whose properties are annotated following the requirements of the Json parser that you provided with PureeSerializer.\n\n```java\npublic class ClickLog {\n    @SerializedName(\"page\")\n    private String page;\n    @SerializedName(\"label\")\n    private String label;\n\n    public ClickLog(String page, String label) {\n        this.page = page;\n        this.label = label;\n    }\n}\n```\n\nYou can use `Puree.send()` to send these logs to registered output plugins:\n\n```java\nPuree.send(new ClickLog(\"MainActivity\", \"Hello\"));\n// =\u003e {\"page\":\"MainActivity\",\"label\":\"Hello\"}\n```\n\n### Definition of PureeOutput plugins\n\nThere are two types of output plugins: non-buffered and buffered.\n\n- `PureeOutput`: Non-buffered output plugins write logs immediately.\n- `PureeBufferedOutput`: Buffered output plugins enqueue logs to a local storage and then flush them in background tasks.\n\nIf you don't need buffering, you can use `PureeOutput`.\n\n```java\npublic class OutLogcat extends PureeOutput {\n    private static final String TYPE = \"out_logcat\";\n\n    @Override\n    public String type() {\n        return TYPE;\n    }\n\n    @Override\n    public OutputConfiguration configure(OutputConfiguration conf) {\n        return conf;\n    }\n\n    @Override\n    public void emit(String jsonLog) {\n        Log.d(TYPE, jsonLog);\n    }\n}\n```\n\nIf you need buffering, you can use `PureeBufferedOutput`.\n\n```java\npublic class OutFakeApi extends PureeBufferedOutput {\n    private static final String TYPE = \"out_fake_api\";\n\n    private static final FakeApiClient CLIENT = new FakeApiClient();\n\n    @Override\n    public String type() {\n        return TYPE;\n    }\n\n    @Override\n    public OutputConfiguration configure(OutputConfiguration conf) {\n        // you can change settings of this plugin\n        // set interval of sending logs. defaults to 2 * 60 * 1000 (2 minutes).\n        conf.setFlushIntervalMillis(1000);\n        // set num of logs per request. defaults to 100.\n        conf.setLogsPerRequest(10);\n        // set retry count. if fail to send logs, logs will be sending at next time. defaults to 5.\n        conf.setMaxRetryCount(3);\n        return conf;\n    }\n\n    @Override\n    public void emit(List\u003cString\u003e jsonLogs, final AsyncResult result) {\n        // you have to call result.success or result.fail()\n        // to notify whether if puree can clear logs from buffer\n        CLIENT.sendLog(jsonLogs, new FakeApiClient.Callback() {\n            @Override\n            public void success() {\n                result.success();\n            }\n\n            @Override\n            public void fail() {\n                result.fail();\n            }\n        });\n    }\n}\n```\n\n### Definition of Filters\n\nIf you need to add common params to each logs, you can use `PureeFilter`:\n\n```java\npublic class AddEventTimeFilter implements PureeFilter {\n    public JsonObject apply(String jsonLog) {\n        JsonObject jsonObject = new JsonParser().parse(jsonLog).getAsJsonObject();\n        jsonObject.addProperty(\"event_time\", System.currentTimeMillis());\n        return jsonOabject.toString();\n    }\n}\n```\n\nYou can make `PureeFilter#apply()` to return `null` to skip sending logs:\n\n```java\npublic class SamplingFilter implements PureeFilter {\n    private final float samplingRate;\n\n    public SamplingFilter(float samplingRate) {\n        this.samplingRate = samplingRate;\n    }\n\n    @Override\n    public JsonObject apply(String jsonLog) {\n        return (samplingRate \u003c Math.random() ? null : jsonLog);\n    }\n}\n```\n\nThen register filters to output plugins on initializing Puree.\n\n```java\nnew PureeConfiguration.Builder(context)\n        .register(ClickLog.class, new OutLogcat())\n        .register(ClickLog.class, new OutFakeApi().withFilters(addEventTimeFilter, samplingFilter)\n        .build();\n```\n\n### Purging old logs\nTo discard unnecessary recorded logs, purge age can be configured in the PureeBufferedOutput subclass.\n\n```java\npublic class OutPurge extends PureeBufferedOutput {\n\n    // ..\n\n    @Override\n    public OutputConfiguration configure(OutputConfiguration conf) {\n        // set to purge buffered logs older than 2 weeks\n        conf.setPurgeAgeMillis(2 * 7 * 24 * 60 * 60 * 1000);\n        return conf;\n    }\n}\n```\n\nThe configured storage must extend `EnhancedPureeStorage` to support purging of old logs. The default `PureeSQLiteStorage` can be used to enable this feature.\n\n```java\nnew PureeConfiguration.Builder(context)\n        .storage(new PureeSQLiteStorage(context))\n        .register(ClickLog.class, new OutPurge().withFilters(addEventTimeFilter, samplingFilter)\n        .build();\n```\n\n## Testing\n\nIf you want to mock or ignore `Puree.send()` and `Puree.flush()`, you can use `Puree.setPureeLogger()` to replace the internal\nlogger. See [PureeTest.java](puree/src/androidTest/java/com/cookpad/puree/PureeTest.java) for details.\n\n## Release Engineering\n\n- Update `CHANGES.md`\n- `git tag $latest_version`\n- `git push origin $latest_version`\n\n# See Also\n\n- [Puree - mobile application log collector - Cookpad Developers' blog (Japanese)](http://techlife.cookpad.com/entry/2014/11/25/132008)\n- https://github.com/cookpad/puree-ios - Puree for iOS\n\n# Copyright\n\nCopyright (c) 2014 Cookpad Inc. https://github.com/cookpad\n\nSee [LICENSE.txt](LICENSE.txt) for the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcookpad%2Fpuree-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcookpad%2Fpuree-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcookpad%2Fpuree-android/lists"}