EsgynDB Manager User Guide - Home - Esgyn · PDF fileEsgynDB Manager User Guide ... OpenTSDB to query the time series metrics. TSD Port Only enabled and used in Enterprise Edition

EsgynDB Manager User GuideVersion 2.0.0

Table of Contents1. Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.2. Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2. Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3. Install and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.1. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.2. Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3.3. Start EsgynDB Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

3.4. Stop EsgynDB Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

3.5. Log settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.6. Check Status of EsgynDB Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.7. Display EsgynDB Manager Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4. Using EsgynDB Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.1. Connecting to EsgynDB Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4.2. Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.3. Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.4. Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.4.1. Service Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.4.2. Node Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.5. Workloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.5.1. Active Workloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.5.2. Active Query Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.5.3. Historical Workloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.5.4. Historical Query Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.5.5. Query Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

4.5.6. Cancel Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4.6. Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

4.7. DCS Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.8. Query Workbench . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

4.8.1. Execute Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.8.2. Explain Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.8.3. Control Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.9. Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

4.9.1. Alert Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.10. About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

4.11. Log Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

5. Troubleshooting and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

5.1. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

5.2. Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

© Copyright 2015 Esgyn Corporation

The information contained herein is subject to change without notice. Thisdocumentation is distributed on an "AS IS" basis, without warranties or conditionsof any kind, either express or implied. Nothing herein should be construed asconstituting an additional warranty. Esgyn Corporation shall not be liable fortechnical or editorial errors or omissions contained herein.

Revision History

2.0.0 21Nov2015

1

1. Getting Started

1.1. IntroductionEsgynDB Manager is a web based enterprise management tool for EsgynDB. DB Manager allows theuser to monitor the health and status of EsgynDB services and workloads.

1.2. Features• Dashboard

◦ Monitor runtime status of EsgynDB services

◦ Monitor runtime status of EsgynDB Nodes

◦ Time-series charts for monitoring key system and HBase metrics. ( * only in EsgynDB EnterpriseEdition)

• Workloads

◦ Monitor Active queries

◦ Drill-down into runtime statistics for a specific active query

◦ View historical query statistics from repository

◦ Drill-down into detailed query metrics

◦ View visual explain plan for historical queries

◦ Cancel queries that are impacting the system

• Logs

◦ View EsgynDB logs via logs TMUDF

• DCS Servers

◦ View connected and available DCS Servers

• Query Workbench

◦ Execute adhoc queries

◦ Generate visual and textual explain plans

◦ Support for CQDs

• Alerts ( * only in EsgynDB Enterprise Edition)

◦ View Alert notifications

◦ Acknowledge and update alerts

2

2. ArchitectureThe EsgynDB Manager is a web application that monitors and manages an EsgynDB instance. Thearchitecture is very flexible and lightweight.

• DB Manager runs as an embedded jetty webserver. No additional packages to install.

• Communication with EsgynDB core is through JDBC and HTTP requests.

• Webserver code is 100% Java.

• The web client layer uses HTML5/JavaScript/CSS.

• Client to DB Manager webserver communication uses HTTPS encryption.

• Uses JDBC Authentication.

• EsgynDB Manager has been tested with Chrome, IE11, Firefox and Microsoft Edge browsers.

• When you connect up to an Enterprise Edition of EsgynDB, you get additional manageabilitycomponents that use OpenTSDB, TCollector and Bosun. DB Manager uses these manageabilitycomponents to display system monitoring metrics and report alert notifications.

OpenTSDB

We use OpenTSDB to store time-series metrics. The system health and performance metrics aswell the health and performance of EsgynDB services as periodically collected as time-seriesdata and published into OpenTSDB.

TCollector

TCollector provides several scripts to measure system health and performance and also anextensible infrastructure to launch scripts at pre-defined intervals. The metrics are publishedinto OpenTSDB.

Bosun

Bosun is an alerting and notification engine. It uses the metrics in OpenTSDB and based on therules and notifications template you configure, it can send out email or HTTP notifications.

3

Figure 1: EsgynDB Manager Architecture

