• New Feature - Dashboard now checks to see if the pipelinesource on a replica is not pointing to the current primary and highlights the pipelineSource with bold red if mismatched.

• New Feature - now able to change the Auto-Configure host and port via Settings

• Improvement - Dashboard now has Connector polling disabled by default to reduce manager load. Enable via the Settings panel.

  Technical Details - automatically adds the ?includeRouters=false flag to the end of calls to /api/v2/manager/cluster/status and /api/v2/manager/status/service/{$service}

• Improved Docker support.

• Improved support for Distributed Data Groups (DDG), including an added setting for enableDDGNodeColors.

• Improvement - updated various wording to differentiate between the Auto-Define and Auto-Confgigure features. updates all copyrights to 2024

• Improvement - Updates all copyrights to 2024.

• BugFix - Primary definition corrected to exclude shunned or failed masters.

• BugFix - Settings panel help broken when fancy tooltips were not enabled.

• BugFix - Auto-Define now gets the proper security defaults when none are specified in the form.

• Upgraded to jQuery 3.6.4

• Added new feature "Client Request Tracking" to log one line per client request call.

• Improved formatting for the diagnostic upload result message.

• Fixed an auto-configure regression for composite clusters.

• The new datasource drain feature in Tungsten Clustering v7.0.2 is now supported in the Tungsten Dashboard node menus

  There is a new,related setting called drainTimeout which controls the length of time to wait before closing the connection to a database node from a Connector

• Changed managerPort setting default value to 8201 from 8091

• Updated the auto-refresh browser-specific timestamp display to fit better on the navbar

• Corrected a page reload issue

• The config.php file has been updated to include a config.json file in the same subdirectory. If the config.json exists, the contents will be used in place of any json configuration defined manually in the config.php file.

• The new best practice is to use only config.json, not config.php any longer.

• Since there is a new config.php file with this version, a new migration tool called upgrade_config.php has been included to easily install the new config.php file while still maintaining all of your existing settings.

  The upgrade_config.php command will create a new file called config.json containing all of the settings that used to be inside the config.php file.

  Important

  The upgrade_config.php tool should be NOT be RUN if the config.json file already exists!

  The upgrade_config.php tool should be RUN ONLY ONCE!

  COMPLETE ALL THE STANDARD UPGRADE STEPS FIRST!
  
  shell> cd {DASHBOARD_WEBROOT}/
  For example:
  shell> cd /volumes/data/www/tungsten/html/
  
  shell> ./upgrade_config.php `pwd`

  Important

  The upgrade_config.php tool should be NOT be RUN if the config.json file already exists!

  The upgrade_config.php tool should be RUN ONLY ONCE!

• You are now able to specify one or more tags per cluster in all cluster definition forms.

• You are now able to filter the cluster display by a tag from the top search bar.

• You are now able to specify the API settings on a per-cluster basis (apiVersion, apiAuth, apiUser, apiPassword and apiSSL), allowing for mixed APIv1 and APIv2 clusters in the same Dashboard session, and clusters with different admin user/password pairs.

• In previous versions of the Tungsten Dashboard, the API Version, API Authentication/User/Password and API Encryption settings were global only. This meant that a version 6 cluster running APIv1 and a version 7 cluster running APIv2 would not work at the same time in the same Dashboard sessioa, nor would clusters with different API user/password pairs.

• The new configuration fields have been added to the display, add and edit cluster definition forms in all areas of the dashboard.

• The API settings for each cluster are now displayed upon hover over the cluster service name. Each option will also show if the value is derived from the global default, or from a cluster-specific setting.

• Expert mode now allows one-click toggling of global API authentication and SSL Encryption options in addition to the existing global API version toggle.

• Two new settings have been added to the Tungsten Dashboard to support an improved GUI experience.

• Both of the new settings are available via the GUI (config.php options in parens):

  • Display Style (displayStyle)

    Specify which horizontal display method to use in the new REACT frontend (Fill Space or Compressed)

  • Home Page (homepage)

    Specify which page to display first in the new REACT frontend (Cluster, Dashboard or Metrics)

• When changing a composite cluster parent name, the children are now updated with the new parent name. Previously, this was a manual operation.

• when changing a composite cluster child name, the parent is now updated with the new child name. Previously, this was a manual operation.

• A new setting (enableTabs) has been added to the Tungsten Dashboard to control the Tab bar behavior.

