Sumo Logic Ruby SDK

Gem Version Build Status Code Climate Scrutinizer Code Quality Docs MIT License

Ruby interface to the Sumo Logic REST API.

Usage

The interface for this SDK is still being built out to follow the structure in 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_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)

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.

Project Repo

Sumo Logic API Documentation

Sumo Logic 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.txt for details.

Sumo Logic Ruby SDK © 2015 by John Wang