3. Install and ConfigurationThis chapter describes how to install EsgynDB Manager and configure its runtime properties. Theinstructions vary depending on the version of EsgynDB you are running.

3.1. Installation• If you are using EsgynDB Enterprise Edition, DB Manager is already installed along with the core

EsgynDB components. No additional install steps are required. EsgynDB Manager is installed in$MY_SQROOT/dbmgr-2.0.0 folder.

• If you running a non-enterprise edition of EsgynDB or Apache Trafodion, you can install DBManager as an add-on product. You can obtain a licensed version of DB Manager by contactingEsgyn.

4

◦

Download the EsgynDB Manager binary dbmgr-2.0.0.tar.gz file to your target system.

◦ Extract the contents to the target directory. A dbmgr-2.0.0 sub-directory will be created.

$ tar xfz dbmgr-2.0.0.tar.gz

3.2. ConfigurationEsgynDB Manager communicates with the EsgynDB runtime via ODBC or HTTP. DB Manager uses aconfiguration file that can be customized for your runtime environment.

• If you are using EsgynDB Enterprise Edition, the EsgynDB Installer will configure the necessarysettings. No additional configuration is required. But you can refer to the rest of this section tounderstand what properties are configured and how they are used by DB Manager.

• For a stand-alone install of DB Manager, you will need to explicitly configure DB Manager using thefollowing steps:

◦ Find the canonical timezone name of the EsgynDB instance. DB Manager displays all date timevalues in the EsgynDB server local time. You can use the handy script gettimezone.sh that isprovided in the dbmgr-2.0.0/bin directory to find the canonical timezone name like Etc/UTC orAmerica/Los_Angeles. This script is also available in the $MY_SQROOT/tools directory on theEsgynDB nodes.

$ cd dbmgr-2.0.0/bin$ ./gettimezone.shAmerica/New_York

◦ Run the configure.py script from the bin directory.

$ cd dbmgr-2.0.0/bin $ ./configure.py

◦ This script will prompt for the runtime properties.

HTTP Port

This is the port the EsgynDB Manager embedded Jetty server binds to waiting for client HTTPconnections. The value may need to be changed if this port number conflicts with otherports in use on your cluster. The default value is 4205.

HTTPS Port

This is the port the EsgynDB Manager embedded Jetty server binds to waiting for clientHTTPS connections. The value may need to be changed if this port number conflicts with

5

other ports in use on your cluster. The default value is 4206.

SSL Keystore Password

A self-signed certificate will be generated and stored in a SSL keystore using the providedpassword. The password is obfuscated and the SSL keystore is saved as dbmgr-2.0.0/etc/dbmgr.keystore.

DCS Master Host

The hostname or IP address for the node on which DCS Master is listening. DB Manager usesthis property to make a JDBC connection.

DCS Master Listen Port

The listen port number for DCS Master. DB Manager uses this property to make a JDBCconnection. The default value is 23400.

DCS Master Info Port

The info port number for DCS Master. This DCS Web UI is accessible using this port and weuse the DCS Web UI for viewing the DCS logs. The default value is 24400.

REST Server Host

The hostname or IP address for the node on which EsgynDB REST server is listening.

REST Server Port

The listen port number for EsgynDB REST Server. The default value is 4200.

TSD Host

Only enabled and used in Enterprise Edition. The hostname or IP address for the node onwhich TSD is listening. DB Manager uses this property to make a HTTP connection toOpenTSDB to query the time series metrics.

TSD Port

Only enabled and used in Enterprise Edition. The listen port number for TSD. DB Manageruses this property to make a HTTP connection to OpenTSDB to query the time series metrics.The default value is 5242.

Bosun Host

Only enabled and used in Enterprise Edition. The hostname or IP address for the node onwhich Bosun notification engine is listening. DB Manager uses this property to make a HTTPconnection to Bosun to query and update alert notifications.

Bosun Port

Only enabled and used in Enterprise Edition. The listen port number for Bosun. Thedefault value is 8070.

