Documentation

Installs #

AKAWN Server #

The following is required:

  1. The name of the SQL Server instance which will host the AKAWN repository database and the SQL Server instance must be available and contactable from this machine.
  2.  

  3. Either a domain account or a local user account which the AKAWN Server service will run as. Local system accounts are not permitted i.e. Local Service, Network Service, Local System etc.
  4.  

  5. Either the AKAWN Server service account (requirement 2) or a SQL login will need sysadmin access to the SQL Server instance (requirement 1). It is recommended to use Windows Authentication and a dedicated secure account for the AKAWN Server service.
  6.  

  7. The setup should be run by a local administrator to ensure the service creation and AKAWN folder permissions are successful.

 

 
Review the License Agreement before proceeding

 

 

 

 
Below shows what a local non-domain install would look like i.e. the AKAWN Server is on the same machine as the SQL Server instance which will contain the AKAWN repository database
 
Both the Service and Instance permission checks (see above requirements) must succeed for the setup to be successful

 

 

 
Once the setup have completed, it is a good idea to verify the AKAWN Server service has been created and is running

 

 
The AKAWN Server log.txt file can be reviewed if you have experienced an issue with the AKAWN Server service starting

 
After the install, Config.bat, in the same folder as the log.txt file, can be used if adjustments are needed for the AKAWN Server service.

Yes No

AKAWN Studio #

The following is required:

  1. The AKAWN Server service will need to have been installed and configured.
  2.  

  3. The name of the SQL Server instance which will host the AKAWN repository database (created by requirement 1) is required during startup of AKAWN Studio. The SQL Server instance must be available and contactable from this machine.
  4.  

  5. The version of AKAWN Studio and AKAWN Server must match or AKAWN Studio will advise of a version mismatch issue and exit.
  6.  

  7. Either your account or a SQL login will need to be granted db_datareader and db_datawriter fixed database roles access to the AKAWN repository database (created by requirement 1). If you do not have appropriate permissions to access the AKAWN database, you will not be able to use AKAWN Studio.

 

 
Review the License Agreement before proceeding

 

 

 

 

 
Start AKAWN Studio via the desktop shortcut

 
Connect to the SQL Server instance which is hosting the AKAWN repository database. This database would have been created when AKAWN Server was installed

 
Once connected, you’ll have the option to receive email/page notifications. The following walks you though configuring this

 
Enter your mail server details and select Save and Test

 
Attempt to send a test email

 
If successful, you’ll receive the email and the following message

 
As per the prompt, you can now set the email/page address which will be used when SQL Server instances are added

 

 

 
Below shows adding a SQL Server instance to be monitored

 
The AKAWN Server service account will need to be a local administrator on the server to be monitored.
 
If Windows Authentication is being used, the service account will need to be a sysadmin in the SQL Server instance. If SQL Authentication is being used, the SQL login will need to be a sysadmin in SQL Server instance. These permissions are verified before you can monitor the instance.
 
Once the permissions have been validated, place the Instance in a folder of your choice.

Yes No

AKAWN Studio #

Connect #

Select the AKAWN Studio icon on the desktop or start menu

You will be presented with the AKAWN Database Connection screen

1. Name of the instance which is hosting the AKAWN repository database. This would have been created during the AKAWN Server install.
2. Authentication method for connecting, this is either Windows (recommended) or SQL Server
3. User name or SQL Server login name depending of the Authentication method specified
4. If SQL Server authentication was specified, you’ll be asked for a password.
5. If SQL Server authentication was specified, you can decide if you’d like to save the password for when next connecting.
6. Attempt to connect to the AKAWN repository database
7. Exit AKAWN Studio
8. Show the current state and if any issues were encountered
 
You may receive the following prompt if your email configuration if not been successfully tested

A. If selected you will not be prompted again
B. This will take you to the Mail Server settings
C. The prompt will be closed
 
To help ensure the monitoring is working the following issue prompt may be received if the AKAWN Server service appears to be stopped

Yes No

Main Screen #


1. Options menu
2. Add a SQL Server instance to be monitored
3. Remove SQL Server instance(s) from being monitored
4. Manage logical folders under the Environment tree
5. Manage collected data retention settings
6. Notifications address book
7. User tags
8. Global settings
9. Environment tree which will host the monitored instances
10. Current connectivity status. Placing your mouse over the button will show additional information
11. Indicates when the dashboard was last refreshed (currently every 60 seconds)
12. Licensing information
13. Dashboard screen
14. Minimize, Maximized/Restore and Close buttons

