Expertiza_Wiki - User contributions [en]

Independent Study Spring 2018/Logging

2018-05-09T17:16:08Z

Knielar:

=Logging capability in Expertiza=
==Useful links==
[https://github.com/expertiza/expertiza/pull/1148 Github Pull Request]

[https://github.com/nielarshi/expertiza-elk ELK configurations]

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LoggerMessage''' or a string.

===Custom LoggerMessage===

A LoggerMessage instance could be created as follows:

'''LoggerMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LoggerMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Kibana Interface===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

Independent Study Spring 2018/Logging

2018-05-09T15:51:02Z

Knielar:

=Logging capability in Expertiza=
==Pull Request==
[https://github.com/expertiza/expertiza/pull/1148 'Github Pull Request']

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LoggerMessage''' or a string.

===Custom LoggerMessage===

A LoggerMessage instance could be created as follows:

'''LoggerMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LoggerMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Kibana Interface===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

Independent Study Spring 2018/Logging

2018-05-08T18:01:37Z

Knielar:

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LoggerMessage''' or a string.

===Custom LoggerMessage===

A LoggerMessage instance could be created as follows:

'''LoggerMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LoggerMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LoggerMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Kibana Interface===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

Independent Study Spring 2018/Logging

2018-05-08T03:06:45Z

Knielar: /* Visualization */

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LogMessage''' or a string.

===Custom LogMessage===

A LogMessage instance could be created as follows:

'''LogMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LogMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Kibana Interface===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

Independent Study Spring 2018/Logging

2018-05-08T03:04:28Z

Knielar: /* Visualization */

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LogMessage''' or a string.

===Custom LogMessage===

A LogMessage instance could be created as follows:

'''LogMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LogMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Visualization===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

File:Kibana tracing error.png

2018-05-08T03:03:44Z

Knielar: uploaded a new version of "File:Kibana tracing error.png"

File:Kibana success msg.png

2018-05-08T03:03:31Z

Knielar: uploaded a new version of "File:Kibana success msg.png"

File:Kibana search using unityid.png

2018-05-08T03:03:10Z

Knielar: uploaded a new version of "File:Kibana search using unityid.png"

File:Kibana search req id.png

2018-05-08T03:02:43Z

Knielar: uploaded a new version of "File:Kibana search req id.png"

File:Kibana exception.png

2018-05-08T03:01:25Z

Knielar: uploaded a new version of "File:Kibana exception.png"

Independent Study Spring 2018/Logging

2018-05-08T02:38:02Z

Knielar: /* Visualization */

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LogMessage''' or a string.

===Custom LogMessage===

A LogMessage instance could be created as follows:

'''LogMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LogMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Visualization===

Success message in Kibana

[[File:kibana_success_msg.png|200px|thumb|left|alt text]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

File:Kibana tracing error.png

2018-05-08T02:36:39Z

Knielar:

File:Kibana search using unityid.png

2018-05-08T02:36:15Z

Knielar:

File:Kibana search req id.png

2018-05-08T02:35:49Z

Knielar:

File:Kibana exception.png

2018-05-08T02:35:15Z

Knielar:

Independent Study Spring 2018/Logging

2018-05-08T02:34:25Z

Knielar: /* Visualization through ELK stack */

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LogMessage''' or a string.

===Custom LogMessage===

A LogMessage instance could be created as follows:

'''LogMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LogMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

===Visualization===

Success message in Kibana

[[File:kibana_success_msg.png|frame|upright|center]]

Exception in kibana

[[File:kibana_exception.png|frame|upright|center]]

Tracing error in kibana

[[File:kibana_tracing_error.png|frame|upright|center]]

Search records using request ID in kibana

[[File:kibana_search_req_id.png|frame|upright|center]]

Searching records using unity id in kibana

[[File:kibana_search_using_unityid.png|frame|upright|center]]

MainPage

2018-05-08T02:30:18Z

Knielar: /* Expertiza */

==Expertiza==
* [[Expertiza documentation]]

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Fall 2016]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC/ECE 517 Spring 2017]]
* [[CSC/ECE 517 Fall 2017]]
* [[CSC/Independent Study Spring 2018]]
* [[CSC/ECE 517 Spring 2018- Project Juniper:Bookmark Enhancements]]
* [[CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management]]
* [[CSC/ECE_517_Spring_2018- Project E1805: Convolutional data extraction from Github]]
* [[CSC/ECE 517 Spring 2018- Project E1808: Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews]]
* [[CSC/ECE 517 Spring 2018/E1814 Write unit tests for collusion cycle.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering (Part 2)]]
* [[CSC/ECE 517 Spring 2018 - E1800: Add past-due assignments to task list]]
* [[CSC/ECE 517 Spring 2018- Project E1812: on the fly calc.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches ]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches (Part 2)]]
* [[CSC/ECE 517 Spring 2018/E1813 Test Menu Items Model]]
* [[CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric]]
* [[CSC/ECE 517 Spring 2018- Project E1818: Role-based reviewing]]
* [[CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging]]
* [[CSC/ECE 517 Spring 2018- Project E1815: Improvements to review grader]]
* [[CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews]]
* [[CSC/ECE 517 Spring 2018- Project E1819: Improve self review, link self and peer review to derive grades]]
* [[CSC/ECE 517 Spring 2018- Project E1820 Review-Comment Tone Analysis Report]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]
* [http://rajanalwan.com/ui_guidelines/ Design Template]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2018-05-08T02:28:39Z

Knielar: /* Expertiza */

==Expertiza==
* [[Expertiza documentation]]

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Fall 2016]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC/ECE 517 Spring 2017]]
* [[CSC/ECE 517 Fall 2017]]
* [[Independent Study Spring 2018]]
* [[CSC/ECE 517 Spring 2018- Project Juniper:Bookmark Enhancements]]
* [[CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management]]
* [[CSC/ECE_517_Spring_2018- Project E1805: Convolutional data extraction from Github]]
* [[CSC/ECE 517 Spring 2018- Project E1808: Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews]]
* [[CSC/ECE 517 Spring 2018/E1814 Write unit tests for collusion cycle.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering (Part 2)]]
* [[CSC/ECE 517 Spring 2018 - E1800: Add past-due assignments to task list]]
* [[CSC/ECE 517 Spring 2018- Project E1812: on the fly calc.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches ]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches (Part 2)]]
* [[CSC/ECE 517 Spring 2018/E1813 Test Menu Items Model]]
* [[CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric]]
* [[CSC/ECE 517 Spring 2018- Project E1818: Role-based reviewing]]
* [[CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging]]
* [[CSC/ECE 517 Spring 2018- Project E1815: Improvements to review grader]]
* [[CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews]]
* [[CSC/ECE 517 Spring 2018- Project E1819: Improve self review, link self and peer review to derive grades]]
* [[CSC/ECE 517 Spring 2018- Project E1820 Review-Comment Tone Analysis Report]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]
* [http://rajanalwan.com/ui_guidelines/ Design Template]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

MainPage

2018-05-08T02:27:47Z

Knielar: /* Expertiza */

==Expertiza==
* [[Expertiza documentation]]

* [[CSC/ECE 517 Summer 2008]]
* [[CSC/ECE 517 Fall 2010]]
* [[CSC/ECE 517 Fall 2011]]
* [[CSC/ECE 517 Fall 2012]]
* [[CSC/ECE 517 Fall 2013]]
* [[CSC/ECE 517 Fall 2014]]
* [[CSC/ECE 517 Fall 2015]]
* [[CSC/ECE 517 Fall 2016]]
* [[CSC/ECE 517 Spring 2014]]
* [[CSC/ECE 517 Spring 2015]]
* [[CSC/ECE 517 Spring 2016]]
* [[CSC/ECE 517 Spring 2017]]
* [[CSC/ECE 517 Fall 2017]]
* [[CSC/ECE 517 Spring 2018]]
* [[CSC/ECE 517 Spring 2018- Project Juniper:Bookmark Enhancements]]
* [[CSC/ECE 517 Spring 2018- Project E1803: Introducing a Student View for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1804: OSS project Yellow: Topic management]]
* [[CSC/ECE_517_Spring_2018- Project E1805: Convolutional data extraction from Github]]
* [[CSC/ECE 517 Spring 2018- Project E1808: Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews]]
* [[CSC/ECE 517 Spring 2018/E1814 Write unit tests for collusion cycle.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering]]
* [[CSC/ECE 517 Spring 2018- Project M1802: 2D Canvas Rendering (Part 2)]]
* [[CSC/ECE 517 Spring 2018 - E1800: Add past-due assignments to task list]]
* [[CSC/ECE 517 Spring 2018- Project E1812: on the fly calc.rb]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches ]]
* [[CSC/ECE 517 Spring 2018- Project M1803: Implement a web page fuzzer to find rendering mismatches (Part 2)]]
* [[CSC/ECE 517 Spring 2018/E1813 Test Menu Items Model]]
* [[CSC/ECE 517 Spring 2018- Project E1816: Visualization for Instructors]]
* [[CSC/ECE 517 Spring 2018- Project E1817: Adding Student-generated Questions to Rubric]]
* [[CSC/ECE 517 Spring 2018- Project E1818: Role-based reviewing]]
* [[CSC/ECE 517 Spring 2018- Project E1822: Extend the functionality of badging]]
* [[CSC/ECE 517 Spring 2018- Project E1815: Improvements to review grader]]
* [[CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews]]
* [[CSC/ECE 517 Spring 2018- Project E1819: Improve self review, link self and peer review to derive grades]]
* [[CSC/ECE 517 Spring 2018- Project E1820 Review-Comment Tone Analysis Report]]
* [[CSC 456 Spring 2011|CSC 456 Spring 2012]]
* [[ECE 633]]
* [[KCU]]
* [[Progress reports]]