Server TimeZone Name

6

The canonical timezone name of the EsgynDB instance. DB Manager displays all date timevalues in the EsgynDB server local time. The timezone name has to be in the canonicalformat like Etc/UTC or America/Los_Angeles. You can use the handy script gettimezone.shto find the canonical timezone of the instance.

◦ The generated configuration is saved in dbgmr-2.0.0./conf/config.xml. A sample configurationis shown below.

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

<properties>

 <entry key="jdbcUrl">jdbc:t4jdbc://my.esgyndb.server:23400/:</entry>

 <entry key="jdbcDriverClass">org.trafodion.jdbc.t4.T4Driver</entry>

 <entry key="trafodionRestServerUri">my.esgyndb.server:4200</entry>

 <entry key="dcsMasterInfoUri">http://my.esgyndb.server:24400</entry>

 <entry key="sessionTimeoutMinutes">120</entry>



 <entry key="httpPort">4205</entry>

 <entry key="httpsPort">4206</entry>

 <entry key="securePassword">OBF:1iup1igf1x8a1tvj1x8k1idr1irx</entry>



7

<entry key="requestHeaderSize">98304</entry>

 <entry key="timeZoneName">America/New_York</entry>

 <entry key="openTSDBUri">my.esgyndb.server:5242</entry>

 <entry key="enableAlerts">true</entry>

 <entry key="alertsUri">my.esgyndb.server:8070</entry></properties>

3.3. Start EsgynDB Manager• In EsgynDB Enterprise Edition, sqstart script will automatically start DB Manager.

• For a stand-alone install of DB Manager, you will need to start EsgynDB Manager as an embeddedjetty server using the dbmgr.sh script.

$ cd dbmgr-2.0.0/bin./dbmgr.sh start

If the EsgynDB Manager starts successfully, you should see a prompt like below:

EsgynDB Manager is running. PID is 3391.

If the start fails, you see a message like this. Check the dbmgr.log for errors.

EsgynDB Manager is NOT running. Check dbmgr.log.

3.4. Stop EsgynDB Manager• In EsgynDB Enterprise Edition, sqstop script will automatically stop DB Manager.

• In a stand-alone install of DB Manager, you can stop EsgynDB Manager with the followingcommand from the bin directory.

8

$ ./dbmgr.sh stopEsgynDB Manager has been stopped.

3.5. Log settingsDB Manager uses logback for its logging. You can edit the dbmgr-2.0.0/conf/logback.xml to changerate at which the log files are rolled and to change the level at which the server logs messages. After asuccessful start, the EsgynDB Manager runtime logs are written in the dbmgr-2.0.0/logs directory.

3.6. Check Status of EsgynDB ManagerTo check the state of EsgynDB Manager, run the following command from the bin directory.

$ ./dbmgr.sh statusEsgynDB Manager is running. PID is 3391.

3.7. Display EsgynDB Manager VersionTo display the version of EsgynDB Manager, run the following command from the bin directory.

$ ./dbmgr.sh versionEsgynDB Manager Release 2.0.0 (Branch 0e9aa50-Ent2.0, Date 11Oct2015)

4. Using EsgynDB ManagerThis chapter describes how to connect to EsgynDB Manager and use its features.

4.1. Connecting to EsgynDB ManagerOpen a web browser and point to the host name on which EsgynDB Manager is running. You can useeither the HTTP port or the HTTPS port number set in the EsgynDB Manager config file. If you use theHTTP port, the request is automatically redirected to the HTTPS port.

http://my.esgyndb.server:4205

Or

9

https://my.esgyndb.server:4206

4.2. LoginIn the Login page, a valid database user name and password and click on the Login button. EsgynDBManager relies on database authentication and makes a JDBC connection to authenticate the user.

4.3. NavigationTo Navigate the UI and access the different features, use the navigation menu at the top of the screen.

Figure 2: Navigation Menus

4.4. DashboardThe dashboard page displays the status of the EsgynDB services, nodes and display time-series chartsfor key system and HBase metrics.

