README.md in emissary-ruby-0.0.6 vs README.md in emissary-ruby-0.0.7
- old
+ new
@@ -1,9 +1,12 @@
# Emissary
Simple error catcher integrated with services like Discord and Trello, use chatbots to monitor your application and server.
Receive error catching reports to a Discord Server Channel, and use chatbots to send commands and fetch reports.
+# PRESENTATION
+[](https://dms.licdn.com/playlist/C4E05AQHyxbCfCVGHYA/mp4-720p-30fp-crf28/0/1623710691404?e=1623808800&v=beta&t=gUzmyqiD7vgxfWC7KYeU53-us6buF-kf2o60RfZfxuQ)
+
# Features
* This tools allows you to configurate the errors or lines you want to capture from any log file, in this example you will find a configuration for catching HTTP ERROR 500.
* You can configurate the timeframes in which the logs will be read, the conditions that triggers the errores, the lines to fetch from the files, the language to markup the error to discord, characters to ignore, how often the errors fetched would be clear, and how often you want a receive reports with error ocurrences.
* You can also use chatbots to fetch and generate reports any time outside the timeframes configurated.
* You can also configurate linux commands and receive in discord the outputs or results.
@@ -20,42 +23,30 @@
* 2. Click in **Token** to create your member token *(be aware of expiration time)*
* 3. Copy both your **public_key** and **member_token** into the initializer file or runner
* 4. Find your Trello **ListID**, you can do this by openning the web tools in your browser, click on the navigation tab and watch for the navigation log when editing the name of your list, the ID will be visible under the **Preview Tab**
* 5. Use the Trello **ListID** in the loggr.json file under the configuration you want trello to work with.
-# 2. Download / Clone the code
-```bash
-
-git clone git@github.com:MakarovCode/Emissary.git
-
-```
-
-# 3. Make it run
-create runner.rb or config/initializer/emissary.rb file
-
+# 2. Install gem and dependencies
```ruby
-require './emissary'
+#Gemfile
+gem "emissary-ruby"
+gem "discordrb"
+gem "ruby-trello"
-Emissary.configure do |config|
- config.server_name = "A name for chat titles"
- config.header_format = "__***{title}***__" #Any markup
- config.webhooks_url = '{discord webhooks_url}'
- config.bot_token = '{discord bot_token}'
- config.trello_public_key = '{trello public_key}'
- config.trello_member_token = '{trello member_token}'
-end
+#Or install each gem
+gem install "discordrb"
+gem install "ruby-trello"
+gem install "emissary-ruby"
-emi = Emissary.new
-
```
-# 4. Configure your log readers and commands in the loggr.json file
+# 3. Configure your log readers and commands by creating a file emissary.json inside your project.
See some examples
-```javascript
+```json
{
"rails": {
"name": "Rails Logger",
"path": "path/to/rails/log",
"condition": "Completed 500 Internal Server Error",
@@ -107,10 +98,18 @@
"format": {"from": " ", "to": "|"}
}
}
```
+# 3. Make it run
+Run the **bundle exec emissary** command and pass as parameter the path to the **emissary.json** file you just created
+
+```ruby
+bundle exec emissary "/path/to/config/file.json"
+
+```
+
# 5. If everything goes right
You can type the next commands in your Discord Server Channel and the Chatbot will answer.
```ruby
!emy rails fetch #This will read the log file for the setup with command rails
@@ -119,12 +118,19 @@
!emy disk #This will send back to discord the usage of the server disk partitions
!emy rails {id} trello #Add message report to trello list
```
+
# Roadmap
This tools is in the making
-* Upload as Ruby Gem
+* Multi server with the same BOT
+* Better command params handling
+* Convert the message HASH into a Ruby Class
+* Change the JSON config file to a init class configuration for better customization
+* Title dates formatting
+* Gem dependencies
* Regex conditioning
* Slack Integration
* Email reports Integration
-* Convert the message HASH into a Ruby Class
+* Authy integration for TwoFactor authentication for sensible commands
+* API Keys with ENV variables