trakerr-com / trakerr-ruby Goto Github PK

http://stackoverflow.com/questions/10048173/why-is-it-a-bad-style-to-rescue-exception-e-in-ruby

Picked up ruby for this, am now aware of the consequences. =)

Currently, if you pass it an unsupported stack trace, the event trace builder argument errors you. Define a consistent behavior for that case.

Modify Sample App to take in an API key as an argument. for ease of use running the sample app from the command line.

Refactor constructor to be light weight and ease on the user. Provide accessor methods for instance fields.

Add comments to explain the API.

Add the new deploymentStage property (old envName and change the default values of envName (to be the Ruby name) and Version properties. Change the classification to optional as a descriptor and add the new level enum (or ruby equivalent, old classification).

Update readme for refactor 1 (TC constructors) & 2 (deploymentStage).

Deprecation of the public functions should allow Ruby to become closer to the Python API's look, feel, and user experience and expectations. Having a single outward facing function also makes sense, considering that these both do the same thing, with exception only adding a Stacktrace.

Check if create events can use an importable enum over string parsing.

New fields:
Add current full URL (for browser apps)
Add operation time in millis
Add tags (constructor)
Add application SKU field (constructor)
Add device type and info (iPhone 7) etc. to SDK (automatic defaults)
Add current CPU and memory usage info (automatic defaults)
Add correlation ID (as a new ID to correlate across applications)

Right now, the constructor is

default_config = Trakerr::Configuration.default
default_config.base_path = url || default_config.base_path
@apiKey = apiKey
@contextAppVersion = contextAppVersion
@contextEnvName = contextEnvName
@contextEnvVersion = contextEnvVersion
@contextEnvHostname = contextEnvHostname || Socket.gethostname
@contextAppOS = contextAppOS || RbConfig::CONFIG["target_os"]
@contextAppOSVersion = contextAppOSVersion
@contextAppBrowser = contextAppBrowser
@contextAppBrowserVersion = contextAppBrowserVersion
@contextDataCenter = contextDataCenter
@contextDataCenterRegion = contextDataCenterRegion
api_client = Trakerr::ApiClient.new(default_config)
@events_api = Trakerr::EventsApi.new(api_client)

Provide default values for env name and versions and more detail for appos and apposversions. Both of those may require platform specific shell commands.

Need to update the gemspec on the rubygemes package manager after these two refactors

Add the Apache licence headers to code-files.

The gemfile won't work on windows due to the find file logic using the bash find. Look into using other solutions.

  s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
  s.test_files    = `find generated/spec/*`.split("\n")

Make sure API key and stuff isn't on the github.

right now, running ./mkgem.sh errors on all commands; valid or no. Figure out why.

Add documentation to the main README.MD

Add some support for the built in Ruby logger, like python. Allowing users to set a level in the code for easy dev to production switches.

Ref: https://ruby-doc.org/stdlib-2.1.0/libdoc/logger/rdoc/Logger.html

Create app event defaults to creating a stacktrace. Default instead to False, and then check if the value is True to create a new exec info.