4.4.1. Service Status

The service status displays the status of the core EsgynDB services : Transaction Manager,Connectivity Service and Runtime Manageability Service.

For each service, you can see the number of configured processes, the number of actual runningprocesses, the number of down processes if any. * The status icon is green if all configured servers areup. * The status icon is Yellow (Warning) if the number of actual servers is not equal to the configuredservers. * The status icon is RED (Error) if actual server count is 0 or if the actual servers are < 30% ofthe configured servers.

A tooltip on the status icon displays down process information if there are any. You can also export thedata to a spreadsheet or clipboard to look at the details.

The service status information is provided by the EsgynDB REST Server which invokes the sqcheckscript.

4.4.2. Node Status

The node status displays the Up or Down status of all the configured logical nodes in the EsgynDBcluster. This information is provided by the EsgynDB REST Server which invokes the sqnodestatusscript.

10

4.5. WorkloadsThe Workload pages display EsgynDB query details. This includes all EsgynDB queries including userand system queries.

4.5.1. Active Workloads

The active workloads page displays the list of active EsgynDB queries. This includes queries that arecurrently executing and queries that completed within the last 30 seconds. The information is obtainedfrom the EsgynDB Runtime Manageability Service.

The list of queries are displayed in a tabular output with the following information:

Time

The time when the information was fetched

Last Activity Seconds

A positive number shows how long the query has been active and is still executing. A negativenumber shows how long since the query completed execution. Queries remain in RMS memory for30 seconds after completion.

Query ID

The unique identifier for the query.

Execution State

The current state of the query. Valid values are OPEN, EXECUTING, DEALLOCATED or COMPLETED.

Query Text

The SQL statement of the query.

You can click on the Query ID hyper-link to drill-down into the details of that specific query.

Use the Action → Refresh menu to refresh the list of active queries.

4.5.2. Active Query Details

The active query details page displays a summary of the runtime metrics as well the operator levelstatistics for the selected query. The metrics are obtained from the EsgynDB Runtime ManageabilityService.

The metrics that have changed since the last refresh for this query, are highlighted in blue color, so youcan observe how the query is progressing. For example if the operator CPU time is increasing, youknow the operator and query is progressing. If the CPU time for the operator does not increase, itindicates that operator is waiting for some other resource.

The page is set to auto-refresh every 30 seconds by default. You can also use the Action → Refresh

11

menu to refresh the page and reload the latest metrics for the query.

Click on the Explain button to view the explain plan for this query.

Use the Action → Cancel menu to cancel the executing query.

4.5.3. Historical Workloads

You can use the historical workloads page to view queries that have run for longer than configuredthreshold (default 60 seconds).

The threshold is defined by the dcs.server.user.program.statistics.limit.time property in dcs-site.xml. Ifthis property is not explicitly set, then the default value of 60 seconds apply.

Queries that exceed this run threshold are recorded in the EsgynDB manageability repository tables inthe "_REPOS_" schema. The historical workloads page fetches the query summary from the"_REPOS_".METRIC_QUERY_TABLE.

By default the page displays the queries that either started or completed in the last 1 hour or is stillexecuting. You can use the Filters option to change your search parameters. In the filter dialog, youcan specify different time range or use additional filters like specific application names or user namesor queries that match a particular query text. All the filter predicates are applied using AND operator,meaning that only queries that match all the filter predicates are returned.

Use the Action → Refresh action option to refresh the page.

You can click on the Query ID hyper-link to drill-down into the details of a particular query.

4.5.4. Historical Query Detail

The historical query details page displays the details for the selected query. The details are groupedtogether as summary, query text, connection metrics, compile time metrics and run time metrics. Thecompile metrics includes estimates from the compiler. The runtime metrics are the actuals reported bythe Runtime Manageability Service. You can compare the compile time metrics to the run time metricsand analyze the query behavior.

Click on the Explain button to view the explain plan for this query.

Use the Action → Cancel menu to cancel the query, if the query is a long running query and is stillexecuting.

