dogapi 1.37.1 → 1.42.0

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changes
 
+## 1.42.0 / 2020-09-17
+
+* [Added] Allow dashboard creation / updates using Template Variable Presets. See [#238](https://github.com/DataDog/dogapi-rb/pull/238).
+
+## 1.41.0 / 2020-07-27
+
+* [Added] Improve user-agent header to include telemetry information. See [#235](https://github.com/DataDog/dogapi-rb/pull/235).
+* [Added] Move setting hostname to end of method body in order to actually return it. See [#233](https://github.com/DataDog/dogapi-rb/pull/233).
+
+## 1.40.0 / 2020-04-06
+
+* [Added] Re-add service level objectives support. See [#224](https://github.com/DataDog/dogapi-rb/pull/224).
+
+## 1.39.0 / 2020-02-04
+
+* [Added] Allow Setting Proxy without Using HTTP_PROXY, etc.. See [#180](https://github.com/DataDog/dogapi-rb/pull/180). Thanks [KingAlex42](https://github.com/KingAlex42).
+* [Added] [capistrano] Add ability to use `etc.getpwuid` instead of `etc.getlogin` to get the user name. See [#146](https://github.com/DataDog/dogapi-rb/pull/146). Thanks [rkul](https://github.com/rkul).
+* [Fixed] Check exit code of `hostname -f` for failures. See [#219](https://github.com/DataDog/dogapi-rb/pull/219).
+* [Added] Add `validate_tags` util to check that `tags` is an array of strings. See [#218](https://github.com/DataDog/dogapi-rb/pull/218).
+* [Added] Added function to deal with redirection of HTTP requests. See [#200](https://github.com/DataDog/dogapi-rb/pull/200).
+* [Added] Add Synthetics support. See [#210](https://github.com/DataDog/dogapi-rb/pull/210).
+* [Added] Add dashboard read_only option. See [#135](https://github.com/DataDog/dogapi-rb/pull/135). Thanks [tjoyal](https://github.com/tjoyal).
+* [Added] Add options for force delete monitors. See [#213](https://github.com/DataDog/dogapi-rb/pull/213).
+
+## 1.38.0 / 2019-12-13
+
+* [BUGFIX] Fix setting keys in both query params and headers. See [#194][]
+* [BUGFIX] Fix `cancel_downtime_by_scope` method by setting `send_json` to `true`. See [#205][]
+* [FEATURE] Add Azure, GCP, AWS, and AWS Logs integration support. See [#201][]
+* [FEATURE] Add support for new `Monitor.can_delete` endpoint. See [#195][]
+* [FEATURE] Add `options` to the `get_downtime` endpoint. See [#206][]
+
 ## 1.37.1 / 2019-11-04
 
 * [BUGFIX] Revert the Service Level Objective feature to remove an issue with older versions of Ruby < 2.0. See [#198][]
@@ -261,7 +293,12 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#188]: https://github.com/DataDog/dogapi-rb/issues/188
 [#189]: https://github.com/DataDog/dogapi-rb/issues/189
 [#192]: https://github.com/DataDog/dogapi-rb/issues/192
+[#194]: https://github.com/DataDog/dogapi-rb/issues/194
+[#195]: https://github.com/DataDog/dogapi-rb/issues/195
 [#198]: https://github.com/DataDog/dogapi-rb/issues/198
+[#201]: https://github.com/DataDog/dogapi-rb/issues/201
+[#205]: https://github.com/DataDog/dogapi-rb/issues/205
+[#206]: https://github.com/DataDog/dogapi-rb/issues/206
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@TaylURRE]: https://github.com/TaylURRE

data/CONTRIBUTING.md

@@ -0,0 +1,111 @@
+# How to contribute
+
+First of all, thanks for contributing!
+
+This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a PR.
+
+## Reporting a Bug - Requesting a feature - Github Issues
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues][1].
+* If you're unable to find an open issue addressing the problem, [open a new one][2]. 
+  - **Fill out the issue template completely**. Label the issue properly.
+    - Add `severity/` label.
+    - Add `documentation` label if this issue is related to documentation changes.
+* If you have a feature request, it is encouraged to [contact support][3] so the request can be prioritized and properly tracked.
+* **Do not open an issue if you have a question**, instead [contact support][3].
+
+## Suggesting an enhancements - Pull Requests
+
+Have you fixed an issue? Many thanks!
+
+Read the [development guide][/DEVELOPMENT.md] for more information on how to get started.
+
+In order to ease/speed up our review, here are some items you can check/improve when submitting your PR:
+* **Ensure an [Issue has been created](#reporting)**. 
+* Avoid changing too many things at once.
+  - Make sure that your Pull Requests only fixes one Issue at the time.
+* **Write tests** for the code you wrote.
+* Make sure that **all tests pass locally**.
+* Summarize your PR with a **meaningful title** and **fill out the pull request description template completely!**
+* Add the most suitable changelog label choosing one of the following:
+  * `changelog/Added` for new features.
+  * `changelog/Changed` for changes in existing functionality.
+  * `changelog/Deprecated` for soon-to-be removed features.
+  * `changelog/Removed` for now removed features.
+  * `changelog/Fixed` for any bug fixes.
+  * `changelog/Security` in case of vulnerabilities.
+  * `changelog/no-changelog` in case this PR should not appear in the changelog at all.
+
+See [here][4] for more details about changelogs.
+
+Your pull request must pass all CI tests before. If you're seeing
+an error and don't think it's your fault, it may not be! [Join us on Slack][5] or send us an email, and together we'll 
+get it sorted out.
+
+### Keep it small, focused
+
+Avoid changing too many things at once. For instance if you're fixing two different
+issues at once, it makes reviewing harder and the _time-to-release_ longer.
+
+### Pull Request title
+
+Unless the PR is marked with the proper exclusion label, the title will be used
+to automatically fill the changelog entries. For this reason the title must be
+concise but explanatory.
+
+### Commit Messages
+
+Please don't be this person: `git commit -m "Fixed stuff"`. Take a moment to
+write meaningful commit messages.
+
+The commit message should describe the reason for the change and give extra details
+that will allow someone later on to understand in 5 seconds the thing you've been
+working on for a day.
+
+### Releasing
+
+The release procedure is managed by Datadog, instructions can be found in the [RELEASING](/RELEASING.md) document.
+
+## Asking a questions
+
+Need help? Contact [Datadog support][3]
+
+## Additional Notes
+
+### Issue and Pull Request Labels
+
+This section lists the labels we use to help us track and manage issues and pull requests.
+
+| Label name                    | Usage                    | Description 
+|-------------------------------|--------------------------|------------------------------------------------------------
+| `backward-incompatible`       | Issues and Pull Requests | Warn for backward incompatible changes. 
+| `changelog/Added`             | Pull Request Only        | Added features results into a minor version bump.
+| `changelog/Changed`           | Pull Request Only        | Changed features results into a major version bump.
+| `changelog/Deprecated`        | Pull Request Only        | Deprecated features results into a major version bump.
+| `changelog/Fixed`             | Pull Request Only        | Fixed features results into a bug fix version bump.
+| `changelog/no-changelog`      | Pull Request Only        | Changes don't appear in changelog.
+| `changelog/Removed`           | Pull Request Only        | Deprecated features results into a major version bump.
+| `changelog/Security`          | Pull Request Only        | Fixed features results into a bug fix version bump.
+| `community/help-wanted`       | Issue Only               | Community help wanted.
+| `community`                   | Issues and Pull Requests | Community driven changes.
+| `dev/testing`                 | Issues and Pull Requests | Tests related changes.
+| `dev/tooling`                 | Issues and Pull Requests | Tooling related changes.
+| `do-not-merge/HOLD`           | Pull Request Only        | Do not merge this PR.
+| `do-not-merge/WIP`            | Pull Request Only        | Do not merge this PR.
+| `documentation`               | Issues and Pull Requests | Documentation related changes.
+| `duplicate`                   | Issue Only               | Duplicate issue.
+| `invalid`                     | Issue Only               | Invalid issue.
+| `kind/bug`                    | Issue Only               | Bug related issue.
+| `kind/feature-request`        | Issue Only               | Feature request related issue.
+| `severity/critical`           | Issue Only               | Critical severity issue.
+| `severity/major`              | Issue Only               | Major severity issue.
+| `severity/minor`              | Issue Only               | Minor severity issue.
+| `severity/normal`             | Issue Only               | Normal severity issue.
+| `stale`                       | Issues and Pull Requests | Stale - Bot reminder.
+| `stale/exempt`                | Issues and Pull Requests | Exempt from being marked as stale.
+
+[1]: https://github.com/DataDog/dogapi-rb/issues
+[2]: https://github.com/DataDog/dogapi-rb/issues/new
+[3]: https://docs.datadoghq.com/help
+[4]: https://keepachangelog.com/en/1.0.0
+[5]: https://datadoghq.slack.com

data/DEVELOPMENT.md

@@ -0,0 +1,11 @@
+# Development
+
+The API implementation is located in the [`lib/dogapi`](lib/dogapi) folder.
+
+## Testing
+
+Test files are located in the [`spec`](spec) folder.
+
+## Coding conventions
+
+This project uses rubocop for linting.

data/Gemfile

@@ -4,6 +4,8 @@ gemspec
 
 group :test do
   gem 'rubocop', "~> 0.49.0"
+  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
+  # and neither our users nor our CI is vulnerable in any way
   gem 'rake', '>= 2.4.2'
   gem 'rspec'
   gem 'simplecov'

data/Gemfile_1.9

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rubocop', "~> 0.41.0"
+  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
+  # and neither our users nor our CI is vulnerable in any way
+  gem 'rake', '>= 2.4.2'
+  gem 'rspec'
+  gem 'simplecov', "~> 0.11.2"
+  gem 'webmock'
+end

data/LICENSE

@@ -1,25 +1,26 @@
-Copyright (c) 2011, Datadog <info@datadoghq.com>
-All rights reserved.
+Copyright (c) 2011-Present, Datadog <opensource@datadoghq.com>
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of the Datadog nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL DATADOG BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE-3rdparty.csv

@@ -0,0 +1,6 @@
+Component,Origin,License,Copyright
+gemfile, rubocop, MIT, Copyright (c) 2012-19 Bozhidar Batsov
+gemfile, rake, MIT, Copyright (c) Jim Weirich
+gemfile, rspec, MIT, Copyright © 2009 Chad Humphries David Chelimsky Copyright © 2006 David Chelimsky The RSpec Development Team Copyright © 2005 Steven Baker
+gemfile, simplecov, MIT, Copyright (c) 2010-2017 Christoph Olszowka
+gemfile, webmock, MIT, Copyright (c) 2009-2010 Bartosz Blimke

data/README.rdoc

@@ -36,6 +36,13 @@ If you get a LoadError, missing mkmf, you need to install the development packag
 
 = Usage
 
+== Supported Versions
+
+This project currently works with Ruby versions 1.9.3+
+
+*Note* Newer features and new endpoint support may no longer support EOL Ruby versions but
+the client should still intialize and allow metric/event submission.
+
 == How to find your API and application keys
 
 Go to your setup page[https://app.datadoghq.com/account/settings].
@@ -147,6 +154,13 @@ data point you will need to pass a list of +Time+, +float+ pairs, instead of a s
 
     dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device")
 
+If you want to specify the metric type, using the example above you can pass in a symbol key with :type and a value of a metric type such as counter, gauge or rate. 
+
+    dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device", :type => 'counter' )
+
+If you want to add metric tags, using the example above you can pass in a symbol key with :tags and an array of tags.
+
+    dog.emit_points('some.metric.name', [[t1, val1], [t2, val2], [t3, val3]], :host => "my_host", :device => "my_device", :tags => ['frontend', 'app:webserver'] )
 
 == Get points from a Datadog metric
 

data/RELEASING.md

@@ -0,0 +1,46 @@
+# Releasing
+This document summarizes the process of doing a new release of this project.
+Release can only be performed by Datadog maintainers of this repository.
+
+## Schedule
+This project does not have a strict release schedule. However, we would make a release at least every 2 months.
+  - No release will be done if no changes got merged to the `master` branch during the above mentioned window.
+  - Releases may be done more frequently than the above mentioned window.
+
+## Prerelease checklist
+* Check and upgrade dependencies where it applies and makes sense.
+  - Create a distinct pull request and test your changes since it may introduce regressions.
+  - While using the latest versions of dependencies is advised, it may not always be possible due to potential compatibility issues.
+  - Upgraded dependencies should be thoroughly considered and tested to ensure they are safe!
+* Make sure tests are passing.
+  - Locally and in the continuous integration system.
+* Manually test changes included in the new release.
+* Make sure documentation is up-to-date.
+
+## Release Process
+### Prerequisite
+Install [bundler](https://bundler.io/) and setup your RubyGems credentials:
+1. Register an account on https://rubygems.org/
+1. *Datadog Admins only* - Be assigned to Datadog's RubyGems gems by an owner.
+1. Set a `~/.gem/credentials` file as the following:
+```
+---
+:rubygems_api_key: $RUBYGEMS_APIKEY
+```
+1. Install [datadog_checks_dev](https://datadog-checks-base.readthedocs.io/en/latest/datadog_checks_dev.cli.html#installation) using Python 3.
+
+### Update Changelog
+#### Commands
+- See changes ready for release by running `ddev release show changes .` at the root of this project. Add any missing labels to PRs if needed.
+- Run `ddev release changelog . <NEW_VERSION>` to update the `CHANGELOG.md` file at the root of this repository
+- Commit the changes to the repository in a release branch. Do not merge yet.
+
+### Release
+1. Update the gem version number in `lib/dogapi/version.rb`, push it to your changelog PR. 
+1. Merge the PR to master.
+1. Create the release in the [Github releases page](https://github.com/DataDog/dogapi-rb/releases).
+1. Checkout the tag created at the previous step.
+1. Build the gem: `bundle exec gem build dogapi.gemspec`.
+1. Push the gem: `bundle exec gem push dogapi-x.x.x.gem`.
+1. Check that the [Ruby Gem is published](https://rubygems.org/gems/dogapi).
+1. Bump the version again in `lib/dogapi/version.rb` to a dev version (e.g. `1.39.0` -> `1.40.0.dev`), open a PR and merge it to master.

data/SUPPORT.md

@@ -0,0 +1,9 @@
+# Support
+
+The issue queue we have here on GitHub is primarily intended for tracking features,
+bugs and work items associated with this Datadog open source project.
+
+For any other support request, please reach out through one of the following:
+
+ * Contact our [support](https://docs.datadoghq.com/help/)
+ * Join us [on Slack](http://datadoghq.slack.com)

data/dogapi.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'multi_json'
 
   spec.add_development_dependency 'bundler', '>= 1.3'
+  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
+  # and neither our users nor our CI is vulnerable in any way
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'rdoc'
 end

data/examples/custom_metric.rb

@@ -31,5 +31,5 @@ dog.emit_points('test.api.test_metric', points)
 # Emit differents metrics in a single request to be more efficient
 dog.batch_metrics do
   dog.emit_point('test.api.test_metric',10)
-  dog.emit_point('test.api.this_other_metric', 1, :type => 'counter')
+  dog.emit_point('test.api.this_other_metric', 1, :type => 'count')
 end

data/lib/capistrano/README.md

@@ -18,7 +18,10 @@ To set up your Capfile:
     # for instance, only push the production event
     # set :datadog_event_filter, proc { |event, hosts| event.msg_title.include?('ran production') ? [event, hosts] : nil }
 
+    # (optional) use the `Etc.getlogin` method (default) or the `Etc.getpwuid` method to get the user name
+    # default: use `Etc.getlogin`
+    # set :use_getlogin, true
+
 You can find your Datadog API key [here](https://app.datadoghq.com/account/settings#api). If you don't have a Datadog account, you can sign up for one [here](http://www.datadoghq.com/).
 
 `capistrano/datadog` will capture each Capistrano task that that Capfile runs, including the roles that the task applies to and any logging output that it emits and submits them as events to Datadog at the end of the execution of all the tasks. If sending to Datadog fails for any reason, your scripts will still succeed.
-

data/lib/capistrano/datadog.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'etc'
 require 'digest/md5'
 require 'timeout'
@@ -24,11 +28,11 @@ module Capistrano
       @cap_version
     end
 
-    def self.submit(api_key)
+    def self.submit(api_key, use_getlogin=true)
       begin
         if api_key
           dog = Dogapi::Client.new(api_key)
-          reporter.report.each do |event, hosts|
+          reporter.report(use_getlogin).each do |event, hosts|
             if hosts.size > 0
               hosts.each do |host|
                 dog.emit_event event, host: host
@@ -89,9 +93,9 @@ module Capistrano
         end
       end
 
-      def report()
+      def report(use_getlogin=true)
         hostname = Dogapi.find_localhost
-        user = Etc.getlogin
+        user = use_getlogin ? Etc.getlogin : Etc.getpwuid.name
 
         # Lazy randomness
         aggregation_key = Digest::MD5.hexdigest "#{Time.new}|#{rand}"

data/lib/capistrano/datadog/v2.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'benchmark'
 require 'delegate'
 
@@ -58,7 +62,11 @@ module Capistrano
       namespace :datadog do
         desc 'Submit the tasks that have run to Datadog as events'
         task :submit do |ns|
-          Capistrano::Datadog.submit variables[:datadog_api_key]
+          if variables[:use_getlogin].nil?
+            Capistrano::Datadog.submit variables[:datadog_api_key]
+          else
+            Capistrano::Datadog.submit variables[:datadog_api_key], variables[:use_getlogin]
+          end
         end
       end
     end

data/lib/capistrano/datadog/v3.rb

@@ -1,3 +1,7 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
 require 'benchmark'
 require 'delegate'
 require 'sshkit/formatters/pretty'
@@ -76,5 +80,10 @@ end
 
 at_exit do
   api_key = Capistrano::Configuration.env.fetch :datadog_api_key
-  Capistrano::Datadog.submit api_key
+  use_getlogin = Capistrano::Configuration.env.fetch :use_getlogin
+  if use_getlogin.nil?
+    Capistrano::Datadog.submit api_key
+  else
+    Capistrano::Datadog.submit api_key, use_getlogin
+  end
 end