Skip to content

Commit 783263f

Browse files
author
HirotoShioi
committed
Fix diagram and some text
1 parent 692e4d0 commit 783263f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# log-classifier
22

3-
The purpose of this project is to analyze tickets that are in the IOHK Zendesk system and provide a solution to the end user while collecting statistics so Cardano developers can prioritize the issues.
3+
The purpose of this project is to analyze Cardano log file and provide a solution to the end user while collecting statistics so Cardano developers can prioritize the issues.
44

55
## What it is
66

7-
- Log-classifier is a [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) IOHK Zendesk agents can use to classify tickets.
7+
- Log-classifier is a [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) IOHK help desk agents can use to classify tickets.
88
- Currently, identifying the issue manually takes a decent amount of time and knowledge. Using classifier, the agent will be able to automate the identification of the issue without having to know all the known issues.
99
- This is a Haskell program so the agent will need [stack](https://docs.haskellstack.org/en/stable/README/) and [Nix](https://nixos.org/) in order to use the classifier. Instruction on how to use it will be documented on different file.
1010
- The classifier cannot find any unknown/unique issues.
1111

1212
## How it works
1313

14-
![system architecture](https://user-images.githubusercontent.com/15665039/39685800-efaef634-51ff-11e8-972a-db3e01ca9223.png)<br/>
14+
![system architecture](https://user-images.githubusercontent.com/15665039/40042756-5d92611e-585d-11e8-80b4-72677c451dd1.png)<br/>
1515
This is a use case diagram. Use case diagrams overview the usage requirements for a system. They are useful for presentations to management and/or project stakeholders, but for actual development, you will find that use cases provide significantly more value because they describe "the meat" of the actual requirements. For more details, please see [here](http://www.agilemodeling.com/artifacts/useCaseDiagram.htm)
1616

1717
### Overview
1818

1919
- Many of the Daedalus's issues can be identified by analyzing the log file. The classifier will utilize this by analyzing the log file and map with possible solution and problem which can be provided to the end user.
2020
- Ticket sent from Daedalus bug report has log file attached. The classifier will analyze the log file that is attached to the ticket. If any known issues where found, it'll then post a comment to that ticket. (See example below)
2121
- It uses [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) (basically small record file) which contains all the information need to perform the analysis. This makes it easy to add new known issues.
22-
- Zendesk agent will use [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) in order to run the classifier.
22+
- Help desk agent will use [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) in order to run the classifier.
2323
- The classifier will use the [Zendesk API](https://developer.zendesk.com/rest_api/docs/core/introduction) to perform any action. Because of this, agents will need to provide their email address and password to the classifier.
2424

2525
## Requirements
@@ -43,7 +43,7 @@ See example below.
4343

4444
### Add tags to the tickets
4545

46-
After classifier has done analysis on the ticket, it'll add tags to the ticket which can be used to identify what the issues are. Agents can later use this tags to collect statistics of the Zendesk. <br />
46+
After classifier has done analysis on the ticket, it'll add tags to the ticket which can be used to identify what the issues are. Agents can later use this tags to collect statistics. <br />
4747

4848
<img src="https://user-images.githubusercontent.com/15665039/39680413-6c3970a0-51db-11e8-81d9-8c0faf53d1af.png" alt="tags"/><br/>
4949

@@ -71,12 +71,12 @@ directory-not-found: **
7171

7272
### Collect email addresses of the tickets in which both requester and assignee is report server
7373

74-
[Report server](https://github.com/input-output-hk/cardano-report-server) had a bug where it assigned both requester and assignees as report server and write down user's address in the comment section. This made it so that Zendesk agent where unable to reply back to the user unless agents create new tickets manually which takes some time to reply back. Note that this issue is already fixed.
74+
[Report server](https://github.com/input-output-hk/cardano-report-server) had a bug where it assigned both requester and assignees as report server and write down user's address in the comment section. This made it so that help desk agent where unable to reply back to the user unless agents create new tickets manually which takes some time to reply back. Note that this issue is already fixed.
7575
The classifier can collect email addresses of tickets with this issue.
7676

7777
## Simple use-case scenario
7878

79-
### IOHK Zendesk agent finds ticket submitted from the end user with log file attached and wants to perform analysis on it
79+
### IOHK help desk agent finds ticket submitted from the end user with log file attached and wants to perform analysis on it
8080

8181
In this case, one can run the command below.
8282

@@ -86,7 +86,7 @@ In this case, one can run the command below.
8686

8787
This will parse the log file attached to the `<TICKET_ID>` and provide the result to the agent using private comment in the Zendesk UI. The agent then use that comment to help troubleshoot the end user.
8888

89-
### IOHK Zendesk agent wants to parse every ticket that is sent from Daedalus bug report with log file attached
89+
### IOHK help desk agent wants to parse every ticket that is sent from Daedalus bug report with log file attached
9090

9191
In this case, one can run the command below.
9292

@@ -96,7 +96,7 @@ In this case, one can run the command below.
9696

9797
This will parse any tickets with log file attached that are sent from the Daedalus bug report. It then post analysis result as private comment on any ticket that it has parsed so that the agents can provide the end user with solution.
9898

99-
### IOHK Zendesk agent wants to know the statistics of the current Zendesk so he/she can report to the Cardano-SL team which will categorize/prioritize the issue
99+
### IOHK help desk agent wants to know the statistics of the occurring issues so he/she can report to the Cardano-SL team which will categorize/prioritize the issue
100100

101101
In this case, one can run the command below.
102102

0 commit comments

Comments
 (0)