Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Commit

Permalink
Initial release.
Browse files Browse the repository at this point in the history
  • Loading branch information
metaskills committed Jul 14, 2020
0 parents commit 1b8d287
Show file tree
Hide file tree
Showing 22 changed files with 555 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: CI
on: [push]
jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
ruby:
- '2.5'
- '2.7'
steps:
- name: Checkout
uses: actions/checkout@v1
- name: Setup Ruby
uses: actions/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby }}
- name: Bundle
run: |
./bin/setup
- name: Test
run: |
./bin/test
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# Keep A Changelog!

See this http:https://keepachangelog.com link for information on how we want this documented formatted.

## v0.1.0

### Added

- Initial Release!!! 🎉🎊🥳
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://contributor-covenant.org/version/1/4][version]

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/
10 changes: 10 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
source "https://rubygems.org"
gemspec

gem 'rake'
gem 'minitest'

group :test do
gem 'mocha'
gem 'pry'
end
29 changes: 29 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
PATH
remote: .
specs:
aws-embedded-metrics-customink (0.1.0)

GEM
remote: https://rubygems.org/
specs:
coderay (1.1.3)
method_source (1.0.0)
minitest (5.14.1)
mocha (1.11.2)
pry (0.13.1)
coderay (~> 1.1)
method_source (~> 1.0)
rake (13.0.1)

PLATFORMS
ruby

DEPENDENCIES
aws-embedded-metrics-customink!
minitest
mocha
pry
rake

BUNDLED WITH
2.1.2
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2020 Ken Collins

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.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Aws::Embedded::Metrics for Ruby [![Actions Status](https://github.com/customink/aws-embedded-metrics-customink/workflows/CI/badge.svg)](https://github.com/customink/aws-embedded-metrics-customink/actions)

⚠️ Bare minimum code to explore [Amazon CloudWatch Embedded Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format.html) with Ruby. Any and all help welcome to raise the quality of our implementation.

#### Inspiration

Pulled from these two projects using the [Embedded Metric Format Specification](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Manual.html) as a reference guide.

* Node: https://github.com/awslabs/aws-embedded-metrics-node
* Python: https://github.com/awslabs/aws-embedded-metrics-python

However, unlike these projects, we differ in the following ways. Again, contributions are very much welcome if you want to see more or change this.

* Initial focus on Lambda. No other sinks.
* As such, no default Dimensions or Configuraiton for:
- `LogGroupName`
- `LogStreamName`
- `ServiceName`
- `ServiceType`

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'aws-embedded-metrics-customink'
```
## Usage

Simple configuration.

```ruby
Aws::Embedded::Metrics.configure do |c|
c.namespace = 'MyApplication'
end
```

Usage is in a scope block. All metrics are flushed afterward

```ruby
Aws::Embedded::Metrics.logger do |metrics|
metrics.put_dimension 'SomeDimension', 'SomeDimensionValue'
metrics.set_property 'EventKey', 'some/s3/path'
metrics.put_metric 'Processor', 232, 'Milliseconds'
metrics.put_metric 'Total', 4008, 'Milliseconds'
end
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/customink/aws-embedded-metrics-customink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/customink/aws-embedded-metrics-customink/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Aws::Embedded::Metrics project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/customink/aws-embedded-metrics-customink/blob/master/CODE_OF_CONDUCT.md).
10 changes: 10 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
require "bundler/gem_tasks"
require "rake/testtask"

Rake::TestTask.new(:test) do |t|
t.libs << "test"
t.libs << "lib"
t.test_files = FileList["test/**/*_test.rb"]
end

task :default => :test
23 changes: 23 additions & 0 deletions aws-embedded-metrics-customink.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
require_relative 'lib/aws-embedded-metrics-customink/version'

Gem::Specification.new do |spec|
spec.name = "aws-embedded-metrics-customink"
spec.version = Aws::Embedded::Metrics::VERSION
spec.authors = ["Ken Collins"]
spec.email = ["[email protected]"]
spec.summary = 'Amazon CloudWatch Embedded Metric Format Client Library'
spec.description = 'Amazon CloudWatch Embedded Metric Format Client Library for Ruby.'
spec.homepage = 'https://github.com/customink/aws-embedded-metrics-customink'
spec.license = "MIT"
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
spec.metadata['allowed_push_host'] = 'http:https://mygemserver.com'
spec.metadata['homepage_uri'] = spec.homepage
spec.metadata['source_code_uri'] = 'https://github.com/customink/aws-embedded-metrics-customink'
spec.metadata['changelog_uri'] = 'https://github.com/customink/aws-embedded-metrics-customink/blob/master/CHANGELOG.md'
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
end
14 changes: 14 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "aws-embedded-metrics-customink"

# You can add fixtures and/or initialization code here to make experimenting
# with your gem easier. You can also use a different console, if you like.

# (If you use this, don't forget to add pry to your Gemfile!)
# require "pry"
# Pry.start

require "irb"
IRB.start(__FILE__)
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx

bundle install

# Do any other automated setup that you need to do here
6 changes: 6 additions & 0 deletions bin/test
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx

bundle exec rake test
34 changes: 34 additions & 0 deletions lib/aws-embedded-metrics-customink.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
require 'json'
require 'benchmark'
require 'aws-embedded-metrics-customink/version'
require 'aws-embedded-metrics-customink/config'
require 'aws-embedded-metrics-customink/sinks'
require 'aws-embedded-metrics-customink/logger'

module Aws
module Embedded
module Metrics

def configure
Config.configure { |c| yield(c) }
end

def reconfigure
Config.reconfigure { |c| yield(c) if block_given? }
end

def logger
Logger.new.tap do |l|
l.metrics { |m| yield(m) } if block_given?
end
end

def sink
@sink ||= Sinks::Lambda.new
end

extend self

end
end
end
40 changes: 40 additions & 0 deletions lib/aws-embedded-metrics-customink/config.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
module Aws
module Embedded
module Metrics
module Config

def configure
yield(config)
config
end

def reconfigure
config.reconfigure { |c| yield(c) if block_given? }
end

def config
@config ||= Configuration.new
end

extend self

class Configuration

attr_writer :namespace

def reconfigure
instance_variables.each { |var| instance_variable_set var, nil }
yield(self) if block_given?
self
end

def namespace
return @namespace if defined?(@namespace)
ENV['AWS_EMF_NAMESPACE'] || 'aws-embedded-metrics'
end

end
end
end
end
end
Loading

0 comments on commit 1b8d287

Please sign in to comment.