grokify / sumologic-sdk-ruby

Sumo Logic SDK in Ruby

Sumo Logic Ruby SDK

Ruby interface to the Sumo Logic REST API.

Usage

The Ruby SDK is ported from the Sumo Logic Python SDK.

The following methods are currently implemented:

sumo = SumoLogic::Client.new access_id, access_key

# Search
r = sumo.search query [, from, to, time_zone]

r = sumo.search_job query [, from, to, time_zone]

r = sumo.search_job_messages {'id' => search_job_id}, limit, offset

r = sumo.search_job_records {'id' => search_job_id}, limit, offset

r = sumo.search_job_status {'id' => search_job_id}

# Dashboards
r = sumo.dashboards

r = sumo.dashboard dashboard_id

r = sumo.dashboard_data dashboard_id

# Collectors
r = sumo.collectors [limit, offset]

r = sumo.collector collector_id

r = sumo.update_collector collector, etag

r = sumo.delete_collector collector

# Sources
r = sumo.sources collector_id [, limit, offset]

r = sumo.source collector_id, source_id

r = sumo.update_source collector_id, source, etag

r = sumo.delete_source collector_id, source

# Content
r = sumo.create_content path, data

r = sumo.get_content path

r = sumo.delete_content path

# Low-Level
r = sumo.post path, data

Note, for the search methods, the query parameter can be exactly the same query that is entered into the Sumo Logic web console.

Example scripts are located in the scripts directory of the GitHub repo.

Change Log

See CHANGELOG.md.

Links

Project Repo

• https://github.com/grokify/sumologic-sdk-ruby

Sumo Logic API Documentation

• https://help.sumologic.com/APIs
• https://github.com/SumoLogic/sumo-api-doc/wiki

Sumo Logic Python SDK

• https://github.com/SumoLogic/sumologic-python-sdk

Contributions

Please add your scripts and programs to the scripts folder.

Any reports of problems, comments or suggestions are most welcome.

Please report these on Github

License

Sumo Logic Ruby SDK is available under an MIT-style license. See LICENSE.md for details.

Sumo Logic Ruby SDK © 2015-2023 by John Wang

sumologic-sdk-ruby's Issues

Add collector methods

Add methods for the following:

• collectors
• collector
• update_collector
• delete_collector

Add ability to follow redirects

Support redirects as Sumo Logic now has regional API hosts. A 301 redirect is encountered:

• Request: https://api.sumologic.com/api/v1/...
• New Location: https://api.us2.sumologic.com/api/v1/...

Currently the SDK can be instantiated with the following but it would be nice to auto-follow redirects:

sdk = SumoLogic::Client.new username, password, `https://api.us2.sumologic.com/api/v1`

Add content methods

Add methods for the following:

• create_content
• get_content
• delete_content

Add source methods

Add methods for the following:

• sources
• source
• update_source
• delete_source

Add accessor for Faraday client

Add Waffle.io project

Add Waffle.io via https://waffle.io/

• Waffle.io project
• GitHub shield