• While getting the information to populate the Tab bar is a lightweight AJAX call, the actual data gathering in the backend is quite heavy, and requires an API call to every cluster. This backend processing can cause slowdowns in response time for the Dashboard and is why the new default is to have "dumb" Tabs and better performance.

• Now, by default, the Tab bar will operate in "dumb" mode, and will NOT display the quantity of nodes that are not in automatic mode, nor the quantity of nodes that are in the not ready state. Also, the Tab refresh button will not appear either.

• Enabling Tabs in the Settings Panel restores the original behavior of displaying the counts and the refresh button.

• The Tungsten Dashboard now fully supports CAA clusters in v6!

• Added the ability to close windows using the Escape key, enabled by default. Disable in the Settings panel.

• Added a Copy To Clipboard button to all cluster configuration display windows.

• Added a refresh button to the missing cluster display box for convenience - no longer need to refresh the entire page

• In expert mode, there is a new heartbeat trigger button per cluster in old frontend

• Cleaned up error_log calls to make the log file as quiet as possible, and added new setting (enableVerbose) and the aassociated verbose_log() function.

• When RBAC is enabled, a logout link is now visible at the bottom center of the footer. Also improved footer messaging when RBAC is disabled and/or basic auth is disabled.

• For both auto and manual cluster definition, if you create a Dashboard Service ID (service name) with hyphens, they will be converted to underscores upon save due to the way Javascript handles id's with hyphens.

• When useHAProxy is enabled, the Manager Port will now be set to 8201 instead of 8091 to avoid port conflicts when installed directly on a cluster node.

• The browser-specific date and time display for auto-refresh has been shortened to better fit on the navbar.

• Two new settings have been added to the Tungsten Dashboard to support Prometheus and Grafana integration.

• Both of the new settings are available via the GUI (config.php options in parens):

  • Enable Prometheus Integration (enablePrometheus)

    Enable integration with Prometheus to display data in a new window.

  • Enable Grafana Integration (enableGrafana)

    Enable integration with Grafana to display graphs inside the Dashboard.

• Two new settings have been added to the Tungsten Dashboard to help compensate for slow environmemnts where API calls may take longer to complete.

• Both of the new settings are available via the GUI (config.php options in parens):

  • CURL GET Timeout (curlTimeoutGET)

    The timeout used when curl connects to the Manager for a GET-specific API call, in seconds.

  • CURL POST Timeout (curlTimeoutPOST)

    The timeout used when curl connects to the Manager for a POST-specific API call, in seconds.

• The ability to track all write API calls made has been added.

• There will be one audit file per day created in the auditDir (default: {WEBROOT}/audit.d).

• One line per write containing: timestamp, ipaddr, user, role and msg/action

• The new setting is partially available via the GUI (config.php options in parens):

  • Enable Audit Trail (enableAudit)

    Capture all POST API calls to a file in the {WEBROOT}/audit.d subdir like audit-{YYMMDD}.log

  • Audit subdirectory name (auditDir) (NOT available via GUI)

    The directory used to store the audit files (default: {WEBROOT}/audit.d)

• You can now store text on a per-node basis.

• There will be one note file per node created in the notesDir (default: {WEBROOT}/notes.d).

• The new setting is partially available via the GUI (config.php options in parens):

  • Enable Per-Node Notes (enableNotes)

    Turn on the notes per node feature to capture text to a file in the {WEBROOT}/notes.d subdir, named like {SERVICE}-{FQDN}.txt

  • Note Icon (noteGlyphicon) (NOT available via GUI)

    Use noteGlyphicon to specify the note-per-node Glyphicon (default: comment).

  • Notes subdirectory name (notesDir) (NOT available via GUI)

    The directory used to store the note files (default: {WEBROOT}/notes.d)

• You can now enable the display of the back-end API call URLs for transparency and learning.

• The new setting is available via the GUI (config.php options in parens):

  • Enable API URL Display (enableURLDisplay)

    Display the API call URL for each command run.

• You can now automatically highlight node rows where the Replicator is lagging by a specified number of seconds.

• The new setting is available via the GUI (config.php options in parens):

  • Flag-On-Lag Delay (flagOnLagDelay) (in seconds)

    Set this option to a non-zero value to enable node row highlighting when the Replica is more than the specified number of seconds behind the Primary.

  • Flag-On-Lag Color (flagOnLagColor)

    The background color to use when marking a node row as too far behind. One of Info (blue), Warning (yellow) or Danger (red).