Yes No

Settings #


It is recommended to review the global settings before adding your first monitored instance

Yes No

Mail Server #


1. Your mail server
2. Your mail server port number
3. Indicate if SSL should be used
4. From address on messages sent from the AKAWN Server
5. Authentication requirements for your mail server
6. Indicates if your mail server has been successfully tested
7. This option will only show once you’ve entered mail server details for testing. When selected, the details will be stored for use by the AKAWN Server and the following prompt will appear:

NOTE: The AKAWN Server service must be started for this test.
A. Email address to send the test email
B. Subject of the email (read-only)
C. Body of the email
D. Attempt to send
A successful send will present the following prompt, the specified email address should receive the test message and the Mail Server tab indicate ‘Successfully tested’


E. Close
8. Closes Settings

Yes No

Email / Page Notifications #


1. Email messages within the interval will be consolidated into a single email
2. Page messages within the interval will be consolidated into a single page
3. Interval heartbeat for WMI queues on the monitored instances
4. Set a restriction on alerts per email if email send size issues occur
5. Indicate who will be notified when the AKAWN Server service starts/stops
6. Indicated who will be the default recipient of emails/pages when a new monitored instance is added
Selecting Change presents an option to add/select an email/page address

7. Close Settings

Yes No

License / About #


1. Indicates the current AKAWN Monitoring version
2. Who the product is licensed to (blank if trial)
3. Maximum monitored instances (1 if trial)
4. Support date for when free updates end (relevant for licensed version)
5. Used to enter a supplied license key
6. Close Settings

Yes No

AKAWN Server #


1. Indicates the SQL Server instance hosting the AKAWN repository database
2. Indicates the Windows machine hosting the AKAWN Server service.
3. Close Settings

Yes No

Data Retention #


1. Alert and Trend data will only be kept for the specified number of days
2. Email and page data will only be kept for the specified number of days
3. If there is data to be remove, this is the time of day it will be removed
4. Close Settings

Yes No

Add Instance #



NOTE: If you need to enter a port number please use the Advanced button
1. Name of the instance to monitor.
2. Authentication method that the AKAWN Server service should use to connect to the monitored instance
3. Enter SQL Server login if SQL Server authentication was specified
4. Enter the SQL Server login password if SQL Server authentication was specified
5. If a port number other than 1433 is required to connect to the monitored instance, use this button
6. Test that the SQL Server service can connect to the instance and it has appropriate permissions (sysadmin for the instance and local administrator for the machine)
7. Cancel adding the instance

8. Indicates that AKAWN Server was able to connect to the instance as a sysadmin
9. Indicates that AKAWN Server service is local administrator on the monitored machine
10. Logical folder name of your choice to place the monitored instance in
11. Add the instance and start monitoring

12. Environment tree with logical folder, host and instance
13. Host machine summary issue tally table
14. Instance summary issue tally table

Yes No

Remove Instance #



1. Select monitored instance(s) to remove
2. Remove instance along with all collected data for that instance
3. Close

Yes No

Manage Folders #



1. Names of folders currently available
2. Number of monitored instances in the folders
3. Change the folder name
4. Adjust the folder order
5. Remove the folder. Note that this can only be achieved if it contains no instances
6. Change the folder assignment for the instance
7. Add a new folder
8. Close

Yes No

Data Removal #



1. Alert and Trend data will only be kept for the specified number of days
2. Specified number of days that collected queries will be kept
3. Host this removal policy applies to (the Instance column will be blank)
4. Instance this removal policy applies to (both the Server and Instance columns will be populated)
5. Close

Yes No

Notifications Address Book #



1. Logical name of contact
2. Type of contact, email or page
3. Actual address of the contact
4. Edit the contact
5. Delete the contact
6. Add a new contact

A. Logical name of contact
B. Actual address of the contact
C. Type of contact, email or page
D. Save
E. Close
7. Close

Yes No

Tags #



1. Tag colour
2. Name of the tag
3. Edit the name and/or colour
4. Delete the tag
5. Add a new tag

A. Available tags
B. Name for the tag
C. Close
6. Close

Yes No

Environment Tree #

Yes No

Environment #

Environment Dashboard #


Note: The Environment Dashboard Tab which shows alerts for the past 24 hours and is updated every 60 seconds
1. Logical folder associated with the Host machine and SQL Server instance
2. Host machine (notice that it doesn’t have an instance name)
3. Name of the SQL Server instance
4. Host and Instance alerts (unacknowledged alerts / total alerts)
5. Importance of the alert
6. Name of the alert
7. Occurrences of this alert at the collect time
8. Acknowledge that the alert has been looked at
9. When the alert was recollected
10. Details of the alert i.e.

