take-plugin-bot-beholder

Generated by Generator BLiP Plugin.

YEEEEEEEEEEEEEEEEEEEEEEEEEEEEEEES IT'S TRUUUUUUUUUUEEEEEEE

-- Cid do Não Salvo

The [Solutions Lab Team][solutions-lab] is excited to delivery the famous bot beholder that most take.seres thought to be a myth.

Bot Beholder it's finally alive and better than never because now we can debug ROUTERS! Yeah, you read it right, we finally can debug routers 🎉

Have you met Bot Beholder?

-- Barney Stinson

For the new ones that never met the original bot beholder it was created to help debugging development/production bots among other things, but let's concentrate on the principal feature, the Tracing.

Tracing for babies

Let's be simple and go to what we want here, with tracing is possible to follow all the steps of users in a giving bot, so with this feature you can search for a specific user and follow it's trail, contact, contexts, elapsed time on each action and the complete raw log of the actions made at every step.

Imagine the following scenario: Someone just asked you: Why my user is stuck at this point of the flow?

What do you do? Simple. Just go to beholder's tracing feature, filter the user and see what's going on, just like that, no need to open 10000 commands to validate the user's statedid, most of the things will be there for you to check.

Enough with the talking, show me what I want

Ok, but you asked for it:

Want to see some tracing? take a look at this bad boy:

What about contact and contexts?

Create edit and delete context variables, do you like it?

Did you just said "Show me my raw data"?

Not that much, just one state? Ok

JUST SHOW ME HOW

Here it goes, feel free to play with it!

Advanced Configurations

Add the plugin url to your advanced configurations, if you already have others plugins just append it to the dictionary.

• Url: https://take-plugin-bot-beholder.cs.blip.ai

Domain	Name	Value
postmaster@portal.blip.ai	Plugins	{"beholder-plugin": {"name": "Beholder", "url": "https://take-plugin-bot-beholder.cs.blip.ai"}}

Configuring the tracing

This just need to be done once! You need admin access on all bots, in case of router in all connected subbots

1. At beholder's page, click the button that says "Activate bot's tracing".
2. After that you need to publish the flow, if it's a simple bot just publish it's own flow, if it's a router you need to publish every subbot flow.

That's all folks!

Feel free to send PRs to improve something or add new features! But always keep in mind the remaining question: Who beholds the beholder?

Usage

Just install the dependencies:

$ npm install

Then:

$ npm start

Action	Usage
Starting development mode	npm start
Linting code	npm run lint
Running unit tests	npm run jest
Running lint + tests	npm test
Running code coverage	npm run coverage
Sending coverage results to Coveralls.io	npm run coveralls

Author

Gabriel Rodrigues dos Santos

License