4.5.5. Query Plan

The Query Plan page displays the Query ID, the query text, a visual explain plan and a textual explainplan.

For a query that is currently active, the textual plan may not show initially. If the query ran longer

12

than a minute, then the textual plan is obtained from the repository and displayed.

Use the Action → Refresh menu to refresh the page and reload the visual and textual plans.

If you click on a specific node in the explain tree, you will see the metrics for that specific operator in apop-up dialog.

You can use the Action → Cancel menu to cancel the query if the query is still executing.

4.5.6. Cancel Query

You can invoke the cancel action from the Active Workload Detail, Historical Workload Detail andQuery Plan pages. If the query is in EXECUTING state, a cancel request will be submitted to EsgynDBengine and provided the user has the necessary privileges to cancel the query, the engine wouldschedule a cancel of the query.

4.6. LogsThe Logs page displays the log messages from the EsgynDB processes. The logs are fetched using thelogs TMUDF which filters the log entries from all the EsgynDB log files and provides a singleconsolidated and time sequenced view.

The Log details include the following:

Time

The time when the log event occurred

Severity

The event severity (FATAL/ERROR/WARN/INFO/DEBUG)

Component

The EsgynDB component name reporting the event

Process

The component process reporting the event

Error Code

Error code if applicable. SQL Errors have error codes.

Message

The event message

Use the Filters button to specify custom filters for your search. You can filter the log entries using atime range, specific severity levels, component names, process names, error codes or message text.

The table below describes the component names:

13

Component Name Description

MON Monitor

MXOSRVR Master Executor

SQL SQL

SQL.COMP Compiler

SQL.ESP Executor Server Process

SQL.EXE Master Executor SQL

SQL.LOB SQL Large Objects

SQL.SSCP Runtime Manageability Service

SQL.SSMP Runtime Manageability Service

SQL.UDR User Defined Routines

WDG Watchdog

DCS Connectivity Servers

4.7. DCS ServersThe DCS Servers page displays the current active DCS Server sessions and the available DCS servers. Ifthe DCS server is in a connected state, you will see the user name, the application name and clientworkstation that is connected.

If a client connection is rejected with error message that no more DCS servers are available, you canuse this page to confirm that all DCS servers are used up.

To increase the number of DCS servers, increase the number of configured servers in the$DCS_INSTALL_DIR/conf/servers file and restart DCS.

4.8. Query WorkbenchThe query workbench page allows you to execute ad hoc queries and view the results in a tabular formor to generate a visual and textual explain plan.

Type the SQL query text in the Query text area. The query text should in valid EsgynDB query syntax.You can a use single EsgynDB SQL statement. It can be a DDL or DML statement. Compound SQLstatements are not supported.

The SQL statement should conform to EsgynDB SQL syntax and any errors reported by the engine aredisplayed with full error text.

14

4.8.1. Execute Query

Use the Execute button to execute the query. For a query that returns a result set, the results aredisplayed in a tabular format. For non-select queries or queries that returns a scalar result, the resultsare displayed as normal text.

4.8.2. Explain Plan

You can use the Explain button to generate an explain plan for the query. You get a visual explain in atree graph and also a textual plan. You can right mouse click on the graph and move the graph aroundor use your mouse scroll key to zoom-in and zoom-out the graph. If you click on a specific node in thetree, you can see the details and cost for that specific operator in a pop-up window.

4.8.3. Control Options

The Control options allow you enter SET statements or Control Query statements that can influence thequery plan and execution. You can use these options to tune your query performance. Refer to the SQLReference manual for more details on the SET and Control query commands.

4.9. AlertsDB Manager uses Bosun to monitor key system or workload metrics and generate notifications basedon rule templates. You can configure rule templates and notification templates in Bosun. When therules evaluate to true, the alerts are notified.

You configure your Bosun alert definitions in the $MGBLTY_INSTALL_DIR/bosun/conf/bosun.conf file.Refer to the Bosun documentation at https://bosun.org/documentation.html for instructions on how todefine the alert rule and notification templates.

