{"id":13696886,"url":"https://github.com/splunk/splunk-sdk-ruby","last_synced_at":"2026-01-11T06:52:30.011Z","repository":{"id":1871838,"uuid":"2797052","full_name":"splunk/splunk-sdk-ruby","owner":"splunk","description":"Splunk Software Development Kit for Ruby","archived":true,"fork":false,"pushed_at":"2018-01-25T22:48:54.000Z","size":1224,"stargazers_count":36,"open_issues_count":6,"forks_count":21,"subscribers_count":31,"default_branch":"master","last_synced_at":"2024-11-13T00:33:08.815Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://dev.splunk.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"VincentGarreau/particles.js","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splunk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-11-17T16:58:08.000Z","updated_at":"2023-01-28T20:43:38.000Z","dependencies_parsed_at":"2022-08-20T09:50:22.083Z","dependency_job_id":null,"html_url":"https://github.com/splunk/splunk-sdk-ruby","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-sdk-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-sdk-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-sdk-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-sdk-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splunk","download_url":"https://codeload.github.com/splunk/splunk-sdk-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252226866,"owners_count":21714886,"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-08-02T18:00:49.103Z","updated_at":"2025-05-03T17:32:28.965Z","avatar_url":"https://github.com/splunk.png","language":"Ruby","readme":"# The Splunk Software Development Kit for Ruby (Deprecated)\n\n#### Version 1.0.5\n\n\u003cblockquote\u003e\n\u003ch3\u003eDeprecation notice\u003c/h3\u003e\n\u003cp\u003eThe Splunk SDK for Ruby is deprecated.  \u003c/p\u003e\n\u003cp\u003eWhat deprecation means:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eOn June 1, 2017, the resources relating to the Splunk SDK for Ruby will be removed from dev.splunk.com and will only be available in the GitHub repository. \u003c/li\u003e\n\u003cli\u003eApps that use the Splunk SDK for Ruby will continue to work as they do now. \u003c/li\u003e\n\u003cli\u003eApps that use the Splunk SDK for Ruby will continue to be eligible for Splunk App Certification.\u003c/li\u003e\n\u003cli\u003eSplunk will no longer provide feature enhancements, engineering support, or customer support for the Splunk SDK for Ruby.\u003c/li\u003e\u003c/ul\u003e\n\u003cp\u003eRecommendation on new app development and app migration:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eBecause Splunk is no longer investing in the Splunk SDK for Ruby, we recommend that any new app development be done using other approaches:\u003cp\u003e\n\u003cul\u003e\u003cli\u003eDirectly using our REST API in the language of their choice.\u003c/li\u003e\n\u003cli\u003eUsing one of our supported SDKs: \n\u003cp\u003e\u003cul\u003e\u003cli\u003ePython (\u003ca href=\"https://github.com/splunk/splunk-sdk-python\"\u003eGitHub\u003c/a\u003e | \u003ca href=\"http://dev.splunk.com/view/python-sdk/SP-CAAAEBB\"\u003edev.splunk.com\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003eJava (\u003ca href=\"https://github.com/splunk/splunk-sdk-java\"\u003eGitHub\u003c/a\u003e | \u003ca href=\"http://dev.splunk.com/view/java-sdk/SP-CAAAECN\"\u003edev.splunk.com\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003eJavaScript (\u003ca href=\"https://github.com/splunk/splunk-sdk-javascript\"\u003eGitHub\u003c/a\u003e | \u003ca href=\"http://dev.splunk.com/view/javascript-sdk/SP-CAAAECM\"\u003edev.splunk.com\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003eC# (\u003ca href=\"https://github.com/splunk/splunk-sdk-csharp-pcl\"\u003eGitHub\u003c/a\u003e | \u003ca href=\"http://dev.splunk.com/view/csharp-sdk/SP-CAAAEPK\"\u003edev.splunk.com\u003c/a\u003e)\u003c/li\u003e\u003c/ul\u003e\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e\u003c/p\u003e\u003c/li\u003e\n\u003cli\u003eFor existing apps that use the Splunk SDK for Ruby, while not necessary, we request that developers begin the migration process away from the Splunk SDK for Ruby. We encourage developers to provide feedback to Splunk at \u003ca href=\"mailto:devinfo@splunk.com\"\u003edevinfo@splunk.com\u003c/a\u003e if there are any issues with migration. \u003c/li\u003e\u003c/ul\u003e\n\u003cp\u003eNotice of removal:\u003c/p\u003e\n\u003cul\u003e\u003cli\u003eThe Splunk SDK for Ruby will continue to be available on GitHub, should other developers want to clone or fork the project. \u003ca href=\"https://github.com/splunk/splunk-sdk-ruby/raw/master/docs.pdf\"\u003eDocumentation\u003c/a\u003e is located on GitHub as well.\u003c/li\u003e\u003c/ul\u003e\n\u003c/blockquote\u003e\n\nThis Splunk Software Development Kit (SDK) for Ruby contains library code and \nexamples designed to enable developers to build applications using Splunk.\n\nSplunk is a search engine and analytic environment that uses a distributed\nmap-reduce architecture to efficiently index, search, and process large \ntime-varying data sets.\n\nThe Splunk product is popular with system administrators for aggregation and\nmonitoring of IT machine data, security, compliance, and a wide variety of \nother scenarios that share a requirement to efficiently index, search, analyze,\nand generate real-time notifications from large volumes of time series data.\n\nThe Splunk developer platform enables developers to take advantage of the \nsame technology used by the Splunk product to build exciting new applications\nthat are enabled by Splunk's unique capabilities.\n\n## Getting started with the Splunk SDK for Ruby\n\nThe Splunk SDK for Ruby contains code and some examples that show how to\nprogrammatically interact with Splunk for a variety of scenarios, including\nsearching, saved searches, configuration, and many more. This SDK is still \nin progress and is missing features such as inputs. Stay tuned.\n\n\n### Requirements\n\nHere's what you need to get going with the Splunk SDK for Ruby.\n\n#### Splunk\n\nIf you haven't already installed Splunk, download it \n[here](http://www.splunk.com/download). For more information about installing \nand running Splunk and system requirements, see \n[Installing \u0026 Running Splunk](http://dev.splunk.com/view/SP-CAAADRV).\n\n#### Ruby\n\nThe Splunk SDK for Ruby has been tested with [Ruby 1.9.2 and Ruby 1.9.3](http://www.ruby-lang.org/). For best results, use one of those versions.\n\n#### Splunk SDK for Ruby\n\nGet the Splunk SDK for Ruby from [GitHub](https://www.github.com) and clone the\nresources to your computer. Use the following command:\n\n    git clone https://github.com/splunk/splunk-sdk-ruby.git    \n\nYou can also download the SDK as a ZIP file, or install it directly (see below). \n\n\n### Installing the Splunk SDK for Ruby\n\nIf you have cloned the Splunk SDK for Ruby from GitHub, you should first\ninstall the latest version of `rake`. For example, open a command prompt and \nenter the following:\n\n    gem install rake\n\nThen you can install the Splunk SDK for Ruby by running the following\ncommand from the root of the repository (**/splunk-sdk-ruby**):\n\n    rake install\n\nOr, install the Splunk SDK for Ruby directly from RubyGems,\nwithout cloning the repository or downloading the ZIP file, by running:\n\n    gem install splunk-sdk-ruby\n\nIf you are using the Splunk SDK for Ruby in an application, we highly\nrecommend that you use [bundler](http://gembundler.com/), which installs\nthe prerequisites when you deploy your application. Add the following \nline to your application's Gemfile to make bundler aware of the Splunk \nSDK for Ruby:\n\n    gem 'splunk-sdk-ruby'\n\nThen run the following command to install all of your application's\ndependencies, including the Splunk SDK for Ruby:\n\n    bundle\n\n#### Examples\n\nExamples are located in several locations within the Splunk SDK for Ruby:\n\n* The **/splunk-sdk-ruby/examples/** directory\n* Inline with the source code within the SDK\n* In the documentation on the [Splunk Developer Portal](http://dev.splunk.com/view/ruby-sdk/SP-CAAAENQ).\n\n#### Prepare for the unit tests\n\nFirst, do not run the test suite against your production Splunk server! Install\nanother copy of Splunk and run the test suite against that.\n\nSecond, update your installations of both the [Rake](http://rake.rubyforge.org) \nbuild tool and the [Test::Unit](http://test-unit.rubyforge.org) unit \ntest framework from RubyGems:\n\n    gem install rake\n    gem install test-unit\n\nThe test suite reads the host to connect to and credentials to use from a\n**.splunkrc** file. To connect to Splunk, all of the SDK examples and unit\ntests take command-line arguments that specify values for the host, port,\nand login credentials for Splunk. For convenience during development, you\ncan store these arguments as key-value pairs in a text file named \n**.splunkrc**. Then, when you don't specify these arguments at the command\nline, the SDK examples and unit tests use the values from the .splunkrc file.\n\n**To set up a .splunkrc file**\n\n1. Create a text file with the following format:\n\n    \u003cpre\u003e # Splunk host (default: localhost)\n    host=localhost\n    # Splunk admin port (default: 8089)\n    port=8089\n    # Splunk username\n    username=admin\n    # Splunk password\n    password=changeme\n    # Access scheme (default: https)\n    scheme=https\u003c/pre\u003e\n\n2. Save the file as .splunkrc in the current user's home directory.\n\n**On Mac OS X**\n\nSave the file as:\n\n    ~/.splunkrc\n\n**On Windows**\n\nSave the file as:\n\n    C:\\Users\\[currentusername]\\.splunkrc\n\nYou might get errors in Windows when you try to name the file because \n\".splunkrc\" looks like a nameless file with an extension. You can use \nthe command line to create this file; go to the \n**C:\\Users\\\\[currentusername]\\\\** directory and enter the following command:\n\n    Notepad.exe .splunkrc\n    \nClick **Yes**, then continue creating the file.\n\n**Notes**\n\n* Storing login credentials in the .splunkrc file is only for \n  convenience during development; this file isn't part of the \n  Splunk platform and shouldn't be used for storing user credentials\n  for production. And, if you're at all concerned about the security \n  of your credentials, just enter them at the command line and don't \n  bother using the .splunkrc file.\n* The format of the .splunkrc file has changed between releases. If \n  you are using a preview or beta version of the SDK, some of the \n  newer fields might not be recognized and you might see errors while\n  running the examples. You can either update to the latest version\n  of the SDK, or comment out the \u003ctt\u003eapp\u003c/tt\u003e, \u003ctt\u003eowner\u003c/tt\u003e, and \n  \u003ctt\u003eversion\u003c/tt\u003e fields.\n\n#### Run the unit tests\n\nIn the base directory where you installed the Splunk SDK for Ruby, run\n\n    rake test\n\nIt should run many tests without error.\n\nTo generate code coverage of the test suite, first ensure you've installed\nthe latest version of [SimpleCov](http://rubygems.org/gems/simplecov): \n\n    gem install simplecov\n\nTo generate the code coverage, run:\n\n    rake test COVERAGE=true\n\nIt will produce a directory called **coverage**. Open coverage/index.html to\nsee the coverage report.\n\n**Note**: To protect your Splunk password, you may want to delete the .splunkrc \nfile when you are done running the unit tests.\n\n## Repository\n\n\u003ctable\u003e\n\n\u003ctr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003e/examples\u003c/b\u003e\u003c/td\u003e\n\u003ctd\u003eExamples demonstrating various SDK features\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003e/lib\u003c/b\u003e\u003c/td\u003e\n\u003ctd\u003eSource for the Splunk library modules\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003e/test\u003c/b\u003e\u003c/td\u003e\n\u003ctd\u003eSource for unit tests\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n### Changelog\n\nThe **CHANGELOG.md** file in the root of the repository contains a description\nof changes for each version of the SDK. You can also find it online at\n[https://github.com/splunk/splunk-sdk-ruby/blob/master/CHANGELOG.md](https://github.com/splunk/splunk-sdk-ruby/blob/master/CHANGELOG.md).\n\n### Branches\n\nThe **master** branch always represents a stable and released version of the SDK.\n\n## Documentation and resources\n\nIf you need to know more: \n\n* For all things developer with Splunk, your main resource is the [Splunk Developer Portal](http://dev.splunk.com).\n\n* For conceptual and how-to documentation, see the [Overview of the Splunk SDK for Ruby](http://dev.splunk.com/view/SP-CAAAENQ).\n\n* For API reference documentation, see the [Splunk SDK for Ruby Reference](http://docs.splunk.com/Documentation/RubySDK).\n\n* For more about the Splunk REST API, see the [REST API Reference](http://docs.splunk.com/Documentation/Splunk/latest/RESTAPI).\n\n* For more about about Splunk in general, see [Splunk\u003eDocs](http://docs.splunk.com/Documentation/Splunk).\n\n* For more about this SDK's repository, see our [GitHub Wiki](https://github.com/splunk/splunk-sdk-ruby/wiki/).\n\n## Community\n\n\u003ctable\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003eEmail\u003c/b\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"mailto:devinfo@splunk.com\"\u003edevinfo@splunk.com\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eForum\u003c/strong\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"https://groups.google.com/forum/#!forum/splunkdev\"\u003ehttps://groups.google.com/forum/#!forum/splunkdev\u003c/a\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003eIssues\u003c/b\u003e\n\u003ctd\u003e\u003ca href=\"https://github.com/splunk/splunk-sdk-ruby/issues/\"\u003ehttps://github.com/splunk/splunk-sdk-ruby/issues/\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003eAnswers\u003c/b\u003e\n\u003ctd\u003e\u003ca href=\"http://splunk-base.splunk.com/tags/ruby/\"\u003ehttp://splunk-base.splunk.com/tags/ruby/\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003eBlog\u003c/b\u003e\n\u003ctd\u003e\u003ca href=\"http://blogs.splunk.com/dev/\"\u003ehttp://blogs.splunk.com/dev/\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\u003cb\u003eTwitter\u003c/b\u003e\n\u003ctd\u003e\u003ca href=\"http://twitter.com/#!/splunkdev\"\u003e@splunkdev\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n### How to contribute\n\nIf you would like to contribute to the SDK, go here for more information:\n\n* [Splunk and open source](http://dev.splunk.com/view/opensource/SP-CAAAEDM)\n\n* [Individual contributions](http://dev.splunk.com/goto/individualcontributions)\n\n* [Company contributions](http://dev.splunk.com/view/companycontributions/SP-CAAAEDR)\n\n### Support\n\nYou can find help through the broader community at \u003ca href='http://splunk-base.splunk.com/answers/'\u003eSplunk Answers\u003c/a\u003e (use the \u003cb\u003esdk\u003c/b\u003e and \u003cb\u003eruby\u003c/b\u003e tags to identify your questions).\n\n### Contact Us\n\nYou can reach the Dev Platform team at \u003ca href=\"mailto:devinfo@splunk.com\"\u003e\ndevinfo@splunk.com\u003c/a\u003e.\n\n## License\n\nThe Splunk Software Development Kit for Ruby is licensed under the Apache\nLicense 2.0. Details can be found in the LICENSE file.\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-sdk-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplunk%2Fsplunk-sdk-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-sdk-ruby/lists"}