Meeseeks are creatures who are created to serve a singular purpose for which they will go to any length to fulfill. After they serve their purpose, they expire and vanish into the air. [1]

Meeseeks

⚠️ Do not use in production ⚠️

Usage

Asynchronously submit metrics to a Circonus HTTPTrap:

> m = Meeseeks::Meeseeks.new(
  data_submission_url: 'https://api.circonus.com/module/httptrap/2ds89as2-29e3-4155-a54a-4b7261419e11/secret',
  interval: 60,
  max_batch_size: 100,
  max_queue_size: 10_000
)
=> #<Meeseeks::Meeseeks:0x00005640e59dd380 … >
>  m.record('group', 'metric', 22.02)
=> true

You can also configure Meeseeks via environment variables

• MEESEEKS_DATA_SUBMISSION_URL=https://api.circonus.com/module/httptrap/2ds89as2-29e3-4155-a54a-4b7261419e11/secret
• MEESEEKS_INTERVAL=60
• MEESEEKS_MAX_BATCH_SIZE=100
• MEESEEKS_MAX_QUEUE_SIZE=10000

or via code:

> Meeseeks.configure(
  data_submission_url: 'https://api.circonus.com/module/httptrap/2ds89as2-29e3-4155-a54a-4b7261419e11/secret',
  interval: 60,
  max_batch_size: 100,
  max_queue_size: 10_000
)

and then use the singleton (to the same effect as the first example):

Meeseeks.instance.record('group', 'metric', 22.02)

Meeseeks statistics

Meeseeks will instrument itself on Circonus (these metrics will be added to each batch submitted to Circonus, so for max_batch_size: 100 we will really submit 104 metrics each time). Look for these metrics:

• meeseeks`batch_size (how many measurements were submitted per request to Circonus?)
• meeseeks`cycle_count (how many intervals did this meeseeks instance do?)
• meeseeks`queue_size (how many measurements are waiting in the queue to be submitted?)
• meeseeks`submit_count (how many requests to Circonus did this meeseeks instance do?)

Debugging

We tried to make Meeseeks inspectable:

# Basic stats
> Meeseeks.stats
=> {
     "queue_size": 0,
     "harvester": {
       "cycle_count": 7,
       "running": true
     },
     "http_trap": {
       "submit_count": 7,
       "last_submit_at": "2018-10-19 10:42:35 +0000"
     }
   }

# You can even dive into the requests to Circonus, and the responses
# received (including bodies):
> Meeseeks.http_trap.last.request
=> #<Net::HTTP::Put PUT>
> Meeseeks.http_trap.last.response
=> #<Net::HTTPOK 200 OK readbody=true>

Development

After checking out the repo, run make build - you need only docker on your machine, no ruby, rvm, or any of that.

Launch a shell or console

To try it out locally while developing, you can make shell to open a shell in a container where the gem's dependencies are installed, and you can use make console as an alias for entering make shell and rake console.

Run the tests

During development, you can just keep make guard running and it will test files as you edit them. You can also run make test to run all of the tests.

Automatically fix rubocop offenses

Run make rubocop.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/coup-mobility/meeseeks. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Meeseeks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Acknowledgements

Mr. Meeseeks picture by Nathan Andrews