A. Name of the instance
B. Importance of the alert
C. Name of the alert
D. Details specific to the alert
E. Add a known exception if this and future alerts can be ignored i.e.

1. Name of the instance
2. Name of the alert
3. Enable/disable this exception
4. Enable/disable the specific exception
5. Field in the alert (this will vary depending on the alert)
6. Condition to be met for the alert to be excluded i.e. NOT EQUAL TO, NOT IN or NOT LIKE
7. Shows captured events for the selected Field
8. The actual exception that will be used
9. Reason for this exception
10. Delete the exception
11. Days on the week that this exception is valid
12. Time of days that the exception is valid
13. Add another exception line
14. Save the exception
15. Close
F. Close

Yes No

Instance Properties #


1. Lists all monitored instances along with 40+ properties
2. Select which property columns to show

Yes No

Folder #

Folder Dashboard #


Information is currently being tested

Yes No

Host #

Server Alerts Dashboard #


1. Name of host machine
2. Select all rows
3. Unselect all rows
4. Set the cause for all selected rows

A. Name of the host machine
B. Existing causes for the host machine
C. Short description of the cause
D. Detailed description of the cause
E. Save the cause
F. Close
5. Associate a tag will all selected rows
6. Tick acknowledge and hide all selected rows
7. Refresh the rows with the latest collected data
8. Refresh the rows at the set interval
9. Show/hide hidden rows
10. Set the period of alerts to show
11. Select rows
12. Importance indication of the alert
13. When the alert was collected
14. Name of the alert
15. Short description of the alert
16. Acknowledge that the alert has been reviewed
17. Hide the row
18. Tag a resource to the row
19. Show details of the alert i.e.

20. Set a cause for the alert
21. Set an exception for the alert i.e.

22. Configure the host machine alerts

A. Name of the host machine
B. Apply email contact to all alerts
C. Apply page contact to all alerts
D. Category type of the alert
E. Alert name
F. Enable/disable the alert
G. Designate an importance for the alert
H. Who the alert will email
I. Who the alert will page
J. Last occurrence of the alert
K. Last email sent
L. Last page sent
M. Occurrences of this alert
N. Add an exception i.e.

O. Adjust when the alert will run and check for issues i.e.

P. Description of the schedule
Q. Show/hide alerts based on category
R. Close

Yes No

Server Charts #


1. Specify period of host machine performance counters to review
2. Review with latest data
3. Key host charts for Disk, Memory, CPU, Network, Processes and Uptime
4. Live data trending i.e.

A. Name of the host machine
B. Start, pause or stop live trending
C. Sample period interval
D. Keep data for the specified period
E. All charts shown
F. Close

Yes No

Instance #

Instance Configuration Settings #


1. Name of instance
2. Microsoft configuration ID
3. Name of the configuration
4. Set value of the configuration
5. Value in use by the configuration
6. Potential issues are visually highlighted

Yes No

Query Activity #


1. Available query collections for review
2. Show the selected query collection(s)
3. Display/hide request columns
4. Display/hide session columns
5. Display/hide connection columns
6. Display/hide task columns
7. Display/hide sleeping requests
8. Display/hide non-user requests
9. Display/hide query plans
10. Collected information based on selections
11. Full statement, if available
12. Query plan, if available
13. Statement section being processed, if available
14. Missing index, if available
15. Relevant locks, if available
16. Relevant waits, if available
17. Request settings, if available
18. Session settings, if available
19. Refresh the available query collections list
20. Delete the selected query collection(s)
21. Schedule when query collection occurs

22. Perform/stop a manual query collection

Yes No

Top Missing Indexes #


1. Refresh collected information
2. Schedule when missing indexes are checked for i.e.

Yes No

Top CPU Use #


1. Refresh the collected data
2. Set the schedule for collecting data
3. Information on the findings
4. Query associated with the findings

Yes No

Top IO Use #


1. Refresh the collected data
2. Set the schedule for collecting data
3. Information on the findings
4. Query associated with the findings

Yes No

Top Unused Indexes #


1. Refresh collected information
2. Schedule when unused indexes are checked for

Yes No

Databases #

Database Configuration Settings #


1. Name of the instance
2. 40+ database properties
3. Visual indicators of potential issues
4. Show/hide database properties
5. Review captured database changes i.e.

Yes No

Indexes #


