{"id":18044665,"url":"https://github.com/groonga/fluent-plugin-groonga","last_synced_at":"2025-04-10T01:07:14.837Z","repository":{"id":5224576,"uuid":"6400788","full_name":"groonga/fluent-plugin-groonga","owner":"groonga","description":"Fluentd plugin collection for Groonga users.","archived":false,"fork":false,"pushed_at":"2018-01-16T07:44:19.000Z","size":255,"stargazers_count":6,"open_issues_count":1,"forks_count":5,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-10T01:06:50.959Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://groonga.org/fluent-plugin-groonga/en/","language":"Ruby","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/groonga.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}},"created_at":"2012-10-26T08:33:39.000Z","updated_at":"2022-12-10T07:01:34.000Z","dependencies_parsed_at":"2022-07-12T15:02:59.285Z","dependency_job_id":null,"html_url":"https://github.com/groonga/fluent-plugin-groonga","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groonga%2Ffluent-plugin-groonga","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groonga%2Ffluent-plugin-groonga/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groonga%2Ffluent-plugin-groonga/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/groonga%2Ffluent-plugin-groonga/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/groonga","download_url":"https://codeload.github.com/groonga/fluent-plugin-groonga/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137887,"owners_count":21053775,"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-10-30T18:10:12.827Z","updated_at":"2025-04-10T01:07:14.815Z","avatar_url":"https://github.com/groonga.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @title README\n\n# README\n\n## Name\n\nfluent-plugin-groonga\n\n## Description\n\nFluent-plugin-groonga is a Fluentd plugin collection to use\n[Groonga](http://groonga.org/) with Fluentd. Fluent-plugin-groonga\nsupports the following two usages:\n\n  * Store logs collected by Fluentd to Groonga.\n\n  * Implement replication system for Groonga.\n\nThe first usage is normal usage. You can store logs to Groonga and\nfind logs by full-text search.\n\nThe second usage is for Groonga users. Groonga itself doesn't support\nreplication. But Groonga users can replicate their data by\nfluent-plugin-groonga.\n\nFluent-plugin-groonga includes an input plugin and an output\nplugin. Both of them are named `groonga`.\n\nIf you want to use fluent-plugin-groonga to store logs to Groonga, you\nneed to use only `groonga` output plugin.\n\nThe following configuration stores all data in `/var/log/messages`\ninto Groonga:\n\n    \u003csource\u003e\n      @type tail\n      format syslog\n      path /var/log/syslog.1\n      pos_file /tmp/messages.pos\n      tag log.messages\n      read_from_head true\n    \u003c/source\u003e\n\n    \u003cmatch log.**\u003e\n      @type groonga\n      store_table logs\n\n      protocol http\n      host 127.0.0.1\n\n      buffer_type file\n      buffer_path /tmp/buffer\n      flush_interval 1\n    \u003c/match\u003e\n\nIf you want to use fluent-plugin-groonga to implement Groonga\nreplication system, you need to use both plugins.\n\nThe input plugin provides Groonga compatible interface. It means that\nHTTP and GQTP interface. You can use the input plugin as Groonga\nserver. The input plugin receives Groonga commands and sends them to\nthe output plugin through zero or more Fluentds.\n\nThe output plugin sends received Groonga commands to Groonga. The\noutput plugin supports all interfaces, HTTP, GQTP and command\ninterface.\n\nYou can replicate your data by using `copy` output plugin.\n\n## Install\n\n    % gem install fluent-plugin-groonga\n\n## Usage\n\nThere are two usages:\n\n  * Store logs collected by Fluentd to Groonga.\n\n  * Implement replication system for Groonga.\n\nThey are described in other sections.\n\n### Store logs into Groonga\n\nYou need to use `groonga` output plugin to store logs into Groonga.\n\nThe output plugin has auto schema define feature. So you don't need to\ndefine schema in Groonga before running Fluentd. You just run Groonga.\n\nThere is one required parameter:\n\n  * `store_table`: It specifies table name for storing logs.\n\nHere is a minimum configuration:\n\n    \u003cmatch log.**\u003e\n      @type groonga\n      store_table logs\n    \u003c/match\u003e\n\nThe configuration stores logs into `logs` table in Groonga that runs\non `localhost`.\n\nThere are optional parameters:\n\n  * `protocol`: It specifies protocol to communicate Groonga server.\n\n    * Available values: `http`, `gqtp`, `command`\n\n    * Default: `http`\n\n  * `host`: It specifies host name or IP address of Groonga server.\n\n    * Default: `127.0.0.1`\n\n  * `port`: It specifies port number of Groonga server.\n\n    * Default for `http` protocol: `10041`\n\n    * Default for `gqtp` protocol: `10043`\n\nHere is a configuration that specifies optional parameters explicitly:\n\n    \u003cmatch log.**\u003e\n      @type groonga\n      store_table logs\n\n      protocol http\n      host 127.0.0.1\n      port 10041\n    \u003c/match\u003e\n\n`groonga` output plugin supports buffer. So you can use buffer related\nparameters. See\n[Buffer Plugin Overview | Fluentd](http://docs.fluentd.org/articles/buffer-plugin-overview)\nfor details.\n\nNote that there is special tag name. You can't use\n`groonga.command.XXX` tag name for this usage. It means that you can't\nuse the following configuration:\n\n    \u003cmatch groonga.command.*\u003e\n      @type groonga\n      # ...\n    \u003c/match\u003e\n\n`groonga.command.XXX` tag name is reserved for implementing\nreplication system for Groonga.\n\n### Implement replication system for Groonga\n\nSee the following documents how to implement replication system for\nGroonga:\n\n  * [Configuration](doc/text/configuration.md)\n    ([on the Web](http://groonga.org/fluent-plugin-groonga/en/file.configuration.html))\n\n  * [Constitution](doc/text/constitution.md)\n    ([on the Web](http://groonga.org/fluent-plugin-groonga/en/file.constitution.html))\n\n## Authors\n\n  * Kouhei Sutou `\u003ckou@clear-code.com\u003e`\n\n## License\n\nLGPL 2.1 or later. See doc/text/lgpl-2.1.txt for details.\n\n(Kouhei Sutou has a right to change the license including\ncontributed patches.)\n\n## Mailing list\n\n  * English: [groonga-talk](https://lists.sourceforge.net/lists/listinfo/groonga-talk)\n\n  * Japanese: [groonga-dev](http://lists.sourceforge.jp/mailman/listinfo/groonga-dev)\n\n## Source\n\nThe repository for fluent-plugin-groonga is on\n[GitHub](https://github.com/groonga/fluent-plugin-groonga/).\n\n## Thanks\n\n  * ...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgroonga%2Ffluent-plugin-groonga","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgroonga%2Ffluent-plugin-groonga","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgroonga%2Ffluent-plugin-groonga/lists"}