{"id":28501825,"url":"https://github.com/fluent/fluent-plugin-scribe","last_synced_at":"2025-07-05T02:31:52.831Z","repository":{"id":56847177,"uuid":"2316370","full_name":"fluent/fluent-plugin-scribe","owner":"fluent","description":"Scribe input/output plugin for Fluentd data collector","archived":false,"fork":false,"pushed_at":"2018-12-12T02:07:29.000Z","size":79,"stargazers_count":22,"open_issues_count":3,"forks_count":18,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-06-05T22:05:37.076Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://docs.fluentd.org/articles/in_scribe","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/fluent.png","metadata":{"files":{"readme":"README.rdoc","changelog":"ChangeLog","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":"2011-09-02T20:48:33.000Z","updated_at":"2025-01-04T00:41:02.000Z","dependencies_parsed_at":"2022-09-09T01:00:36.498Z","dependency_job_id":null,"html_url":"https://github.com/fluent/fluent-plugin-scribe","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/fluent/fluent-plugin-scribe","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-scribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-scribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-scribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-scribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluent","download_url":"https://codeload.github.com/fluent/fluent-plugin-scribe/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-scribe/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263671745,"owners_count":23494027,"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":"2025-06-08T16:07:56.349Z","updated_at":"2025-07-05T02:31:52.824Z","avatar_url":"https://github.com/fluent.png","language":"Ruby","readme":"= Scribe input plugin for Fluentd[http://fluentd.org/]\n\n== Overview\n\nThis is a plugin for fluentd[http://fluentd.org] data collector. This plugin adds the Scribe[https://github.com/facebook/scribe] compatible interface to fluentd.\n\n== What's Scribe?\n\nScribe[https://github.com/facebook/scribe] is a server for aggregating log data streamed in real time from a large number of servers, developed at Facebook.\n\nIt uses Thrift[http://thrift.apache.org/], a cross-language RPC framework, to communicate between clients and servers.\n\n== What's Scribe plugin for fluent?\n\nThe Scribe plugin for fluentd, which enables fluentd to talk the Scribe protocol. Scribe protocol is defined as follows, in Thrift-IDL format:\n\n  enum ResultCode\n  {\n    OK,\n    TRY_LATER\n  }\n  \n  struct LogEntry\n  {\n    1:  string category,\n    2:  string message\n  }\n  \n  service scribe extends fb303.FacebookService\n  {\n    ResultCode Log(1: list\u003cLogEntry\u003e messages);\n  }\n\nThe category field is used as fluentd 'tag'.\n\n== How to use?\n\nfluent-plugin-scribe contains both input and output.\n\n=== Scribe Input\n\nPlease add the following configurations to fluent.conf. This allows your Scribe client to import logs through port 1463.\n\n  # Scribe input\n  \u003csource\u003e\n    type scribe\n    port 1463\n  \u003c/source\u003e\n\nThese options are supported.\n\n* port: port number (default: 1463)\n* bind: bind address (default: 0.0.0.0)\n* server_type: server architecture either in 'simple', 'threaded', 'thread_pool', 'nonblocking' (default: nonblocking)\n* is_framed: use framed protocol or not (default: true)\n* add_prefix: prefix string, added to the tag (default: nil)\n* msg_format: format of the messages either in 'text', 'json', 'url_param' (default: text)\n\n=== Scribe Output\n\nPlease add the following configurations to fluent.conf. This allows fluentd to output its logs into another Scribe server. Note that fluentd conveys semi-structured data while Scribe conveys unstructured data, thus, 'field_ref' parameter is prepared to specify which field will be transferred.\n\n  # Scribe output\n  \u003cmatch *\u003e\n    type scribe\n    host scribed-host.local\n    port 1463\n    field_ref message\n  \u003c/match\u003e\n\nThese options are supported.\n\n* host: host name or address (default: localhost)\n* port: port number (default: 1463)\n* field_ref: field name which sent as scribe log message (default: message)\n* timeout: thrift protocol timeout (default: 30)\n* format_to_json: if true/yes, format entire record as json, and send as message (default: false)\n* remove_prefix: prefix string, removed from the tag (default: nil)\n\n== For Developers\n\nTo run fluentd with this plugin on chaging,\n\n  $ bundle # (or 'bundle update')\n  $ bundle exec fluentd -v -v -v -c example.conf\n\nThen please execute the sample client.\n\n  $ bundle exec bin/fluent-scribe-remote\n\n== Contributors\n\n* {Satoshi Tagomori}[https://github.com/tagomoris]\n* {Sadayuki Furuhashi}[https://github.com/frsyuki]\n* {Ken Robertson}[https://github.com/krobertson]\n\n== Copyright\n\nCopyright:: Copyright (c) 2011 Treasure Data, Inc.\nLicense::   Apache License, Version 2.0\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluent%2Ffluent-plugin-scribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluent%2Ffluent-plugin-scribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluent%2Ffluent-plugin-scribe/lists"}