{"id":28502022,"url":"https://github.com/fluent/fluent-plugin-splunk","last_synced_at":"2025-07-05T02:30:42.473Z","repository":{"id":32235657,"uuid":"83518984","full_name":"fluent/fluent-plugin-splunk","owner":"fluent","description":"Fluentd Plugin for Splunk","archived":false,"fork":false,"pushed_at":"2022-10-03T17:48:27.000Z","size":150,"stargazers_count":45,"open_issues_count":14,"forks_count":18,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-06-08T16:08:43.080Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/fluent.png","metadata":{"files":{"readme":"README.hec.md","changelog":"CHANGELOG.md","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":"2017-03-01T06:14:26.000Z","updated_at":"2025-04-07T20:47:56.000Z","dependencies_parsed_at":"2023-01-14T20:48:21.775Z","dependency_job_id":null,"html_url":"https://github.com/fluent/fluent-plugin-splunk","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/fluent/fluent-plugin-splunk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-splunk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-splunk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-splunk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-splunk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluent","download_url":"https://codeload.github.com/fluent/fluent-plugin-splunk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluent%2Ffluent-plugin-splunk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263671740,"owners_count":23494022,"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:08:46.999Z","updated_at":"2025-07-05T02:30:42.467Z","avatar_url":"https://github.com/fluent.png","language":"Ruby","readme":"# out_splunk_hec - Splunk HTTP Event Collector Output Plugin\n\n## Table of Contents\n\n* [Example Configuration](#example-configuration)\n* [Parameters](#parameters)\n   * [type (required)](#type-required)\n   * [host (required)](#host-required)\n   * [port (required)](#port-required)\n   * [token (required)](#token-required)\n   * [default_host](#default_host)\n   * [host_key](#host_key)\n   * [default_source](#default_source)\n   * [source_key](#source_key)\n   * [default_index](#default_index)\n   * [index_key](#index_key)\n   * [default_sourcetype](#default_sourcetype)\n   * [sourcetype](#sourcetype)\n   * [sourcetype_key](#sourcetype_key)\n   * [remove_sourcetype_key](#remove_sourcetype_key)\n   * [use_fluentd_time](#use_fluentd_time)\n   * [time_as_integer](#time_as_integer) \n   * [use_ack](#use_ack)\n   * [channel](#channel)\n   * [auto_generate_channel](#auto_generate_channel)\n   * [ack_interval](#ack_interval)\n   * [ack_retry_limit](#ack_retry_limit)\n   * [raw](#raw)\n   * [event_key](#event_key)\n   * [line_breaker](#line_breaker)\n   * [use_ssl](#use_ssl)\n   * [ssl_verify](#ssl_verify)\n   * [ca_file](#ca_file)\n   * [client_cert](#client_cert)\n   * [client_key](#client_key)\n   * [client_key_pass](#client_key_pass)\n\n## Example Configuration\n\n```\n\u003cmatch splunk.**\u003e\n  @type splunk_hec\n  host example.com\n  port 8089\n  token 00000000-0000-0000-0000-000000000000\n\n  # metadata parameter\n  default_source fluentd\n\n  # ack parameter\n  use_ack true\n  channel 8e69d7b3-f266-e9f3-2747-cc5b7f809897\n  ack_retry_limit 8\n\n  # ssl parameter\n  use_ssl true\n  ca_file /path/to/ca.pem\n\n  # buffered output parameter\n  flush_interval 10s\n\u003c/match\u003e\n```\n\n## Parameters\n\n### type (required)\n\nThe value must be `splunk_hec`.\n\n### host (required)\n\nThe Splunk hostname.\n\n### port (required)\n\nThe Splunk port.\n\n### token (required)\n\nThe token for HTTP Event Collector.\n\n### default_host\n\nIf you set this, the value is set as host metadata.\n\n### host_key\n\nIf you set this, the value associated with this key in each record is used as host metadata. When the key is missing, `default_host` is used.\n\n### remove_host_key\n\nIf you set this, the field specified by the `host_key` will be removed\n\n### default_source\n\nIf you set this, the value is set as source metadata.\n\n### source_key\n\nIf you set this, the value associated with this key in each record is used as source metadata. When the key is missing, `default_source` is used.\n\n### remove_source_key\n\nIf you set this, the field specified by the `source_key` will be removed\n\n### default_index\n\nIf you set this, the value is set as index metadata.\n\n### index_key\n\nIf you set this, the value associated with this key in each record is used as index metadata. When the key is missing, `default_index` is used.\n\n### remove_index_key\n\nIf you set this, the field specified by the `index_key` will be removed\n\n### default_sourcetype\n\nIf you set this, the value is set as sourcetype metadata if `sourcetype_key` is not set or not found in the record.\n\n### sourcetype\n\nDeprecated. Same as `default_sourcetype`, kept for backwards compability.\n\n### sourcetype_key\n\nIf you set this, the value associated with this key in each record is used as sourcetype metadata. When the key is missing, `default_sourcetype` is used.\n\n### remove_sourcetype_key\n\nIf you set this, the field specified by the `sourcetype_key` will be removed\n\n### use_fluentd_time\n\nThe default: `true`\n\nIf set true, fluentd's timestamp is used as time metadata. If the record already has its own time value, this options should be `false`.\n\n### time_as_integer\n\nThe default: `true`\n\nOnly used when `use_fluentd_time` is `true`. If set to `true` (default), time will be sent as integer seconds to Splunk, whereas if set to `false`, it will be sent with nano seconds.\n\n### use_ack\n\nEnable/Disable [Indexer acknowledgement](https://www.google.co.jp/search?q=splunk+http+ack\u0026oq=splunk+http+ack\u0026aqs=chrome..69i57j69i60l2.2725j0j9\u0026sourceid=chrome\u0026ie=UTF-8). When this is set `true`, `channel` parameter is required.\n\n### channel\n\nThis is used as [channel identifier](http://dev.splunk.com/view/event-collector/SP-CAAAE8X#aboutchannels).\n When you set `use_ack` or `raw`, this parameter is required.\n\n### auto_generate_channel\n The default: `false`\n\n This is used as auto generate channel, channel param is ignored if this param is set to true.\n\n### ack_interval\n\nThe default: `1`\n\nSpecify how many seconds the plugin should wait between checks for Indexer acknowledgement.\n\n### ack_retry_limit\n\nThe default: `3`\n\nSpecify how many times the plugin check Indexer acknowledgement.\n\n### raw\n\nEnable [raw mode](http://dev.splunk.com/view/event-collector/SP-CAAAE8Y#raw).\n\nOn raw mode, the plugin can't configure metadata at event level and time metadata. So `*_key` and `use_fluentd_time` parameters are ignored.\nWhen this is set `true`, `event_key` and `channel` parameter must also be set.\n\nExample:\n\n* configuration: `raw = true, event_key = \"log\"`\n* fluentd record: `1490924392 {\"foo\": \"bar\", \"log\": \"GET / HTTP/1.1 200\"}`\n* sent as: `GET / HTTP/1.1 200`\n\n### event_key\n\nOnly for raw mode. The value specified by this key is sent as an event.\nWhen `raw` is set to `true`, this parameter is required.\n\n* fluentd record: `1490924392 {\"log\": \"GET / HTTP/1.1 200\"}`\n* sent as: `GET / HTTP/1.1 200`\n\n### line_breaker\n\nThe default: `\"\\n\"`\n\nThe line breaker used when multiple records are sent at once.\n\n### use_ssl\n\nThe default: `false`\n\nUse SSL when connecting to Splunk.\n\n### ssl_verify\n\nThe default: `true`\n\nEnable/Disable SSL certificate verification.\n\n### ca_file\n\nThe path of CA file.\n\n### client_cert\n\nThe path of client certificate file.\n\n### client_key\n\nThe path of client key file\n\n### client_key_pass\n\nThe passphrase of client key.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluent%2Ffluent-plugin-splunk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffluent%2Ffluent-plugin-splunk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffluent%2Ffluent-plugin-splunk/lists"}