sensu-plugins-gitlab 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0f61944b6812d7ad611fcdfd0d089b97112a433
+  data.tar.gz: 7b68f6c565d7fc6edc2f78df1cd557ecbac25894
+SHA512:
+  metadata.gz: 0cefa69fd900e91b00ecb2f91d92ffccdc7cdc62f523aa9c0a5c015c20054cbb6428174c3f27e4fc5092f372c1d8ca003af07f3a678d9e7b3b78b3ca77e350a4
+  data.tar.gz: bf3e2a63950e5355d45515e75ebf808d9850750c2e103c8a0cc51485d67b6736f92f01ede2721291b8f38d8418a3872616d16067465886312bd4983f5352060e

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format located [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
+## [Unreleased]
+
+## [0.0.1] - 2018-04-02
+### Breaking Changes
+- Dropped `ruby 2.1` support (@yuri-zubov sponsored by Actility, https://www.actility.com)
+- Added `rest-client` as a dependency which requires you to have a local c compiler present to install this plugin (@yuri-zubov sponsored by Actility, https://www.actility.com)
+- bumped dependency of `sensu-plugin` to 2.x you can read about it [here](https://github.com/sensu-plugins/sensu-plugin/blob/master/CHANGELOG.md#v200---2017-03-29) (@majormoses)
+- dropped ruby 2.0 support (@majormoses)
+
+### Security
+- updated `yard` dependency to `~> 0.9.11` per: https://nvd.nist.gov/vuln/detail/CVE-2017-17042 which closes attacks against a yard server loading arbitrary files (@majormoses)
+
+### Added
+- Added health-check for gitlab (@yuri-zubov sponsored by Actility, https://www.actility.com)
+- Added basic metrics from gitlab (@yuri-zubov sponsored by Actility, https://www.actility.com)
+- Basic Skel to be used to make new plugin repo setup easier.
+- PR template
+- Rubocop config
+- basic testing setup
+
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-skel/compare/0.0.1...HEAD
+[0.0.1]: https://github.com/sensu-plugins/sensu-plugins-skel/compare/0b2d68b64a3d100c10da5e4cfce42206b9f22250...0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sensu Community Plugins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,21 @@
+## Sensu-Plugins-gitlab
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-gitlab.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-gitlab)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-gitlab.svg)](http://badge.fury.io/rb/sensu-plugins-gitlab)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-gitlab.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-gitlab)
+[![Community Slack](https://slack.sensu.io/badge.svg)](https://slack.sensu.io/badge)
+
+## Functionality
+
+## Files
+
+- `bin/check-health-gitlab.rb`
+- `bin/metrics-gitlab.rb`
+
+## Usage
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes

data/bin/check-health-gitlab.rb

@@ -0,0 +1,69 @@
+#! /usr/bin/env ruby
+#
+#   check-health-gitlab
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   plain-text
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris, etc
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Yuri Zubov  <yury.zubau@gmail.com> sponsored by Actility, https://www.actility.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'rest-client'
+require 'json'
+
+class CheckHealthGitlab < Sensu::Plugin::Check::CLI
+  option :endpoint,
+         description: 'Github ENDPOINT',
+         short: '-E ENDPOINT',
+         long: '--endpoint ENDPOINT',
+         default: 'http://localhost/-/liveness'
+
+  option :token,
+         description: 'TOKEN_API',
+         short: '-t TOKEN_API',
+         long: '--token TOKEN_API'
+
+  def request
+    RestClient::Request.execute(
+      method: :get,
+      url: config[:endpoint],
+      headers: { params: { token: config[:token] } }
+    )
+  end
+
+  def check_health
+    response = request
+
+    JSON.parse(response)
+  end
+
+  def run
+    result = check_health
+    bad_health = result.reject { |_k, v| v['status'] == 'ok' }.reduce('') { |_result, (k, v)| "#{k}:#{v['status']}" }
+
+    if bad_health.empty?
+      ok 'Gitlab is ok'
+    else
+      warning "Gitlab is not good #{bad_health}"
+    end
+  rescue StandardError => e
+    critical e.message
+  end
+end

data/bin/metrics-gitlab.rb

@@ -0,0 +1,170 @@
+#! /usr/bin/env ruby
+#
+#   metrics-gitlab
+#
+# DESCRIPTION:
+#
+# OUTPUT:
+#   plain text, metric data, etc
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris, etc
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: gitlab
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Yuri Zubov  <yury.zubau@gmail.com> sponsored by Actility, https://www.actility.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'gitlab'
+
+class GitlabGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :endpoint,
+         description: 'Github ENDPOINT',
+         short: '-E ENDPOINT',
+         long: '--endpoint ENDPOINT'
+
+  option :token,
+         description: 'TOKEN_API',
+         short: '-t TOKEN_API',
+         long: '--token TOKEN_API'
+
+  option :period,
+         description: 'Sampling Period in seconds.',
+         short: '-p',
+         long: '--period',
+         proc: proc(&:to_i),
+         default: 3600
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-S SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.gitlab"
+
+  def gitlab_configure
+    Gitlab.private_token = config[:token]
+    Gitlab.endpoint = config[:endpoint]
+  end
+
+  def commit_count(commits)
+    select_by_period(commits).count
+  end
+
+  def commit_count_by_status(project, commits)
+    result = { pending: 0, running: 0, success: 0, failed: 0, canceled: 0 }
+    select_by_period(commits).each do |commit|
+      commit_info = Gitlab.commit(project.id, commit.id)
+      unless commit_info.status.nil?
+        result[commit_info.status.to_sym] = result[commit_info.status.to_sym].to_i + 1
+      end
+    end
+
+    result
+  end
+
+  def project_count(projects)
+    projects.count
+  end
+
+  def user_count(users)
+    users.count
+  end
+
+  def group_count(groups)
+    groups.count
+  end
+
+  def select_by_period(list)
+    list.lazy.select { |item| Time.iso8601(item.created_at) >= (Time.now.utc - config[:period]) }
+  end
+
+  def repository_count(repositories)
+    select_by_period(repositories).count
+  end
+
+  def print_hash(hash, path = '')
+    hash.each do |key, value|
+      if value.is_a? Hash
+        print_hash(value, "#{path}.#{key}")
+      else
+        output "#{config[:scheme]}#{path}.#{key}", value
+      end
+    end
+  end
+
+  def event_count_by_action(events)
+    result = {
+      created: 0,
+      updated: 0,
+      closed: 0,
+      reopened: 0,
+      pushed: 0,
+      commented: 0,
+      merged: 0,
+      joined: 0,
+      left: 0,
+      destroyed: 0,
+      expired: 0
+    }
+    select_by_period(events).each do |event|
+      result[event.action_name.to_sym] = result[event.action_name.to_sym].to_i + 1
+    end
+
+    result
+  end
+
+  def merge_request_count(merge_requests)
+    select_by_period(merge_requests).count
+  end
+
+  def run
+    gitlab_configure
+    metrics = {
+      project_count: 0,
+      user_count: 0,
+      group_count: 0
+    }
+
+    projects = Gitlab.projects
+    metrics[:project_count] += project_count(projects)
+    metrics[:user_count] += user_count(Gitlab.users)
+    metrics[:group_count] += group_count(Gitlab.groups)
+
+    if Gitlab::VERSION > '4.3.0'
+      metrics[:sidekiq] = {}
+      sidekiq_job_stats = Gitlab.sidekiq_job_stats.jobs
+      metrics[:sidekiq][:processed] = sidekiq_job_stats.processed
+      metrics[:sidekiq][:failed] = sidekiq_job_stats.failed
+      metrics[:sidekiq][:enqueued] = sidekiq_job_stats.enqueued
+    end
+
+    projects.each do |project|
+      metrics[project.name] = { commit_count: 0, commit_count_by_status: {} }
+
+      metrics[project.name][:branches_count] = Gitlab.branches(project.id).count
+
+      project_events = Gitlab.project_events(project.id, after: (Time.now.utc - config[:period]))
+      metrics[project.name][:events_count_per_hour] = event_count_by_action(project_events)
+      merge_requests = Gitlab.merge_requests(project.id, since: (Time.now.utc - config[:period]))
+      metrics[project.name][:merge_request_count_per_hour] = merge_request_count(merge_requests)
+
+      commits = Gitlab.commits(project.id, since: (Time.now.utc - config[:period]))
+      metrics[project.name][:commit_count_per_hour] = commit_count(commits)
+      metrics[project.name][:commit_count_per_hour_by_status] = commit_count_by_status(project, commits)
+    end
+
+    print_hash(metrics)
+
+    ok
+  end
+end

data/lib/sensu-plugins-gitlab.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-gitlab/version'

data/lib/sensu-plugins-gitlab/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsGitlab
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,288 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-gitlab
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: kitchen-localhost
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.36.1
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Sensu gitlab plugins
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-health-gitlab.rb
+- metrics-gitlab.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-health-gitlab.rb
+- bin/metrics-gitlab.rb
+- lib/sensu-plugins-gitlab.rb
+- lib/sensu-plugins-gitlab/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-gitlab
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for gitlab
+test_files: []