Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Enterprise Analytics Web Console

      +
      The features of Enterprise Analytics can be managed by means of Enterprise Analytics Web Console.

      Understanding Enterprise Analytics Web Console

      Enterprise Analytics Web Console is a browser-based, interactive graphical facility that supports the management of Enterprise Analytics. This includes:

      • Monitoring performance and server-state, by means of constantly updated statistics, displayed in customizable, interactive charts.

      • Adding and removing cluster-nodes.

      • Interactively executing queries.

      • Managing security including the addition of users, the assignment of roles, and the configuration of external authentication mechanisms.

      The range of features made available depends on the roles that have been assigned to the user who logs into the console. If the user has been assigned the Full Administrator role, they have complete access to all features; and can therefore read, write, execute, and manage without constraint. Other roles limit the feature-range. For detailed information, see Roles.

      This page provides an overview of the complete feature-set made available by Enterprise Analytics Web Console. In many cases, detailed explanations of the user interface is provided elsewhere in the documentation-set, in correspondence with the supported feature. Links are provided in each case.

      Accessing the Console

      Enterprise Analytics Web Console is typically accessible at port 8091, of the host system, although the port number may be different if secure console-access has been established: see Manage Console Access, for information.

      When the appropriate port is accessed, an initial setup interface is displayed with two options:

      • Setup New Cluster - Establishes the current server as an independent cluster of one node, to which other nodes can subsequently be added.

      • Join Existing Cluster - Establishes the current server as a node that is part of a pre-existing cluster.

      These procedures, which include establishing credentials for administrator-authentication, are described in detail in Create a Cluster. The remaining information about this page assumes that a cluster of one node has been established. The features of the console will be portrayed in their entirety, as visible to the Full Administrator.

      Authenticating with the Console

      Once the cluster is running, all its administrators must authenticate, in order to access its features. Therefore, when port 8091 is accessed by means of the browser, a login interface is displayed.

      Enter username and password, and click on the Sign In button to access the console.

      Detailed information about authenticating with Enterprise Analytics is provided in Authentication.

      Understanding the Dashboard

      On the user’s successful login, the console displays the Dashboard. If this is the user’s first-time access, the interface displays a clean dashboard layout.

      The display consists of several key areas:

      • A banner with interactive controls.

      • A main panel, which allows display of data and configuration fields.

      • A left-hand navigation bar, which allows the main panel’s content to be determined.

      • A lower panel, which displays current status on the cluster.

      These are described in detail below.

      Banner

      The banner contains several important elements:

      • At the left, the banner features the name of the console, as determined during server-setup

      • It displays the name of the currently displayed screen (for example, Dashboard)

      • At the right, it provides information identifying the version of the server that is being run, and the build number

      In the horizontal band immediately above the banner, at the right-hand side, three interactive options appear:

      • activity - Shows notifications for ongoing operations in Enterprise Analytics. Click on this to view details about current activities and their progress.

      • help - Provides tabs that respectively allow all customers to access documentation for the server-release; and allow certain customers to contact Couchbase Customer Support.

      • admin - Provides tabs that respectively allow administrators to redefine their password; and to sign out of the console.

      Main Panel

      The content of the main panel changes, based on selections made by the user in the left-hand navigation bar. The default display is that of the Dashboard.

      All statistics presented here are in relation to existing nodes, databases, and collections.

      The user is also able to add charts incrementally, in order to display continuously updated sets of statistics. In consequence, the Dashboard is assembled differently by each user. Detailed information about incrementally adding charts and on how to read them is provided in Manage Statistics.

      Navigation Bar

      The vertical navigation bar, which appears at the left-hand side, provides a tab for each of the major features that can be accessed and managed. On initial console-access, the Dashboard tab, at the top, is selected by default. Information is provided below on each of the possible selections.

      When the mouse cursor is hovered over elements in the navigation bar, a toggle appears at the lower left. Clicking on this causes the navigation bar to be collapsed, thereby freeing up more horizontal space for the main panel.

      The toggle remains accessible, and can be used to restore the navigation bar at any time.

      Lower Panel

      The lower panel provides information about cluster status:

      • Nodes are represented by icons in green, orange, or red; according to whether they are active, failed-over, pending-rebalance, or inactive. Detailed information about nodes, their status, and how they can be managed is provided in Manage Nodes and Clusters.

      • Installed Services and Cross Data Center Replication are represented by icons in green or grey. If a service-icon is green, this indicates that it is installed and running. If it is grey, it is not installed.

      System notifications are shown, as required, in the lower left-hand corner of the main panel. These are color-coded to indicate their status:

      • Green notifications indicate success

      • Orange notifications indicate warnings of actual or potential problems

      • Red notifications indicate failure

      Red notifications provide a red, interactive X, which must be clicked on to dismiss the notification. Green and orange notifications are self-dismissive.

      Accessing Features

      Enterprise Analytics Web Console allows users to access features by clicking on tabs. Tabs are located:

      • In the left-hand navigation bar - Whenever a tab is clicked on, the appearance of the console’s main panel changes, to display content for the selected feature.

      • In the upper, horizontal navigation bar - This appears, for some features, immediately above the main panel. Whenever a tab is clicked on, the appearance of the main panel changes, to display alternative content for the feature selected from the left-hand navigation bar.

      The remaining sections on this page describe in turn the features accessed by clicking on the tabs provided.

      Servers

      To access the Servers screen, navigate to the Servers tab in the left-hand navigation bar.

      The main panel changes to display the Servers screen, which provides information about every node in the cluster.

      For a single-node cluster, a single row of information is displayed for the current node. This information includes the following:

      • name - The name of the node, established during setup.

      • group - The group of which the node is currently a member. For conceptual information about groups, see Server Group Awareness. For practical information about group management, see Manage Groups.

      • CPU, RAM, swap, disk used - information about resource-consumption, on the specified node.

      • Statistics - Click on this interactive option to display interactive statistics-charts for the database, on the console’s Dashboard.

      Statistics are only available when at least one database has been installed.

      Above the server-information display, two additional controls are provided:

      • filter servers…​ - To filter the display of servers (when there are multiple servers listed), enter a search string. Only servers whose names provide a match are then displayed.

      • Rebalance - Clicking on this control causes a rebalance to be performed across the cluster. For conceptual information about rebalance, see Rebalance. For practical information about performing rebalance, see Add a Node and Rebalance.

      To the right-hand side of the banner, three further controls appear:

      To learn about servers, see Nodes. To manage servers, see Manage Nodes and Clusters.

      Security

      To access the Security screen, navigate to the Security tab in the left-hand navigation bar.

      This displays the Security screen, which provides comprehensive security management capabilities.

      The Security screen can be displayed in six distinct views, each corresponding to a separate area of security-management. These are accessed by means of tabs, distributed across the upper horizontal navigation bar:

      • Users and Groups - Manage user accounts and group assignments

      • LDAP - Configure LDAP authentication integration

      • SAML - Configure SAML authentication integration

      • Certificates - Manage SSL/TLS certificates

      • Audit - Configure security auditing settings

      • Other Settings - Additional security configuration options

      For information about these screens, and links to further information about the security features they support, see Manage Security Settings. An extensive conceptual overview of Enterprise Analytics security is provided in Security. For practical steps towards securing a cluster, see Security Management Overview.

      Settings

      To access the Settings screen, navigate to the Settings tab in the left-hand navigation bar.

      This displays the Settings screen, which allows configuration of a variety of important parameters within Enterprise Analytics.

      Like the Security screen, it provides multiple views, each corresponding to a separate feature set, and accessed by means of tabs, distributed across the upper horizontal navigation bar:

      • General (displayed by default) - Configure cluster name, memory quotas, storage modes, and node availability settings.

      • Alerts - Configure email alert settings and notification preferences.

      Further information is provided in Manage Settings.

      Logs

      To access the Logs screen, navigate to the Logs tab in the left-hand navigation bar.

      This displays the Logs screen, which provides access to system logging information and configuration.

      The Couchbase Logging facility records important events, and saves the details to log files on disk. Additionally, subsets of information are provided on the Logs screen.

      The Logs screen offers two main views:

      1. The default representation of logged information - displays recent log entries and system events.

      2. A facility for configuring explicit logging - allows comprehensive and fully updated information to be generated as required.

      Full details are provided in Manage Logging.