{"id":19604556,"url":"https://github.com/prateek/ssh-spool-source","last_synced_at":"2025-08-26T14:14:56.491Z","repository":{"id":11453330,"uuid":"13914430","full_name":"prateek/ssh-spool-source","owner":"prateek","description":"Prototype SshSpoolSource for Flume - think Spooling Directory Source over SSH","archived":false,"fork":false,"pushed_at":"2015-09-02T06:38:03.000Z","size":132,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-05T02:21:56.077Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prateek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-10-28T01:58:38.000Z","updated_at":"2016-03-11T11:52:01.000Z","dependencies_parsed_at":"2022-09-13T13:03:14.437Z","dependency_job_id":null,"html_url":"https://github.com/prateek/ssh-spool-source","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prateek%2Fssh-spool-source","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prateek%2Fssh-spool-source/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prateek%2Fssh-spool-source/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prateek%2Fssh-spool-source/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prateek","download_url":"https://codeload.github.com/prateek/ssh-spool-source/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251196037,"owners_count":21550890,"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-11T09:37:18.556Z","updated_at":"2025-04-27T19:32:37.118Z","avatar_url":"https://github.com/prateek.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======\nssh-spool-source\n================\n\nPrototype SshSpoolSource for Flume - think Spooling Directory Source over SSH. Caveat Emptor: It is very much **pre-alpha**.\n\nSemantics\n---------\nThe SshSpoolSource mirrors many semantics from the SpoolingDirectorySource. Here's what it supports at the moment:\n- SSH authorization using username/password (ssh-keys not supported yet)\n- Can specify a remote directory to monitor for new files added\n- Any new files added in there are considered complete and ingested\n- Once a file is processed, it is considered complete, changes to it will not be picked up\n- The source persists the state of processed files to disk, so it will not reprocess any files; and it can pickup where it left off in the event of a restart. \n\n\nConfiguring Flume\n------------------\n\n1. **Build or Download the custom Flume Source**\n\n   The `flume-sources` directory contains a Maven project with a custom Flume source designed to connect to the specified SSH remote path and ingest the contents of the files there into HDFS.\n\n   To build the flume-sources JAR, from the root of the git repository:\n   \n\t   $ cd flume-sources  \n\t   $ mvn package\n\t   $ cd ..  \n\n\n   This will generate a file called `flume-sources-1.0-SNAPSHOT.jar` in the `target` directory.\n\n2. **Add the JAR to the Flume classpath**\n\n   \u003cpre\u003e$ sudo cp /etc/flume-ng/conf/flume-env.sh.template /etc/flume-ng/conf/flume-env.sh\u003c/pre\u003e\n   \n    Edit the `flume-env.sh` file and uncomment the `FLUME_CLASSPATH` line, and enter the path to the JAR. If adding multiple paths, separate them with a colon.\n\n3. **Set the Flume agent name to SshAgent in /etc/default/flume-ng-agent**\n\n    If you don't see the `/etc/default/flume-ng-agent` file, it likely means that you didn't install the `flume-ng-agent` package. In the file, you should have the following:\n\n    \u003cpre\u003eFLUME_AGENT_NAME=SshAgent\u003c/pre\u003e\n\n4. **Modify the provided Flume configuration and copy it to /etc/flume-ng/conf**\n\n   There is a file called `flume.conf` in the `flume-sources` directory, which needs some minor editing. There are five fields which need to be filled in with values.\n\n   \u003cpre\u003e$ sudo cp flume.conf /etc/flume-ng/conf\u003c/pre\u003e\n\n\nStarting the data pipeline\n------------------------\n\n1. **Start the Flume agent**\n\n    Create the HDFS directory hierarchy for the Flume sink.  \n    \n    \u003cpre\u003e\n    $ hadoop fs -mkdir /user/flume/ssh\n    $ hadoop fs -chown -R flume:flume /user/flume/ssh\n    $ hadoop fs -chmod -R 770 /user/flume\n    $ sudo /etc/init.d/flume-ng-agent start\n    \u003c/pre\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprateek%2Fssh-spool-source","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprateek%2Fssh-spool-source","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprateek%2Fssh-spool-source/lists"}