• Now able to configure Dashboard settings via the browser

  You can disable the editing of settings in the browser by changing the value of disableSettingsEdit to 1 in the config.php file, in the "settings": { } stanza:

   "disableSettingsEdit": 1 

• All settings configured via the browser page are stored in the {webroot}/settings.d/ directory as individual JSON text files named for the setting. Please ensure it exists and is writable by the web server user.

• You may edit or delete any of the files in the {webroot}/settings.d/ directory. The setting will revert to the default if deleted. you may also choose to configure settings in this way as opposed to using the config.php file. Your choice.

• Refactored all options and created centralized defaults

• Now able to self-update the Dashboard software via the browser

  There are four related settings, enableUpdates, tmpDir, downloadAccessKey and downloadSecretKey.

  All four must be located in the config.php file, in the "settings": { } stanza. They are not accessible from the browser settings page.

  You can disable the Dashboard self-update feature by changing the value of enableUpdates to 0 in config.php (default: 1):

   "enableUpdates": 1 

  The tmpDir value is used to determine where downloaded software packages are saved to:

   "tmpDir":"/tmp" 

  The other two (downloadAccessKey and downloadSecretKey) need to be obtained from Continuent support and typicially ship with the Dashboard installation package.

• Now able to manually create and save cluster definitions in the conf.d subdirectory. Originally, a cluster could only be defined in the "clusters": { } stanza.

• Now able to create and save cluster definitions to the conf.d subdirectory via a browser workflow

• Added Display, Edit and Remove Cluster Definition menu choices for each cluster

• Now able to automatically define cluster definitions in conf.d just by providing a hostname and port number in a browser workflow

• Now able to automatically define cluster definitions in conf.d at Dashboard startup

  There are three related settings, enableAutoConfiguration, managerPort and useHAProxy.

  You can enable the Dashboard auto-configuration feature by changing the "Enable Auto-Configuration?" setting via the Dashboard settings page in the browser, or changing the value of enableAutoConfiguration to 1 in config.php (default: 0) or via the Dashboard settings page in the browser:

   "enableAutoConfiguration": 1 

  The managerPort value is used to determine what port to communicate with the manager upon when performing auto-configuration and auto-define, as well as populating form fields in other places. Only change this if you have change the API listener port for the Manager as well.

   "managerPort": 8090 

  The useHAProxy value is used to determine how to calculate ports when performing auto-configuration and auto-define.

  Set the value to 1 to determine the manager port number automatically during various operations based on calulations using the base managerPort.

  Set the value to 0 (default) to use the base managerPort with no attempt to auto-define the port.

  You can enable the manager port auto-configuration feature by changing the "Using HA Proxy?" setting via the Dashboard settings page in the browser, or changing the value in the config.php file.

   "useHAProxy": 1 

• Role name cleaning (Master is now Primary, and Slave is now Replica for nodes; Master is now Active, and Slave is now Passive for clusters)

• Improve error handling for JSON responses to AJAX calls

• Bug fixes in service alias support

• Many footer improvements, including a link to check for an available Dashboard software update

• Stop providing tabInfo during intitial page load, instead do it as AJAX call after load to save initial page load time

• Now able to upload a Dashboard Diagnostic containing the JSON configuration to Continuent Support's protected AWS bucket. No other customer has access to this location, it is upload-only.

  There are three related settings, customerName, uploadAccessKey and uploadSecretKey.

  The customerName value is used to pre-populate the diagnostic upload form.

   "customerName":"your customer name here" 

  The other two (uploadAccessKey and uploadSecretKey) need to be located in config.php

   "uploadAccessKey":"AKIAIWDZPQUE5YL4SBDQ", ] 
   "uploadSecretKey":"FQ0iVkTtH9biIZT2+IpwXwhqXvVwqMUqsZ4++N4K" ] 

• New Expert mode disables both confirmation prompts when Deleting All Definitions

  The default is 0 (disabled). Set enableExpertMode to 1 (one) to enable.

   "enableExpertMode": 1 

• Use the enableDebug setting to get additional logging information and use the debug software versions when checking for an available update.

   "enableDebug": 1 

• Added basic Role-Based Access Control (RBAC). There are two roles, Administrator with full access and Operator with Read-Only access. This feature requires Basic Auth to be properly configured on the Web server.

  When enabled, the user's current role will be displayed in the footer. Refresh the page to activate any changes to config.php.

  The default is 0 (disabled). Set enableRBAC to 1 (one) to enable.

   "enableRBAC":1 

  Use the administrators setting to list the users with admin privs:

   "administrators": [ "adminUser1","adminUser2" ] 

• Improved page load performance via caching of API calls. This is especially helpful with Composite clusters that have multiple sites over a wide area.

• Added the ability to modify the browser window title using the new configuration option windowTitle

• Added the ability to change the cluster service sort order from the alpha default to as-written configuration order using the new configuration option sortByConfigOrderNotAlpha

• Site favicons along with the navigation bar logo and colors have been updated to promote a cleaner look. Additional icon replacements and color tweaks have been made throughout the tool.

• Added hover-based tooltips for all fields and buttons where possible. Set disableTooltips to 1 to prevent the tooltips from appearing.

• Significantly improved the Connector popover formatting, sorting and operation.

• Message handling is improved so that multiple actions and responses are tracked and messaged properly.

• Added the ability to view the json configuration in the browser via a menu link.

• Added the ability to check for Dashboard software updates.

• Added the ability to check for Clustering software updates on a per-node basis.

• Added the feature to allow for cluster service name aliases. You may now add the sub-key actualName pointing to the "real" name of the service, and change the top-level cluster service name to some alias that you understand.

  Previously, it was impossible to configure two or more clusters with the same service name. This could be required if clusters were installed into different environments like production, staging or development. While the best practice is to name the cluster services to match the environment (i.e. east_prod and east_staging), in some situations this may not be possible.

• Added a new feature to automatically fade out messages after a delay. The default is 60 seconds. Set msgFadeOutTimer to 0 (zero) to disable or to a positive integer to specify the delay in seconds.

   "msgFadeOutTimer":60 

• Improved the look & feel of the overall layout, including display widths, the location of the timestamp marker and spacing.

• Fixed a bug where the controls to open and close a cluster were STILL not working.

• Fixed a bug where the datasource status details hover was not displaying properly

• Fixed a bug where the controls to open and close a cluster were not working.

• When Auto-refresh is turned on, any issuence of a command will stop the auto-refresh. Simply re-select your desired refresh rate to turn it back on.

• Fixed CMM cluster bug where clusters other than the first do not show subservices.

• Tweaked cell alignment

• Fixed cluster-level open/close regression.

• Tweaked error text and reduced noise in the logs.

The default for navButtonFormat is icon if not specified.

• Added modal "Stop Auto-Refresh" button which will turn off the Auto-refresh feature. This button is only visible if auto-refresh is enabled.

• Added ability to set global buttons to icon, text or some combination. Use the setting navButtonFormat and specify one or more of icon or text as a comma-separated string, no spaces. Order counts.

  $jsonConfig = <<<EOJ
  {
   "settings": {
   "navButtonFormat":"icon",
  ...
  EOJ;

  Currently there are four (4) possible entries:

  "navButtonFormat":"icon",
  	"navButtonFormat":"text",
  	"navButtonFormat":"icon,text",
  	"navButtonFormat":"text,icon",

• Refactored API calls for better error handling.

• Better error reporting on the front-end.

• Support for Composite Active/Active topology offered in Continuent Clustering v6.x (requires Continuent Clustering version 6.0.3)

• Improvements to the menu system layout and clarity

• Composite-level cluster commands have been relocated to a new menu to the right of the State field

• Composite clusters now display the actual composite state instead of the Ready/Warning/Error status indicators, and status indicator lights have been moved to the left of the State label

• Improvements to the locking system:

  • Auto-Lock and Auto-Unlock are now both configurable via config.php

  • Auto-Lock and Auto-Unlock setting are now both visible at the bottom of the cluster-level locking menu

  • Auto-Lock may be configured to attempt a lock for all actions, heartbeats only, or not at all

  • Auto-Unlock may be configured to attempt an unlock for all actions, heartbeats only, or not at all

• Additional formatting tweaks, including the reduction in height of the rows

• Full monitoring information on the status and progress of replication and the status of the cluster

• Monitor multiple clusters through a single page

• Perform switches and failovers

• Shun hosts

• Recover failed hosts

• Click the "Update Now" button to invoke the upgrade. There is no confirmation prompt, the upgrade begins immediately.

• When the upgrade is complete, simply refresh the page fully to get the new version.

• You may need to clear cache and refresh the page again to ensure the latest scripts and styles are loaded properly.