Additionally, refer to the OpenTSDB documentation and the TCollector documentation to understandthe type of metrics that can be available and how to write the TSDB query expression that will be usedin your Bosun alert template. http://opentsdb.net/docs/build/html/index.htmlhttp://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html

Using the Alerts page in DB Manager, you can view all active alerts for the given time range. The Alertssummary displays all the open and active alerts. You can narrow down the filter predicates using theFilter button and find alerts for specific time range and/or alert status and/or severity and/or alert text.

The Alert summary includes:

Time

The time when the alert notification was generated.

Alert Key

The Alert Key

15

https://bosun.org/documentation.html

http://opentsdb.net/docs/build/html/index.html

http://opentsdb.net/docs/build/html/user_guide/utilities/tcollector.html

Alert

The subject text of the alert notification.

Status

Status of the alert. Acknowledged or Un-Acknowledged.

Severity

Severity State of the alert. Critical/Warning/Normal/Unknown.

Active

Indicates if the alert is still active, meaning if the alert trigger condition still exists. Only inactivealerts can be closed.

Silenced

Indicates if the alert has been silenced.

Click on the Alert Key hyperlink to drill-down into the details of a specific alert.

4.9.1. Alert Details

The alert detail page displays all the details of the alert. This includes the alert summary informationas well as the detail information that was sent out in the notification. For example if you hadconfigured the alert template to include graphs, the display includes the graphs as well.

If the alert has been acknowledged already by a user, it shows who acknowledged or closed the alert,when the alert was updated and the notes entered during the update.

Use the Actions menu to update the alert. You can acknowledge new alerts and enter a comment. Foralerts that are no longer active, meaning the alert condition is no longer true, you can close the alerts.

Refer to the Bosun documentation at https://bosun.org/documentation.html for more details.

4.10. AboutUse the Help→About to view the version of DB Manager. The page also displays the version of theEsgynDB instance you are currently connected to. When you contact Esgyn for DB Manager technicalsupport, provide the information in the About page.

4.11. Log OutYou can click on the user icon at the top right corner of the application and select the Logout option.

16

https://bosun.org/documentation.html

5. Troubleshooting and Support

5.1. TroubleshootingUse these common tips to troubleshoot any display issues with EsgynDB Manager.

• Cannot login to DB Manager

◦ Check the browser URL for accuracy. Make sure you have the right host name and port number.

◦ Verify that the DB Manager ports (4205/4206) are not blocked by any firewall.

◦ Check if DB Manager is running. Use the mgblty_check or dbmgr.sh status to confirmEsgynDB Manager is running.

◦ If DB Manager is up, verify that DCS, REST and EsgynDB is up and running.

▪ sqcheck

▪ dcscheck

▪ jps (to check if TrafodionRest server is running)

• Page is blank or partially loaded

◦ It could be a transient error like browser load timeouts. Refresh your page and try again.

◦ Sometimes refreshing the browser cache also helps.

◦ Check the browser console for errors.

• The Datetime values do not look right

◦ DB Manager displays all datetime values in the servers local time zone

◦ Make sure the timeZoneName property in the DB Manager config.xml matches the EsgynDBserver time zone

◦ Make sure the timezoneName is specified the correct canonical form like America/Los_Angelesor Asia/Shanghai or Etc/UTC etc..

Note: You will need to restart DB Manager anytime you change property values in config.xml

5.2. SupportWhen contacting Esgyn Support, the following information will be handy and requested:

• Latest logs in $MY_SQROOT/dbmgr-1.0.0/logs/

• $MY_SQROOT/dbmgr-1.0.0/config.xml

• EsgynDB Manager version information from the About page

For UI issues:

17

• A screen shot of the error

• If error is reproducible, a description of the sequence of actions the user performed to reproducethe error.

18

Documents

EsgynDB Manager User Guide - Home - Esgyn · PDF fileEsgynDB Manager User Guide ... OpenTSDB to query the time series metrics. TSD Port Only enabled and used in Enterprise Edition