Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DataDog/datadog-api-client-ruby
https://github.com/DataDog/datadog-api-client-ruby
datadog datadog-api openapi ruby
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/DataDog/datadog-api-client-ruby
- Owner: DataDog
- License: apache-2.0
- Created: 2020-07-13T10:31:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T18:41:00.000Z (7 months ago)
- Last Synced: 2024-04-14T03:37:06.322Z (7 months ago)
- Topics: datadog, datadog-api, openapi, ruby
- Language: Ruby
- Homepage: https://datadoghq.dev/datadog-api-client-ruby/
- Size: 633 MB
- Stars: 30
- Watchers: 447
- Forks: 17
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# datadog-api-client-ruby
This repository contains a Ruby API client for the [Datadog API](https://docs.datadoghq.com/api/).
The code is generated using [`generator`](https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator) package.
## Requirements
Installing and using the API client library requires:
1. Ruby 2.6+
## Installation
The following steps will help you quickly start interacting with Datadog APIs using Ruby client.
### Install published Ruby gem
1. Add the `datadog_api_client` gem to you Gemfile:
```ruby
source 'https://rubygems.org'
gem 'datadog_api_client'
```
2. Install the gem with `bundle install`
3. (optional) You can configure site and [authentication](#authentication) using environment variables or code block:
```ruby
DatadogAPIClient.configure do |config|
config.server_variables[:site] = 'datadoghq.eu'
end
```
### Build a gem
1. Build the Ruby code into a gem:
```shell
gem build datadog_api_client.gemspec
```
2. Install the gem locally:
```shell
gem install ./datadog_api_client-*.gem
```
### Install from Git
1. Add the following in the Gemfile:
```ruby
gem 'datadog_api_client', :git => 'https://github.com/DataDog/datadog-api-client-ruby.git'
```
2. Install the gem with `bundle install`
### Include the Ruby code directly
1. Create `example.rb` script (find inspiration on https://docs.datadoghq.com/api/)
2. Include the Ruby code directly using `-I` as follows:
```shell
ruby -Ilib example.rb
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Ruby code:
```ruby
require 'datadog_api_client'
api_instance = DatadogAPIClient::V1::IPRangesAPI.new
begin
result = api_instance.get_ip_ranges
p result
rescue DatadogAPIClient::APIError => e
puts "Error when calling IPRangesAPI->get_ip_ranges: #{e}"
end
```
### Authentication
Authenticate with the API by providing your API and Application keys in the configuration:
```ruby
DatadogAPIClient.configure do |config|
config.api_key = ENV['NON_STANDARD_NAME_FOR_DD_API_KEY']
config.application_key = ENV['NON_STANDARD_NAME_FOR_DD_APP_KEY']
end
```
### Unstable (Beta) Endpoints
This client includes access to Datadog API endpoints while they are in an unstable state and may undergo breaking changes. An extra configuration step is required to enable these endpoints:
```ruby
DatadogAPIClient.configure do |config|
config.unstable_operations[:'.'] = true
end
```
where `` is the name of the method used to interact with that endpoint. For example: `list_log_indexes`, or `get_logs_index`
### Changing Server
When talking to a different server, like the `eu` instance, change the `server_variables` on your configuration object:
```ruby
config = DatadogAPIClient::Configuration.new
config.server_variables[:site] = "datadoghq.eu"
client = DatadogAPIClient::APIClient.new(config)
```
### Disable compressed payloads
If you want to disable GZIP compressed responses, set the `compress` flag
on your configuration object:
```ruby
config = DatadogAPIClient::Configuration.new
config.compress = false
client = DatadogAPIClient::APIClient.new(config)
```
### Enable requests logging
If you want to enable requests logging, set the `debugging` flag
on your configuration object:
```ruby
config = DatadogAPIClient::Configuration.new
config.debugging = true
client = DatadogAPIClient::APIClient.new(config)
```
### Configure proxy
You can configure the client to use proxy by setting `http_proxyaddr` and `http_proxyport` keys on configuration object:
```ruby
config = DatadogAPIClient::Configuration.new
config.http_proxyaddr = '127.0.0.1'
config.http_proxyport = '3128'
client = DatadogAPIClient::APIClient.new(config)
```
### Pagination
Several listing operations have a pagination method to help consume all the items available.
For example, to retrieve all your incidents:
```ruby
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations[:'v2.list_incidents'] = true
end
api_instance = DatadogAPIClient::V2::IncidentsAPI.new
api_instance.list_incidents_with_pagination() do |incident|
p incident.id
end
```
### Retry
To enable the client to retry when rate limited (status 429) or status 500 and above:
```ruby
config = DatadogAPIClient::Configuration.new
config.enable_retry = true
client = DatadogAPIClient::APIClient.new(config)
```
The interval between 2 retry attempts will be the value of the `x-ratelimit-reset` response header when available.
If not, it will be :
```ruby
(config.backoffMultiplier ** current_retry_count) * config.backoffBase
```
The maximum number of retry attempts is `3` by default and can be modified with
```ruby
config.maxRetries
```
## Documentation
If you are interested in general documentation for all public Datadog API endpoints, checkout the [general documentation site][api docs].
Developer documentation for supported endpoints and models is available in [Github pages][github pages].
For contributing, checkout the [development guide][development docs].
## Author
[api docs]: https://docs.datadoghq.com/api/
[github pages]: https://datadoghq.dev/datadog-api-client-ruby/
[development docs]: https://github.com/DataDog/datadog-api-client-ruby/blob/master/DEVELOPMENT.md