1. Specify period of information to review
2. Hide/show databases
3. Display/hide indexes/heaps
4. Collected information based on selections
5. Trend information for the selected index/heap
6. Initiate collection of index information
7. Refresh collected information

Yes No

Maintenance #

Maintenance Dashboard #

Yes No

Backups #


1. Name of the instance
2. Specify the default backup path for new databases
3. Enable Full, Log or Differential backups for all databases
4. Disable Full, Log or Differential backups for all databases
5. Run the specified backups now for selected databases
6. Show addition options for the backups i.e. below are additional options for Full backups

7. Enable Full backups for the database
8. Enable Log backups for the database
9. Enable Differential backups for the database
10. Advises when the last backups occurred. Notice that there are backup smarts i.e. transaction log backups are not performed for Simple recovery databases etc
11. Visual indicators when databases are involved with database mirroring, availability groups, snapshots, offline etc
12. Set schedules for the backup types
13. Refresh the backup table to show last backup timings
14. If selected, newly added databases will have the same backup options selected as the model database
15. Review recent backup history i.e.

Yes No

Indexing #


1. Name of the instance
2. Enable all databases for index maintenance
3. Disable index maintenance for all databases
4. Start index maintenance now for selected databases
5. Enable/disable index maintenance for databases
6. Index maintenance options
7. Index maintenance timing information
8. Visual indicators for potential issues
9. Schedule when index maintenance occurs
10. View recent index maintenance history i.e.

11. Refresh the index maintenance view
12. If selected, newly added databases will have the same index maintenance options selected as the model database
13. Close

Yes No

Integrity Checks #


1. Name of the instance
2. Enable integrity checks for all databases
3. Disable integrity checks for all databases
4. Start integrity checks now for selected databases
5. Enable/disable integrity checks for the databases
6. Visual indicators for potential issues
7. Integrity check type
8. Integrity check timing information
9. Set integrity check schedule
10. View recent integrity check history i.e.

11. Refresh the integrity check view
12. If selected, newly added databases will have the same integrity check options selected as the model database
13. Close

Yes No

Trend #

Statistics #


As shown, besides the Statistics tab, there a several other trend tabs covering all aspects of instance activity
1. Specify period of information to review
2. Refresh and view live performance data i.e.

A. Name of the instance
B. Start, pause or stop live trending
C. Sample period interval
D. Keep data for the specified period
E. All charts of the tab are shown
F. Close

Yes No

Custom Charts #


1. Name of the instance
2. Logically group charts for quick analysis of areas of interest to you
3. Select from hundreds of SQL Server and Host machine performance counters and present as either a single series, multi series, area / bar charts, 3D i.e.


4. Hide/show charts
5. Hide/show columns
6. Specify periods of interest
7. Set a screen refresh schedule
8. Select/Unselect/Hide/Delete all rows
9. Edit/Delete charts and review current data collection
10. Reorder charts
11. Show live data for all charts

Yes No

Alerts #

Instance Alerts Dashboard #


1. Name of the instance
2. Select all rows
3. Unselect all rows
4. Set the cause for all selected rows

A. Name of the instance
B. Existing causes for the instance
C. Short description of the cause
D. Detailed description of the cause
E. Save the cause
F. Close
5. Associate a tag for all selected rows
6. Tick acknowledge and hide all selected rows
7. Refresh the rows with the latest collected data
8. Refresh the rows at the set interval
9. Show/hide hidden rows
10. Set the period of alerts to show
11. Select rows
12. Importance indication of the alert
13. When the alert was collected
14. Name of the alert
15. Short description of the alert
16. Acknowledge that the alert has been reviewed
17. Hide the row
18. Tag a resource to the row
19. Show details of the alert i.e.

20. Set a cause for the alert
21. Set an exception for the alert i.e.

22. Configure the host machine alerts

A. Name of the host machine
B. Apply email contact to all alerts
C. Apply page contact to all alerts
D. Category type of the alert
E. Alert name
F. Enable/disable the alert
G. Designate an importance for the alert
H. Who the alert will email
I. Who the alert will page
J. Last occurrence of the alert
K. Last email sent
L. Last page sent
M. Occurrences of this alert
N. Add an exception i.e.

O. Adjust when the alert will run and check for issues i.e.

P. Description of the schedule
Q. Show/hide alerts based on category
R. Close

Yes No

Notifications #

Emails #

Emails consist of a summary table and alert information for the collection period i.e.

Yes No

Pages #

Pages consist of the alert and number of occurrences for the check period i.e.

Yes No