==Application Behavior==
* [[Grading]]

==Metaprogramming==
* [[CSC/ECE_517_Spring_2013/ch1b_1k_hf|Lecture on Metaprogramming]]

==Development==

''Expertiza now has a Java dependency, so the machine you are using to develop Expertiza on should have the JVM installed.''

* [[Setting Up a Development Machine]]
* [[Creating a Linux Development Environment for Expertiza - Installation Guide]]
* [[Using git and github for projects]]
* [[Using heroku to deploy your projects]]
* [[How to Begin a Project from the Current Expertiza Repository]]
* [[Git]]
* [[How to Change a User's Password on a Development Machine]]
* [[Debugging Rails]]
* [http://rajanalwan.com/ui_guidelines/ Design Template]

==Production==
* [[Deploying to Production]]
* [[Downloading Production Data]]
* [[Accessing the Production Server]]

==Testing==
* [[Using Cucumber with Expertiza]]
* [[Rails Testing Overview]]
* [[Expertiza Continuous Integration]]

==References==
* [[Object-Oriented Design and Programming]]

File:Kibana success msg.png

2018-05-08T02:26:44Z

Knielar:

Independent Study Spring 2018/Logging

2018-05-08T02:18:23Z

Knielar: Created page with "=Logging capability in Expertiza= ==Purpose== Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as: *Tr..."

=Logging capability in Expertiza=

==Purpose==
Logging feature has been added to Expertiza through a custom logging module written uniquely to serve several purposes such as:
*Tracing application failure
*Analysing user request flow
*Managing different logging level

==Message Format==
All the messages are logged in either of the below formats:

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[<''origin_ip''>] RID=[<''request_id''>] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[''Message'']'''

or

'''TST=[2018-03-10 00:50:18 -0500] SVT=[<''log_level''>] PNM=[<''program_name''>] OIP=[] RID=[] CTR=[<''controller_name''>] UID=[<''user_id''>] MSG=[[''origin_ip''] [''request_id''] ''Message'']'''

Above variation is because when certain messages are logged, ExpertizaLogger is unaware of origin_ip and request_ip and thus it is appended to the message instead of their respective placeholders.

===Meaning of each placeholder===
'''SVT''' - It denotes the severity level of the log. For eg, if the logging is done by calling logger.info, the severity level is "INFO".

'''PNM''' - It's the program name and is same as provided by default Rails logger.

'''OIP''' - It denotes the IP address of the system from where the request has been made.

'''RID''' - It's the ID of the request. All subsequent calls made by the client till the actual response is returned will have same request ID. For eg, when a page is first requested, all smaller page template fetched, all method flow will have same request ID. This field can be used to understand how a certain request was served.

'''CTR''' - It is the controller name from where the logging happened.

'''UID''' - It is the unity id/user id of the user making requests. This field could also be used in identifying the cause of an error.

'''Message''' - It is the actual message logged.

==Log files==
For different log levels, log messages are written in different files named expertiza_<log_level>.log

Currently, expertiza provides the capability of writing logs into 5 different custom log files.

For eg,

*expertiza_info.log

*expertiza_warn.log

*expertiza_error.log

*expertiza_fatal.log

*expertiza_debug.log

Apart from above files, <environment>.log file is used for logging messages which could not be logged by ExpertizaLogger, like, page load messages or certain load time exceptions.

Since Rails logger provides writing into a specific log file, to restrict least file switch, ExpertizaLogger holds different log level loggers in separate instance variables. A new logger instance is created and assigned whenever Rails removes the link to manage memory consumption.

==Components==
===ExpertizaLogger===

This class provides the logger needed for logging messages for different log levels.
It provides 5 different static methods namely '''info''', '''warn''', '''error''', '''fatal''' and '''debug''' which could be called as follows:

'''ExpertizaLogger.info ''message'''''

where ''message'' could be an instance of '''LogMessage''' or a string.

===Custom LogMessage===

A LogMessage instance could be created as follows:

'''LogMessage.new(<controller_name>, <user_id>, <message>, <request object>)'''

Fourth parameter i.e <request object> is an optional parameter.

Whenever a request is made, the request object is injected into the controller and is available in the controller as "request".
Similarly, <controller_name> is available in "controller_name" inside controller. For other trigger points, file name could be passed as a string.

Since the request object holds the ''<origin_ip>'' and ''<request_id>'', it is used to capture and log both into the log message.

===ExpertizaLogFormatter===

It captures the message and determines if the message is an instance of LogMessage or not. Based on that, it creates a message by populating message placeholders as below:

if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end

All the exceptions are preprocessed to remove newline characters so that it could fit in a single line as a message.

All the messages that are not logged by ExpertizaLogger, there is a separate logger definition provided in config/environments/<environment>.rb as:

config.log_formatter = proc do |s, ts, pg, msg|
if msg.is_a?(LogMessage)
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[#{msg.oip}] RID=[#{msg.req_id}] CTR=[#{msg.generator}] UID=[#{msg.unity_id}] MSG=[#{filter(msg.message)}]\n"
else
"TST=[#{ts}] SVT=[#{s}] PNM=[#{pg}] OIP=[] RID=[] CTR=[] UID=[] MSG=[#{filter(msg)}]\n"
end
end

===Environment config===
config.log_tags = [ :remote_ip, :uuid ]

These config.log_tags entries make sure that <origin_ip> and <request_id> are prepended to messages. These are for messages which are not logged by ExpertizaLogger but by the Rails default logger.
These messages go in <environment>.log file.

==Restrictions==
The request object is not available beyond the controllers. Hence, ''<origin_ip>'' and ''<request_id>'' remains uncaptured if messages are logged from somewhere other than controllers.

==Visualization through ELK stack==
===Configuration===

Filebeat (filebeat.yml)

Changes:

- type: log

# Change to true to enable this prospector configuration.
enabled: true

# Paths that should be crawled and fetched. Glob based paths.
paths:
- <path to log files>*.log

output.logstash:
# The Logstash hosts
hosts: ["<ip>:<5044:port of logstash>"]

Filebeat sends all log files to logstash.

Logstash (expertiza-logstash.conf)

input {
beats {
port => "5044"
}
}
filter {
grok {
match => { "message" => "TST=\[%{DATA:timestamp}\] SVT=\[%{DATA:sev}\] PNM=\[%{DATA:pgnm}\] OIP=\[%{DATA:originip}\] RID=\[%{DATA:requestid}\] CTR=\[%{DATA:generatedby}\] UID=\[%
{DATA:unityid}\] MSG=\[%{GREEDYDATA:message}\]" }
overwrite => [ "message", "timestamp" ]
}
date {
match => ["timestamp", "ISO8601"]
}

}
output {
elasticsearch {
hosts => [ "localhost:9200" ]
}
}

Logstash reads each line from the log file and parses it based on the template provided in grok match above. It then sends each message entry into Elastic search.

Kibana (config/kibana.yml)

elasticsearch.url: "http://localhost:9200"

Kibana picks each entry from Elastic search and provides into the web interface.

===Setup===
ELK stack could be set up to visualize and analyze the messages from the log files.

Once ELK is installed, below commands could be used to run each server:

'''Clear Elastic search cache'''

curl -X DELETE 'http://localhost:9200/_all'

'''Filebeat'''

sudo rm data/registry

sudo ./filebeat -e -c filebeat.yml -d "publish"

'''Logstash'''

bin/logstash -f expertiza-logstash.conf --config.reload.automatic

'''Kibana'''

bin/kibana

CSC/Independent Study Spring 2018

2018-05-07T16:02:30Z

Knielar: Created page with "'''Topics''' *Independent Study Spring 2018/Logging"

'''Topics'''
*[[Independent Study Spring 2018/Logging]]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-11T19:13:58Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, which ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered below cases for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn\’t have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment\’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

Horn icon appearing in correct column in signup sheet table.

[[File:A_after.png|frame|upright|center]]

All students whose teams are not complete would see list of other students without teams on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-11T19:08:12Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

===Pull Request===
*https://github.com/expertiza/expertiza/pull/1129/

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, which ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered below cases for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn\’t have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment\’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

===Change Video===
*https://youtu.be/B3h3O8UtJ8E

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-11T19:02:58Z

Knielar: /* What did we do? */

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers block any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When the assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other cases, the cell was not created every time, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, which ensured that even if a user has no action to display, at least a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered below cases for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn\’t have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment\’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-11T19:01:45Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers blocks any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When a the signment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other case, the cell was not created everytime, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, which ensured that even if a user has no action to display, atleast a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
'''This has solution step for CR2 and CR3.'''

We created a helper method to fetch all participants from the database who did not have a team or whose teams have only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

'''def extract_assignment_participants(assignment_id, excluded_id = nil)'''

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single-member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683 app/helpers/assignment_helper.rb]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407 app/controllers/student_teams_controller.rb(for student)]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8 app/controllers/teams_controller.rb(for instructors)]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered below cases for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

The table containing the list of students to send an invite to was created/not created based on above criteria only.

For Instructor, there were no such criteria to be considered.

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn\’t have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment\’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

All tests could be found here:
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d2b8c8df44cb32268062c72be7da59fb spec/controllers/student_teams_controller_spec.rb]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-d1d14865d734d2f66dc726c70cb1bcb9 spec/features/team_invitation_spec.rb]

== Visual representation of changes made ==

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-12-11T18:52:07Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

=====What did we do?=====

We found out that the problem was due to the name of horn icon. Certain ad blockers blocks any element with name ad or advertisement and horn icon was named as ad.png.
We renamed it to ad_horn.png and it resolved the issue.

We also found out that the issue was also due to some complex table cell population. When assignment was not in finished stage, actions were put into a td cell and displayed, which was adding an extra row, but this was only for users who had signed up some topic. In other case, the cell was not created everytime, forcing table row to have lesser columns.

We removed the conditional td creation, and added all conditional checks inside a parent td, which ensured that even if a user has no action to display, atleast a td will be created.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

=====What did we do?=====
This has solution step for CR2 and CR3.

We created a helper method to fetch all participants from database who did not have a team or whose teams has only one member(themselves).
We used Join queries to join tables participants, team_users, and teams to extract participants associated with the assignment with or without teams and then filtered out participants with team size > 1.

def extract_assignment_participants(assignment_id, excluded_id = nil)

Above method was defined in app/helpers/assignment_helper.rb.
The second parameter was required to exclude current student's id to be excluded to be returned for student whereas, for an Instructor, all students without teams or with single member team had to be returned.

More changes could be found here: [https://github.com/expertiza/expertiza/pull/1129/files#diff-e2d518aed0fccbb9ab0fc9e2e1ef8683]

The method was made generic enough to be used by both app/controllers/student_teams_controller.rb (for student) and app/controllers/teams_controller.rb (for instructors).

[https://github.com/expertiza/expertiza/pull/1129/files#diff-113f035d853c52fdfd3a00851a3db407]
[https://github.com/expertiza/expertiza/pull/1129/files#diff-7543048f54ac556dff85edee281fafd8]

For student, we checked if student can actually send invites or not, and based on that we fetched the participant list.
We considered below cases for verifying if a student can send invite or not:

*Student can't send invite if student doesn\’t have a team
*Student can't send invite if current team size is 1 and assignment\’s allowed team size is also 1
*Student can send invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Student can't send invite if current team size is equal to allowed team size
*Student can't send invite if assignment is in finished stage
*Student can send invite if assignment is not in finished state

== Modified Files ==
1)Conrollers:-
*app/controllers/student_teams_controller.rb
*app/controllers/teams_controller.rb
2)Helper:-
*app/helpers/assignment_helper.rb
3)Views:-
*app/views/join_team_requests/_list_not_initiated.html.erb
*app/views/join_team_requests/_list_received.html.erb
*app/views/join_team_requests/_list_sent.html.erb
*app/views/sign_up_sheet/_add_signup_topics.html.erb
*app/views/sign_up_sheet/_table_line.html.erb
*app/views/sign_up_sheet/list.html.erb
*app/views/student_teams/view.html.erb
*app/views/teams/list.html.erb
4)Tests:-
*spec/controllers/student_teams_controller_spec.rb
*spec/features/team_invitation_spec.rb

== Test Plan ==

=== Test Cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios
Testing invitation criteria:-
*Scenario 1 - Student can't see list of students to invite if student doesn\’t have a team
*Scenario 2 - Student can't see list of students to invite if current team size is 1 and assignment\’s allowed team size is also 1
*Scenario 3 - Student can see list of students to invite if assignment\’s allowed team size is >1 and current team size is less than allowed team size
*Scenario 4 - Student can't see list of students to invite if current team size is equal to allowed team size
*Scenario 5 - Student can't see list of students to invite if assignment is in finished stage
*Scenario 6 - Student can see list of students to invite if assignment is not in finished state
*Scenario 7 - The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*Scenario 8 - A student can create an invitation link only if his team is not yet full.
*Scenario 9 - The same student who accepted the invitation link actually gets added to the team.
*Scenario 10 - A student won't be able to send the invitation to himself as he is already a member of that team.
*Scenario 11 - An instructor sees only the list of the students who do not have teams with invitation link.

== Visual representation of changes made ==

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

File:Uml-action-da.jpg

2017-11-15T02:38:34Z

Knielar:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-15T02:38:06Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

Sending invitation to a particular student using their unity id as per below.

[[File:Invite_unity_id_before.png|frame|upright|center]]

Creating advertisements for joining a team (this is available only after signing up a topic).

[[File:A_by_teammate_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students who do not have a team yet or whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

== '''USE CASE SCENARIO''' ==

'''For Students'''

*USE CASE 1-
A student can create advertisement links for his/her team, which can be used by other students to join their team.

*USE CASE 2-
A student can click on an advertisement link to join a team

*USE CASE 3-
A student can view a list of advertisement links.

*USE CASE 4-
A student can respond to other students who requested to join his/her team by clicking on the invitation link.

*USE CASE 5-
A student can send an invite to other students to join his/her team using their unity ID.

*USE CASE 6-
A student can accept an invitation for joining a team.

*USE CASE 7-
A student can see a list of students without teams.

'''For Intructors'''

*USE CASE 1-
An Instructor can view a list of students without teams.

*USE CASE 2-
An Instructor can view a list of teams.

*USE CASE 3-
An Instructor can view a separate list of students who don’t have teams yet.

*USE CASE 4-
An Instructor can add a student to a team.

[[File:Uml-action-da.jpg|frame|upright|center]]

== Test Plan ==

=== Edge cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios

*If the team is full, the person who received an invitation link would not be able to accept that.
*If a student leaves a team, then he is able to see his previous teammates in the available list of students that do not have a complete team and have not created an invitation link.
*Student sees a horn icon in the last column if any of the students have created an advertisement for that topic.
*The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*A student can create an invitation link only if his team is not yet full.
*The same student who accepted the invitation link actually gets added to the team.
*A student won't be able to send the invitation to himself as he is already a member of that team.
*An instructor sees only the list of the students who do not have teams with invitation link.
*If a student joins a team using an invitation link, then he gets all the rights that a team member of that team has. Ex: Now, he will be able to approve a team join request and then correspondingly send the invitation for joining the group to that student.

== Visual representation of planned changes ==

Inviting students by creating an advertisement.

Once a student creates an advertisement, it would appear in the sign up sheet as below.
It would be visible to all other students visiting sign up sheet.

[[File:A_after.png|frame|upright|center]]

Once a student decides to respond to the advertisement, he clicks on the icon corresponding to the team and topic. He sees the description of the advertisement and a link to respond to it.

[[File:A_request_invitation_after.png|frame|upright|center]]

The student would be presented by a form as below once he/she chooses to request for an invitation.

[[File:A_response.png|frame|upright|center]]

Student would respond by completing the form and clicking on create. His request would be confirmed by showing a screen as below:

[[File:Join_request_after.png|frame|upright|center]]

Team receiving the request would see the incoming request on his "your team" view, from where he could send invites for joining the team.

*Note - this approach was considered to avoid random assignment of student into a team.
A student could chose more than 1 team to respond to their advertisements. In that case, the team accepting 1st would get the student into their team and it would be complex to handle the other invitations as the student who has sent the invitation would be juggling around or may not be able to choose the best fit.

*Our take - Each student may choose to respond to more than 1 advertisements but also should have choice of selecting teams as per their comfort.

When a student respond to an advertisement, the team receiving it should send an invitation if they find the student matching the criteria and the student then choose to accept one out of all the invitation he receives.

Below screenshots shows the steps:

The team who has got a response on their advertisement would see the incoming request, which they can accept or decline.

[[File:Received_request_after.png|frame|upright|center]]

Once the team accepts the invitation, an invite would be sent to the student to join the team. The team could see their sent invitation as below:

[[File:Sent_invitation_after.png|frame|upright|center]]

The student sees the invitation on his/her "your team" view as below:

[[File:Received_invitation_after.png|frame|upright|center]]

Once the student chooses to accept the invitation, he/she could click on the accept link, upon which the user would be presented with a prompt dialog to confirm the acceptance
as the student would be removed from the current team and placed into the team whose invitation he/she would accept.

[[File:Accept_invitation_after.png|frame|upright|center]]

Upon successful acceptance, he/she becomes a member of the team.

[[File:Accepted_request_after.png|frame|upright|center]]

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

File:Uml-advertisement.jpg

2017-11-15T02:35:20Z

Knielar:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-15T02:34:46Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave the original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

Sending invitation to a particular student using their unity id as per below.

[[File:Invite_unity_id_before.png|frame|upright|center]]

Creating advertisements for joining a team (this is available only after signing up a topic).

[[File:A_by_teammate_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students who do not have a team yet or whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view a list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

== '''USE CASE SCENARIO''' ==

'''For Students'''

*USE CASE 1-
A student can create advertisement links for his/her team, which can be used by other students to join their team.

*USE CASE 2-
A student can click on an advertisement link to join a team

*USE CASE 3-
A student can view a list of advertisement links.

*USE CASE 4-
A student can respond to other students who requested to join his/her team by clicking on the invitation link.

*USE CASE 5-
A student can send an invite to other students to join his/her team using their unity ID.

*USE CASE 6-
A student can accept an invitation for joining a team.

*USE CASE 7-
A student can see a list of students without teams.

'''For Intructors'''

*USE CASE 1-
An Instructor can view a list of students without teams.

*USE CASE 2-
An Instructor can view a list of teams.

*USE CASE 3-
An Instructor can view a separate list of students who don’t have teams yet.

*USE CASE 4-
An Instructor can add a student to a team.

[[File:Uml-advertisement.jpg|frame|upright|center]]

== Test Plan ==

=== Edge cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios

*If the team is full, the person who received an invitation link would not be able to accept that.
*If a student leaves a team, then he is able to see his previous teammates in the available list of students that do not have a complete team and have not created an invitation link.
*Student sees a horn icon in the last column if any of the students have created an advertisement for that topic.
*The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*A student can create an invitation link only if his team is not yet full.
*The same student who accepted the invitation link actually gets added to the team.
*A student won't be able to send the invitation to himself as he is already a member of that team.
*An instructor sees only the list of the students who do not have teams with invitation link.
*If a student joins a team using an invitation link, then he gets all the rights that a team member of that team has. Ex: Now, he will be able to approve a team join request and then correspondingly send the invitation for joining the group to that student.

== Visual representation of planned changes ==

Inviting students by creating an advertisement.

Once a student creates an advertisement, it would appear in the sign up sheet as below.
It would be visible to all other students visiting sign up sheet.

[[File:A_after.png|frame|upright|center]]

Once a student decides to respond to the advertisement, he clicks on the icon corresponding to the team and topic. He sees the description of the advertisement and a link to respond to it.

[[File:A_request_invitation_after.png|frame|upright|center]]

The student would be presented by a form as below once he/she chooses to request for an invitation.

[[File:A_response.png|frame|upright|center]]

Student would respond by completing the form and clicking on create. His request would be confirmed by showing a screen as below:

[[File:Join_request_after.png|frame|upright|center]]

Team receiving the request would see the incoming request on his "your team" view, from where he could send invites for joining the team.

*Note - this approach was considered to avoid random assignment of student into a team.
A student could chose more than 1 team to respond to their advertisements. In that case, the team accepting 1st would get the student into their team and it would be complex to handle the other invitations as the student who has sent the invitation would be juggling around or may not be able to choose the best fit.

*Our take - Each student may choose to respond to more than 1 advertisements but also should have choice of selecting teams as per their comfort.

When a student respond to an advertisement, the team receiving it should send an invitation if they find the student matching the criteria and the student then choose to accept one out of all the invitation he receives.

Below screenshots shows the steps:

The team who has got a response on their advertisement would see the incoming request, which they can accept or decline.

[[File:Received_request_after.png|frame|upright|center]]

Once the team accepts the invitation, an invite would be sent to the student to join the team. The team could see their sent invitation as below:

[[File:Sent_invitation_after.png|frame|upright|center]]

The student sees the invitation on his/her "your team" view as below:

[[File:Received_invitation_after.png|frame|upright|center]]

Once the student chooses to accept the invitation, he/she could click on the accept link, upon which the user would be presented with a prompt dialog to confirm the acceptance
as the student would be removed from the current team and placed into the team whose invitation he/she would accept.

[[File:Accept_invitation_after.png|frame|upright|center]]

Upon successful acceptance, he/she becomes a member of the team.

[[File:Accepted_request_after.png|frame|upright|center]]

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

==Team Information==
[mailto:tpahuja@ncsu.edu Tushar Pahuja] 
[mailto:pmgandh2@ncsu.edu Pragam Manoj Gandhi] 
[mailto:knielar@ncsu.edu Nielarshi Kumar] 
[mailto:abhardw3@ncsu.edu Abhishek Bhardwaj]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T20:12:29Z

Knielar:

== About Expertiza ==

Expertiza is a Ruby on Rails based Open Source project. It is a collaboration tool which lets users with different roles (student, instructor, teaching assistant) to collaborate on a course in an institution. A collaboration could be for an assignment where students teams up for an assignment and instructors grades them on the basis of their submission. Students could review other's works and give feedback as well.

===Github link===
*https://github.com/expertiza/expertiza

===Wiki link===
*http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

==='''Problem Statement'''===
*For team-based assignments, it always takes time to find suitable team members.

*We already have bidding, which could help you to join in a team with other team members hold similar bidding preferences. However, a student may not be satisfied with automated team formation and want to switch to another team.

*'''In this project, we will build a new feature to help students find teams to join.'''

Currently, there are 2 ways to find other students to join your team:

*If your team is not full, you could invite people by inputting his/her UnityID. It will send an invitation to a certain user. If s/he accept your invitation,s/he will leave original team and join your team.

*You could create an advisement by clicking “Your team” link and then clicking “Create” link under “Advertisement for teammates” section. Then your advertisement will appear the last column of the signup sheet page with a horn icon. In this way, all classmates could see your advisement. Someone could send a request to join your team. If you accept their request, s/he will leave original team and join in your team.

Below screenshots represents the description above.

Student: Advertisement icon doesn't appear in Chrome browser.

[[File:A_chrome_before.png|frame|upright|center]]

Instructor: Advertisement icon doesn't appear in Chrome browser.

[[File:A_instructor_cr_before.png|frame|upright|center]]

Advertisement icon appears in Mozilla browser but not in the cell it should appear rather it is visible under "Actions" column.

[[File:A_mozilla_before.png|frame|upright|center]]

Sending invitation to a particular student using their unity id as per below.

[[File:Invite_unity_id_before.png|frame|upright|center]]

Creating advertisements for joining a team (this is available only after signing up a topic).

[[File:A_by_teammate_before.png|frame|upright|center]]

'''Change Request requirements:'''
*Students who do not have a team yet or whose team is not full yet to be able to see a list of students who don’t already have teams.
*Students should have an option of inviting other students to join their teams.
*Instructors should be able to view list of students who don't have teams.

== Task Description ==

====Change Request 1====
Fix the second way to find other students to join your team. Currently, after you create an advertisement, the horn icon does not appear in the the last column of the signup sheet.

====Change Request 2====
For student end: Display a list of students who do not have a team with invitation links in student_teams#view page ○ You could invite students to your team by clicking invitation links. If s/he accept your invitation,s/he will leave the original team and join in your team. It will be more straightforward than typing UnityID.

====Change Request 3====
For instructor end: Display a list of students who do not have team with invitation links in teams#list page

== Test Plan ==

=== Edge cases ===

We will be writing automated tests to check if the changes made are working correctly.

For that, we considered the following scenarios

*If the team is full, the person who received an invitation link would not be able to accept that.
*If a student leaves a team, then he is able to see his previous teammates in the available list of students that do not have a complete team and have not created an invitation link.
*Student sees a horn icon in the last column if any of the students have created an advertisement for that topic.
*The list of students contains only those students who don't have a team yet or whose team is not yet complete and who have not created an advertisement link.
*A student can create an invitation link only if his team is not yet full.
*The same student who accepted the invitation link actually gets added to the team.
*A student won't be able to send the invitation to himself as he is already a member of that team.
*An instructor sees only the list of the students who do not have teams with invitation link.
*If a student joins a team using an invitation link, then he gets all the rights that a team member of that team has. Ex: Now, he will be able to approve a team join request and then correspondingly send the invitation for joining the group to that student.

== Visual representation of planned changes ==

Inviting students by creating an advertisement.

Once a student creates an advertisement, it would appear in the sign up sheet as below.
It would be visible to all other students visiting sign up sheet.

[[File:A_after.png|frame|upright|center]]

Once a student decides to respond to the advertisement, he clicks on the icon corresponding to the team and topic. He sees the description of the advertisement and a link to respond to it.

[[File:A_request_invitation_after.png|frame|upright|center]]

The student would be presented by a form as below once he/she chooses to request for an invitation.

[[File:A_response.png|frame|upright|center]]

Student would respond by completing the form and clicking on create. His request would be confirmed by showing a screen as below:

[[File:Join_request_after.png|frame|upright|center]]

Team receiving the request would see the incoming request on his "your team" view, from where he could send invites for joining the team.

*Note - this approach was considered to avoid random assignment of student into a team.
A student could chose more than 1 team to respond to their advertisements. In that case, the team accepting 1st would get the student into their team and it would be complex to handle the other invitations as the student who has sent the invitation would be juggling around or may not be able to choose the best fit.

*Our take - Each student may choose to respond to more than 1 advertisements but also should have choice of selecting teams as per their comfort.

When a student respond to an advertisement, the team receiving it should send an invitation if they find the student matching the criteria and the student then choose to accept one out of all the invitation he receives.

Below screenshots shows the steps:

The team who has got a response on their advertisement would see the incoming request, which they can accept or decline.

[[File:Received_request_after.png|frame|upright|center]]

Once the team accepts the invitation, an invite would be sent to the student to join the team. The team could see their sent invitation as below:

[[File:Sent_invitation_after.png|frame|upright|center]]

The student sees the invitation on his/her "your team" view as below:

[[File:Received_invitation_after.png|frame|upright|center]]

Once the student chooses to accept the invitation, he/she could click on the accept link, upon which the user would be presented with a prompt dialog to confirm the acceptance
as the student would be removed from the current team and placed into the team whose invitation he/she would accept.

[[File:Accept_invitation_after.png|frame|upright|center]]

Upon successful acceptance, he/she becomes a member of the team.

[[File:Accepted_request_after.png|frame|upright|center]]

All other students who have not created advertisements, each student would see their list on their "your team" view so that they could invite them by an easy "Invite" link as displayed below:

[[File:Invite_unity_id_after.png|frame|upright|center]]

[[File:Join_request_main_page_after.png|frame|upright|center]]

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T18:57:17Z

Knielar:

File:A response.png

2017-11-06T18:55:31Z

Knielar:

File:A request invitation after.png

2017-11-06T18:55:09Z

Knielar:

File:A mozilla before.png

2017-11-06T18:54:46Z

Knielar:

File:A mozilla after.png

2017-11-06T18:54:19Z

Knielar:

File:A instructor cr before.png

2017-11-06T18:53:36Z

Knielar:

File:A chrome before.png

2017-11-06T18:53:07Z

Knielar:

File:A by teammate before.png

2017-11-06T18:52:37Z

Knielar:

File:A after.png

2017-11-06T18:52:12Z

Knielar:

File:Advertisement instructor cr before.png

2017-11-06T18:47:19Z

Knielar:

File:Advertisement instructor chrome before.png

2017-11-06T18:43:30Z

Knielar: uploaded a new version of "File:Advertisement instructor chrome before.png"

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T05:09:26Z

Knielar:

File:Advertisement mozilla before.png

2017-11-06T05:05:39Z

Knielar: uploaded a new version of "File:Advertisement mozilla before.png"

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T05:04:23Z

Knielar:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T05:02:23Z

Knielar:

CSC/ECE 517 Fall 2017/E1793. Help students find teams to join Team1964

2017-11-06T04:52:13Z

Knielar:

File:Sent invitation after.png

2017-11-06T04:41:09Z

Knielar:

File:Received request after.png

2017-11-06T04:37:53Z

Knielar: