yabeda-datadog 0.3.2 → 0.3.6.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d19ca4de5083d19647d70c84ac48e8192c30107f704de5e884605184566878de
-  data.tar.gz: aad24d5f83a5431a47f561402bcbf1f0dc3671169b6e21d9b2fa3fce1dfbed09
+  metadata.gz: a82892703914a5bced4bd2b46116f60cb75c769a55f117cc075b1d052116b5f2
+  data.tar.gz: a5f010a0d3424e40edeff64b3a7d89f0cdb58536e394a015c3182428f1ca2b32
 SHA512:
-  metadata.gz: 9120fe159229915dd474c9f1dcda45b84874a6652e85c743b704590dcac6912a34d4e91cb519e322ab413645ede4f3642af8a37ce76c3066e5349103b02b2130
-  data.tar.gz: bc3b9ba60f41c04e621014dc6d808101846cad8e4274d63940a627c48e3a9e14dba27d217f1ff3d26ba643910ca7057f3b4587c645c9f8d0b28f7233d0b35a36
+  metadata.gz: c76169f5b4f78c5fa7ca28ebf079c1b6998932dd50e88135c85e0d06c58fece45f3c5034d943ecef4eaf208cc48df23546fc73432998d9f31fe05a860079dbcf
+  data.tar.gz: a7da62fda23e9b72487d1204cd86dbedf7f4142516fd05c9afd59dec54d9b3a79f9485e3d0801ac94156ebf74f2b760929ddbf76f4cd312c55612a2cccb69101

data/.datadog-agent.env.example

@@ -0,0 +1,8 @@
+DD_API_KEY=<your Datadog API key>
+DD_SITE=<your Datadog region site> # e.g. datadoghq.eu
+DD_DOGSTATSD_NON_LOCAL_TRAFFIC=true
+DD_HOSTNAME=development-computer
+DD_AC_EXCLUDE=image:.*
+DD_CONTAINER_EXCLUDE=image:.*
+DD_APM_ENABLED=false
+DD_LOGS_ENABLED=false

data/.github/workflows/build-release.yml

