https://github.com/kirillshevch/flow_trace

Brand new remote app inspecting tool. Declare feature steps and receive params, stack trace and whatever you want.
https://github.com/kirillshevch/flow_trace

client-server debugger http inspectcode ruby

Last synced: 28 days ago
JSON representation

Brand new remote app inspecting tool. Declare feature steps and receive params, stack trace and whatever you want.

• Host: GitHub
• URL: https://github.com/kirillshevch/flow_trace
• Owner: kirillshevch
• License: mit
• Created: 2019-11-15T11:36:54.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-24T13:29:10.000Z (about 5 years ago)
• Last Synced: 2024-12-06T21:41:43.779Z (2 months ago)
• Topics: client-server, debugger, http, inspectcode, ruby
• Language: Ruby
• Homepage: https://twitter.com/kirill_shevch/status/1198601165744816129?s=20
• Size: 470 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# FlowTrace

Brand new remote app inspecting tool. Declare feature steps and receive params, stack trace and whatever you want.

* Look into what happens on you *staging* environments

* Doesn't have payloads for tests, debugging, bug fix? Get data during reproducing feature flow.



  



## Installation

Add this line to your application's Gemfile and then execute `bundle install`:

```ruby

gem 'flow_trace'

```

## Usage

### 1. Configuration

Use `https` proxy (for example [ngrok](http://ngrok.io/)) to local `4567` port.

`config/initializers/flow_trace.rb`

```ruby

FlowTrace::Settings.configure do |config|

  config.proxy_url = 'http://0000000.ngrok.io'

end

```

### 2. Declare remote flow

Step interface is here:

```ruby

FlowTrace::Step.call(:flow_name, :step_name, { additional: 'data' })

```

### 3. Start receive messages (locally)

```

bundle exec flow_trace

```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/flow_trace.

## License

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