{"id":14972945,"url":"https://github.com/spring-projects/spring-integration-splunk","last_synced_at":"2025-07-06T14:38:33.587Z","repository":{"id":23191440,"uuid":"26547829","full_name":"spring-projects/spring-integration-splunk","owner":"spring-projects","description":null,"archived":false,"fork":false,"pushed_at":"2019-03-28T03:41:14.000Z","size":304,"stargazers_count":23,"open_issues_count":3,"forks_count":36,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-01-29T14:22:59.329Z","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/spring-projects.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":"2014-11-12T17:35:42.000Z","updated_at":"2024-10-03T01:07:04.000Z","dependencies_parsed_at":"2022-08-21T21:30:45.383Z","dependency_job_id":null,"html_url":"https://github.com/spring-projects/spring-integration-splunk","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/spring-projects%2Fspring-integration-splunk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-integration-splunk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-integration-splunk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spring-projects%2Fspring-integration-splunk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spring-projects","download_url":"https://codeload.github.com/spring-projects/spring-integration-splunk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237110516,"owners_count":19257352,"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-09-24T13:47:47.997Z","updated_at":"2025-02-04T11:33:28.209Z","avatar_url":"https://github.com/spring-projects.png","language":"Java","readme":"Spring Integration Splunk Adapter\n=================================================\n\nThe SI adapter includes Outbound Channel Adapter and Inbound Channel Adapter.\n\nInbound channel adapter :\n-----------------------------------------------------------------------------\nThe Inbound channel adapter is used to read data from Splunk and output a message containing the data to a Spring Integration channel. There are 5 ways to get data from Splunk:\n\n* Blocking\n* Non blocking\n* Saved search\n* Realtime\n* Export\n\n\n### Blocking search:\n\n```xml\n\t\u003cint-splunk:inbound-channel-adapter id=\"splunkInboundChannelAdapter\"\n\t\tsearch=\"search spring:example\"\n\t\tsplunk-server-ref=\"splunkServer\"\n\t\tchannel=\"inputFromSplunk\" mode=\"BLOCKING\" earliestTime=\"-1d\" latestTime=\"now\" initEarliestTime=\"-1d\"\u003e\n\t\t\u003cint:poller fixed-rate=\"5\" time-unit=\"SECONDS\"/\u003e\n\t\u003c/int-splunk:inbound-channel-adapter\u003e\n```\n\n\n### Non blocking search:\n\n```xml\n\t\u003cint-splunk:inbound-channel-adapter id=\"splunkInboundChannelAdapter\"\n\t\tsearch=\"search spring:example\"\n\t\tsplunk-server-ref=\"splunkServer\"\n\t\tchannel=\"inputFromSplunk\" mode=\"NORMAL\" earliestTime=\"-1d\" latestTime=\"now\" initEarliestTime=\"-1d\"\u003e\n\t\t\u003cint:poller fixed-rate=\"5\" time-unit=\"SECONDS\"/\u003e\n\t\u003c/int-splunk:inbound-channel-adapter\u003e\n```\n\n\n### Saved search:\n\n```xml\n\t\u003cint-splunk:inbound-channel-adapter id=\"splunkInboundChannelAdapter\"\n\t\tsavedSearch=\"test\" splunk-server-ref=\"splunkServer\"\n\t\tchannel=\"inputFromSplunk\" mode=\"SAVEDSEARCH\" earliestTime=\"-1d\" latestTime=\"now\" initEarliestTime=\"-1d\"\u003e\n\t\t\u003cint:poller fixed-rate=\"5\" time-unit=\"SECONDS\"/\u003e\n\t\u003c/int-splunk:inbound-channel-adapter\u003e\n```\n\n\n### Realtime search:\n\n```xml\n\t\u003cint-splunk:inbound-channel-adapter id=\"splunkInboundChannelAdapter\"\n\t\tsearch=\"search spring:example\" splunk-server-ref=\"splunkServer\" channel=\"inputFromSplunk\"\n\t\tmode=\"REALTIME\" earliestTime=\"-5s\" latestTime=\"rt\" initEarliestTime=\"-1d\"\u003e\n\t\t\u003cint:poller fixed-rate=\"5\" time-unit=\"SECONDS\"/\u003e\n\t\u003c/int-splunk:inbound-channel-adapter\u003e\n```\n\n### Export:\n\n```xml\n\t\u003cint-splunk:inbound-channel-adapter id=\"splunkInboundChannelAdapter\"\n\t\tauto-startup=\"true\" search=\"search spring:example\" splunk-server-ref=\"splunkServer\" channel=\"inputFromSplunk\"\n\t\tmode=\"EXPORT\" earliestTime=\"-5d\" latestTime=\"now\" initEarliestTime=\"-1d\"\u003e\n\t\t\u003cint:poller fixed-rate=\"5\" time-unit=\"SECONDS\"/\u003e\n\t\u003c/int-splunk:inbound-channel-adapter\u003e\n```\n\nOutbound channel adapter:\n----------------------------------------------------------------------------------------------\n\nThe Outbound channel adapter is used to write data to Splunk from a Spring Integration message channel. There are 3 types of data writers provided:\n\n* submit - Use's Splunk's REST API. Appropriate for small or infrequent data loads. Posts data to a named index or the default if not specified.\n* index - Streams data to a named index or the default if not specified.\n* tcp - Streams data to a tcp port associated with a defined tcp input.\n\nThe outbound channel adapter requires a child *-writer element which defines related attributes:\n\n### Submit:\n\n```xml\n\t\u003cint-splunk:outbound-channel-adapter\n\t\tid=\"splunkOutboundChannelAdapter\"\n\t\tchannel=\"outputToSplunk\"\n\t\tsplunk-server-ref=\"splunkServer\"\n\t\tsourceType=\"spring-integration\"\n\t\tsource=\"example2\"\u003e\n\t\t\u003cint-splunk:submit-writer index=\"foo\"/\u003e\n\t\u003c/int-splunk:outbound-channel-adapter\u003e\n```\n\n### Index:\n\n```xml\n\t\u003cint-splunk:outbound-channel-adapter\n\t\tid=\"splunkOutboundChannelAdapter\"\n\t\tchannel=\"outputToSplunk\"\n\t\tsplunk-server-ref=\"splunkServer\"\n\t \u003e\n\t\t\u003cint-splunk:index-writer index=\"someIndex\"/\u003e\n\t\u003c/int-splunk:outbound-channel-adapter\u003e\n```\n\n### TCP\n\n```xml\n\t\u003cint-splunk:outbound-channel-adapter\n\t\tid=\"splunkOutboundChannelAdapter\"\n\t\tchannel=\"outputToSplunk\"\n\t\tsplunk-server-ref=\"splunkServer\"\n\t  \u003e\n\t\t\u003cint-splunk:tcp-writer port=\"9999\"/\u003e\n\t\u003c/int-splunk:outbound-channel-adapter\u003e\n```\n\n*NOTE: The input must exist and be enabled on the server*\n\n### Configuring The Splunk Server connection\n\n```xml\n\t\u003cint-splunk:server id=\"splunkServer\" username=\"admin\" password=\"password\" timeout=\"5000\" host=\"somehost.someplace.com\" port=\"9000\" /\u003e\n```\n\nAlternatively, you can configure a Splunk Server failover mechanism\n\n```xml\n  \u003cint-splunk:server id=\"splunkServer\" username=\"admin\" password=\"password\" timeout=\"5000\" \n  \t\t\t\t\t host=\"somehost.someplace.com\" port=\"9000\" /\u003e\n\n  \u003cint-splunk:server id=\"splunkServerBackup\" username=\"admin\" password=\"password\" timeout=\"5000\" \n   \t\t\t\t\t host=\"somehost.someotherplace.com\" port=\"9000\" /\u003e\n\n  \u003cutil:list id=\"splunkServersList\"\u003e\n    \u003cref bean=\"splunkServer\" /\u003e\n    \u003cref bean=\"splunkServerBackup\" /\u003e\n  \u003c/util:list\u003e\n\n  \u003cbean id=\"splunkServiceFactory\" class=\"org.springframework.integration.splunk.support.SplunkServiceFactory\"\u003e\n    \u003cconstructor-arg ref=\"splunkServersList\"/\u003e\n  \u003c/bean\u003e\n```\n\nAdditional server properties include (see [splunk](https://docs.splunk.com/Documentation/Splunk/latest) documentation for details):\n\n* app\n* scheme\n* scope\n* owner\n\nThe default host is *localhost* and the default port is *8089*. The *timeout* attribute indicates how long to wait for a connection in miliseconds.\n\n\nDevelopment\n-----------------\n### Build:\n\n\t./gradlew build\n\n### Import the project to Eclipse:\n\nTo generate Eclipse metadata (e.g., .classpath and .project files), do the following:\n\n\t./gradlew eclipse\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-integration-splunk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspring-projects%2Fspring-integration-splunk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspring-projects%2Fspring-integration-splunk/lists"}