@@ -0,0 +1,82 @@
+name: Build and release gem to RubyGems
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch current tag as annotated. See https://github.com/actions/checkout/issues/290
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+      - name: "Extract data from tag: version, message, body"
+        id: tag
+        run: |
+          git fetch --tags --force # Really fetch annotated tag. See https://github.com/actions/checkout/issues/290#issuecomment-680260080
+          echo ::set-output name=version::${GITHUB_REF#refs/tags/v}
+          echo ::set-output name=subject::$(git for-each-ref $GITHUB_REF --format='%(contents:subject)')
+          BODY="$(git for-each-ref $GITHUB_REF --format='%(contents:body)')"
+          # Extract changelog entries between this and previous version headers
+          escaped_version=$(echo ${GITHUB_REF#refs/tags/v} | sed -e 's/[]\/$*.^[]/\\&/g')
+          changelog=$(awk "BEGIN{inrelease=0} /## ${escaped_version}/{inrelease=1;next} /## [0-9]+\.[0-9]+\.[0-9]+/{inrelease=0;exit} {if (inrelease) print}" CHANGELOG.md)
+          # Multiline body for release. See https://github.community/t/set-output-truncates-multiline-strings/16852/5
+          BODY="${BODY}"$'\n'"${changelog}"
+          BODY="${BODY//'%'/'%25'}"
+          BODY="${BODY//$'\n'/'%0A'}"
+          BODY="${BODY//$'\r'/'%0D'}"
+          echo "::set-output name=body::$BODY"
+          # Add pre-release option if tag name has any suffix after vMAJOR.MINOR.PATCH
+          if [[ ${GITHUB_REF#refs/tags/} =~ ^v[0-9]+\.[0-9]+\.[0-9]+.+ ]]; then
+            echo ::set-output name=prerelease::true
+          fi
+      - name: Build gem
+        run: gem build
+      - name: Calculate checksums
+        run: sha256sum yabeda-datadog-${{ steps.tag.outputs.version }}.gem > SHA256SUM
+      - name: Check version
+        run: ls -l yabeda-datadog-${{ steps.tag.outputs.version }}.gem
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ steps.tag.outputs.subject }}
+          body: ${{ steps.tag.outputs.body }}
+          draft: false
+          prerelease: ${{ steps.tag.outputs.prerelease }}
+      - name: Upload built gem as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: yabeda-datadog-${{ steps.tag.outputs.version }}.gem
+          asset_name: yabeda-datadog-${{ steps.tag.outputs.version }}.gem
+          asset_content_type: application/x-tar
+      - name: Upload checksums as release asset
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: SHA256SUM
+          asset_name: SHA256SUM
+          asset_content_type: text/plain
+      - name: Publish to GitHub packages
+        env:
+          GEM_HOST_API_KEY: Bearer ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gem push yabeda-datadog-${{ steps.tag.outputs.version }}.gem --host https://rubygems.pkg.github.com/${{ github.repository_owner }}
+      - name: Publish to RubyGems
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+        run: |
+          gem push yabeda-datadog-${{ steps.tag.outputs.version }}.gem

data/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Run tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'
+
+jobs:
+  test:
+    name: "Run tests"
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 3.0
+          - 2.7
+          - 2.6
+          - 2.5
+    container:
+      image: ruby:${{ matrix.ruby }}
+      env:
+        CI: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}-${{ hashFiles('**/Gemfile') }}
+            bundle-${{ matrix.ruby }}-
+      - name: Upgrade Bundler to 2.0 (for older Rubies)
+        run: gem install bundler -v '~> 2.0'
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install
+          bundle update
+      - name: Run RSpec
+        run: bundle exec rspec

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.3.6 - TBD
+
+### Fixed
+
+- Compatibility with dogstatsd v5
+
+## 0.3.5 - 2019-05-22
+
+### Fixed
+
+ - Relaxed anyway_config dependency constraint as there is no breaking changes in anyway_config 2.0. [@palkan]
+
+## 0.3.4 - 2019-03-12
+
+### Fixed
+
+ - Problem with Gemfile.lock introduced in 0.3.3. [@dmshvetsov]
+
+## 0.3.3 - 2019-03-12
+
+### Fixed
+
+ - Counters displayed with decimal values in Datadog dashboards. [@dmshvetsov], [#18](https://github.com/yabeda-rb/yabeda-datadog/pull/18)
+
+## 0.3.2 - 2019-02-14
+
+### Fixed
+
+ - Convert unit names from plural form to singular as Datadog accepts only singular names. [@dmshvetsov], [#16](https://github.com/yabeda-rb/yabeda-datadog/pull/16)
+
+## 0.3.1 - 2019-01-17
+
+### Fixed
+
+ - Relaxed Ruby version constraint. [@palkan], [#14](https://github.com/yabeda-rb/yabeda-datadog/pull/14)
+
+## 0.3.0 - 2019-01-11
+
+First known version by [@dmshvetsov] and [@Neyaz].
+
+[@palkan]: https://github.com/palkan "Vladimir Dementyev"
+[@dmshvetsov]: https://github.com/dmshvetsov "Dmitry Shvetsov"
+[@Neyaz]: https://github.com/Neyaz "Nikolay Malinin"

data/README.md

@@ -130,6 +130,38 @@ Please see [CONTRIBUTING guide](/CONTRIBUTING.md).
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/shvetsovdm/yabeda-datadog](https://github.com/shvetsovdm/yabeda-datadog).
 
+### Releasing
+
+1. Bump version number in `lib/yabeda/datadog/version.rb`
+
+   In case of pre-releases keep in mind [rubygems/rubygems#3086](https://github.com/rubygems/rubygems/issues/3086) and check version with command like `Gem::Version.new(Yabeda::Datadog::VERSION).to_s`
+
+2. Fill `CHANGELOG.md` with missing changes, add header with version and date.
+
+3. Make a commit:
+
+   ```sh
+   git add lib/yabeda/datadog/version.rb CHANGELOG.md
+   version=$(ruby -r ./lib/yabeda/datadog/version.rb -e "puts Gem::Version.new(Yabeda::Datadog::VERSION)")
+   git commit --message="${version}: " --edit
+   ```
+
+4. Create annotated tag:
+
+   ```sh
+   git tag v${version} --annotate --message="${version}: " --edit --sign
+   ```
+
+5. Fill version name into subject line and (optionally) some description (list of changes will be taken from changelog and appended automatically)
+
+6. Push it:
+
+   ```sh
+   git push --follow-tags
+   ```
+
+7. GitHub Actions will create a new release, build and push gem into RubyGems! You're done!
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/dev

@@ -2,10 +2,21 @@
 
 set -e
 
-docker run --rm \
-  --env-file .datadog-agent.env \
+echo "Starting datadog/agent docker container"
+
+ENV_FILE=".datadog-agent.env"
+
+if ! test -f "$ENV_FILE"; then
+    echo "$ENV_FILE does not exists."
+    echo "You can use $ENV_FILE.example to create $ENV_FILE file for datadog agent container."
+    exit 1
+fi
+
+docker run --name dd-agent \
+  --rm \
+  --env-file $ENV_FILE \
   -v /var/run/docker.sock:/var/run/docker.sock:ro \
   -v /proc/:/host/proc/:ro \
   -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro \
   -p 8125:8125/udp \
-  datadog/agent:latest
+  gcr.io/datadoghq/agent:7

data/examples/script.rb

@@ -22,19 +22,22 @@ yabeda_datadog = Yabeda::Datadog.start
 #
 
 Yabeda.configure do
-  group :yabeda_datadog_gem_examples_script
-  counter :run_count, comment: "The total number of times the script was executed", unit: "time"
-  gauge :run_time, comment: "Script execution time", unit: "second"
-  histogram :rand_num, comment: "Random number", buckets: [0, 20, 40, 60, 80, 100]
+  group :yabeda_datadog_gem_examples_script do
+    counter :run_count, comment: "The total number of times the script was executed", unit: "time"
+    gauge :run_time, comment: "Script execution time", unit: "second"
+    histogram :rand_num, comment: "Random number", buckets: [0, 20, 40, 60, 80, 100]
+  end
 end
 
+Yabeda.configure!
+
 start_time = Time.now
-Yabeda.yabeda_datadog_gem_examples_script_run_count.increment(host: "dev_machine")
-Yabeda.yabeda_datadog_gem_examples_script_rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
-Yabeda.yabeda_datadog_gem_examples_script_rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
-Yabeda.yabeda_datadog_gem_examples_script_rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
+Yabeda.yabeda_datadog_gem_examples_script.run_count.increment({ host: "dev_machine" }, by: 1)
+Yabeda.yabeda_datadog_gem_examples_script.rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
+Yabeda.yabeda_datadog_gem_examples_script.rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
+Yabeda.yabeda_datadog_gem_examples_script.rand_num.measure({ host: "dev_machine", rand: true }, rand(100))
 finish_time = Time.now
-Yabeda.yabeda_datadog_gem_examples_script_run_time.set({ host: "dev_machine" }, finish_time - start_time)
+Yabeda.yabeda_datadog_gem_examples_script.run_time.set({ host: "dev_machine" }, finish_time - start_time)
 
 puts "Type exit for exit the script" until gets.chomp =~ /^exit$/i
 puts "Stoping Yabeda::Datadog, please wait ..."

data/lib/yabeda/datadog/adapter.rb

@@ -19,7 +19,7 @@ module Yabeda
       end
 
       def register_counter!(counter)
-        enqueue_register(Metric.new(counter, "count"))
+        enqueue_register(Metric.new(counter, "rate"))
       end
 
       def perform_counter_increment!(counter, tags, increment)

data/lib/yabeda/datadog/metric.rb

@@ -6,6 +6,9 @@ module Yabeda
   module Datadog
     # = Internal adapter representation of metrics
     class Metric
+      SECOND = 1
+      DEFAULT_FLUSH_INTERVAL = SECOND * 10
+
       def initialize(metric, type, overides = {})
         @metric = metric
         @type = type
@@ -22,6 +25,7 @@ module Yabeda
           short_name: name,
           unit: unit,
           per_unit: per_unit,
+          statsd_interval: statsd_interval,
         }
       end
 
@@ -45,6 +49,11 @@ module Yabeda
         overides.fetch(:per_unit, Unit.find(metric.per))
       end
 
+      # Datadog API argument
+      def statsd_interval
+        DEFAULT_FLUSH_INTERVAL if type == "rate"
+      end
+
       # Update metric metadata
       def update(api)
         api.update_metadata(name, metadata)

data/lib/yabeda/datadog/version.rb

@@ -2,6 +2,6 @@
 
 module Yabeda
   module Datadog
-    VERSION = "0.3.2"
+    VERSION = "0.3.6.rc1"
   end
 end

data/lib/yabeda/datadog/worker/send.rb

@@ -4,24 +4,29 @@ module Yabeda
   module Datadog
     class Worker
       SEND = proc do |accumulated_payload|
-        dogstatsd = ::Datadog::Statsd.new(
-          Yabeda::Datadog.config.agent_host,
-          Yabeda::Datadog.config.agent_port,
-        )
-
-        Logging.instance.debug("sending batch of #{accumulated_payload.size} metrics")
         begin
-          dogstatsd.batch do |stats|
-            accumulated_payload.each do |payload|
-              metric = payload.fetch(:metric)
-              value = payload.fetch(:value)
-              tags = payload.fetch(:tags)
+          dogstatsd = ::Datadog::Statsd.new(
+            Yabeda::Datadog.config.agent_host,
+            Yabeda::Datadog.config.agent_port,
+            single_thread: true,
+          )
+
+          Logging.instance.debug("sending batch of #{accumulated_payload.size} metrics")
+          begin
+            dogstatsd.batch do |stats|
+              accumulated_payload.each do |payload|
+                metric = payload.fetch(:metric)
+                value = payload.fetch(:value)
+                tags = payload.fetch(:tags)
 
-              stats.send(metric.type, metric.name, value, tags: tags)
+                stats.send(metric.type, metric.name, value, tags: tags)
+              end
             end
+          rescue StandardError => err
+            Logging.instance.error("metric sending failed: #{err.message}")
           end
-        rescue StandardError => err
-          Logging.instance.error("metric sending failed: #{err.message}")
+        ensure
+          dogstatsd.close
         end
       end
     end

data/yabeda-datadog.gemspec

@@ -29,13 +29,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "anyway_config", "~> 1.0"
+  spec.add_dependency "anyway_config", ">= 1.0"
   spec.add_dependency "dogapi"
-  spec.add_dependency "dogstatsd-ruby"
+  spec.add_dependency "dogstatsd-ruby", "~> 5.2"
   spec.add_dependency "yabeda"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "pry", "~> 0.12.2"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.13"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: yabeda-datadog
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.6.rc1
 platform: ruby
 authors:
 - Dmitry Shvetsov <@shvetsovdm>
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-13 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -42,16 +42,16 @@ dependencies:
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: yabeda
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -124,20 +124,22 @@ dependencies:
         version: '3.0'
 description: 'Adapter for reporting custom metrics from Yabeda to DataDog.
 
-'
+  '
 email:
 - shvetsovdm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".datadog-agent.env.example"
+- ".github/workflows/build-release.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -176,11 +178,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: DataDog adapter for reporting metrics from Yabeda suite

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.6.0
-  - 2.5.3
-  - 2.4.2
-  - 2.3.0

data/Gemfile.lock

@@ -1,55 +0,0 @@
-PATH
-  remote: .
-  specs:
-    yabeda-datadog (0.3.2)
-      anyway_config (~> 1.0)
-      dogapi
-      dogstatsd-ruby
-      yabeda
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    anyway_config (1.4.4)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    dogapi (1.33.0)
-      multi_json
-    dogstatsd-ruby (4.0.0)
-    dry-initializer (2.5.0)
-    method_source (0.9.2)
-    multi_json (1.13.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    yabeda (0.1.3)
-      concurrent-ruby
-      dry-initializer
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  pry (~> 0.12.2)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  yabeda-datadog!
-
-BUNDLED WITH
-   1.17.3