Skip to content

Commit f2b0833

Browse files
RayOffiahggray-cb
authored andcommitted
[DOC-12684]: Update Explore the Server Configuration page (#3720)
1 parent 6824809 commit f2b0833

File tree

3 files changed

+56
-11
lines changed

3 files changed

+56
-11
lines changed
925 KB
Loading
332 KB
Loading

modules/getting-started/pages/look-at-the-results.adoc

Lines changed: 56 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Explore the Server Configuration
22
:page-pagination:
33
:imagesdir: ../assets/images
4-
:description: Once you have Couchbase Server running, you can log into the Couchbase Server Web Console, and start to examine the different features that it provides.
4+
:description: Once you have Couchbase Server running, you can log into the Couchbase Server Web Console and start to examine the different features that it provides.
55

66
[abstract]
77
{description}
@@ -23,29 +23,31 @@ The Docker image that you installed comes pre-configured with a default username
2323

2424
Type these credentials into the appropriate fields and click btn:[Sign In].
2525

26+
[#examine-the-cluster-dashboard]
2627
== Examine the Cluster Dashboard
2728

2829
Every time you log into the Web Console, you are brought to the [.ui]*Cluster Dashboard*:
2930

3031
[#cluster_overview]
3132
image::ClusterOverview.png["The Cluster Dashboard",720]
3233

33-
The [.ui]*Cluster Dashboard* provides a graphical summary of the current state of your Couchbase cluster.
34+
The [.ui]*Cluster Dashboard* provides a graphical summary of the Couchbase cluster's current state.
3435
The term _cluster_ might seem unexpected at this point, since you are only running a single instance of Couchbase Server; but nevertheless, it counts as a cluster of one.
3536

36-
All of the values that are displayed on this screen were automatically configured by the sandbox container image during installation.
37-
In production, you will specify these values individually according to your needs.
37+
All the values that are displayed on this screen were automatically configured by the sandbox container image during installation.
38+
In production, you will specify these values individually, according to your needs.
3839

3940
Notice the information panel at the very bottom.
4041
This shows that you have a single active bucket on the system — _bucket_ meaning a logical group of data-items.
41-
Taking a closer look at this bucket will give you some idea of how Couchbase stores data, and prepare you to make your first data-queries.
42+
Taking a closer look at this bucket will give you some idea
43+
of how Couchbase stores data and prepares you to make your first data-queries.
4244

4345
== Examine Your Bucket and Its Documents
4446

4547
Click menu:Buckets[] in the left-hand navigation bar to bring up the [.ui]*Buckets* screen.
4648

4749
The [.ui]*Buckets* screen shows that you have a single active bucket on the system (_bucket_ meaning a logical group of data-items).
48-
Taking a closer look at this bucket will give you some idea of how Couchbase stores data, and prepare you to make your first data-queries:
50+
Taking a closer look at this bucket will give you some idea of how Couchbase stores data and prepare you to make your first data-queries:
4951

5052
[#travel_sample_bucket_screen_initial]
5153
image::travelSampleBucketScreenInitial.png["The Buckets screen",720]
@@ -59,15 +61,16 @@ Click [.ui]*Scopes and Collections* to inspect the scopes and collections contai
5961
image::travelSampleScopesScreen.png["The travel-sample Scopes screen",720]
6062

6163
The [.ui]*Scopes and Collections* screen shows, in a succession of page-views, the scopes that are contained within the bucket.
62-
To see the collections that are contained within a given scope, left-click on the row for the scope -- for example, for the `inventory` scope:
64+
To see the collections that are contained within a given scope,
65+
left-click on the row for the scope, e.g., for the `inventory` scope:
6366

6467
[#travel_sample_collections_screen]
6568
image::travelSampleCollectionsScreen.png["The travel-sample Scopes screen, showing the inventory collections",720]
6669

6770
In Couchbase Server 7.0 and later, all documents must be contained in a scope and collection.
6871
If you import a dataset that was created in earlier versions of Couchbase Server, the documents are automatically saved within a `_default` scope and a `_default` collection.
6972
For your initial work with the system, this will be fine.
70-
But as you continue, and you create more documents, your will benefit from using scopes and collections to organize those documents in the best way: this will make data-access intuitive and clear.
73+
But as you continue, and you create more documents, you will benefit from using scopes and collections to organize those documents in the best way: this will make data-access intuitive and clear.
7174

7275
See the xref:getting-started:/look-at-the-results.adoc#other-destinations[Other Destinations] section, below, for a link to information on creating and managing your own scopes and collections.
7376

@@ -84,7 +87,7 @@ The following document retrieval controls are provided:
8487
The documents within the selected collection are those that will be retrieved.
8588
(For information on scopes and collections, see xref:learn:data/scopes-and-collections.adoc[Scopes and Collections]).
8689
* *Limit*: The maximum number of rows (documents) to retrieve and display at once.
87-
* *Offset*: The number of documents in the entire set of the current collection that should be skipped, before display begins.
90+
* *Offset*: The number of documents in the entire set of the current collection that should be skipped before displaying begins.
8891
Notice that when you click [.ui]*Next Batch >*, the [.ui]*Offset* increases by the same value that is specified in [.ui]*Limit*.
8992
* *Document ID*: Accepts the ID of a specific document.
9093
Leave this field blank to retrieve documents based on *Limit* and *Offset*.
@@ -103,14 +106,14 @@ image::editDocumentDialog.png["The Edit Document dialog",480]
103106
+
104107
The document consists of a series of _key-value_ pairs (or, as they are sometimes expressed, _name-value_ pairs).
105108
You can make modifications to key-values directly in this editor.
106-
As will be demonstrated later, Couchbase Server allows you to search for keys, and return the corresponding values, by means of a _query_.
109+
As will be demonstrated later, Couchbase Server allows you to search for keys and return the corresponding values by using a _query_.
107110
For example, here, if you searched on the name `country`, you would return the value `United States`; if on the name `icao`, the value `MLA`.
108111
+
109112
If you make changes in the [.ui]*Edit Document* dialog, click [.ui]*Save* to save your changes.
110113
If you want to create a new document based on an existing document, you can click the *Make a copy of this document* button (described next).
111114
If you want to create an entirely new document, you can click the btn:[ADD DOCUMENT] button in the upper-right.
112115
+
113-
Note that Couchbase Web Console supports the editing of documents that are up to 10 MB in size (although documents on Couchbase Server can be up to 20 MB in size).
116+
Note that Couchbase Web Console supports the editing of documents that are up to 10 MB in size, (although documents on Couchbase Server can be up to 20 MB in size).
114117

115118
* *Make a copy of this document*: Click this button to bring up the [.ui]*Save As* dialog, which allows you to create a new document based on the existing one:
116119
+
@@ -127,6 +130,48 @@ Click it to save your changes to the document.
127130

128131
To view successive sets of documents, use the [.ui]*Next Batch >* and [.ui]*< Prev Batch* buttons.
129132

133+
[#examining-the-cluster-logs]
134+
== Examining the Cluster's Logs
135+
136+
The Couchbase Server maintains a constant, configurable log of alerts and operations,
137+
a subset of which can be examined from the web console.
138+
139+
Start by selecting menu:Logs[] from the left-hand navigation menu.
140+
141+
image::eventLogging.png[]
142+
143+
You will be presented with a screen containing a series of events logged by the cluster.
144+
145+
You can filter the log entries by entering a string in the [.ui]*filter logs ...* field.
146+
147+
You can also opt to have logging data written to a file or a bucket on a Couchbase node
148+
by selecting the menu:Collect Information[] option from the top menu:
149+
150+
image::collectLogInformationOptions.png[]
151+
152+
The [.ui]*Collection Information* screen will be displayed, giving you a number of options for collecting logs.
153+
As well as specifying the nodes logged, you can also specify a location for writing the logging data.
154+
155+
Once the options have been set, click on btn:[Start Collecting] to start recording logs to your specified location.
156+
157+
TIP: If you are having a problem with your cluster setup, it may be useful to provide Couchbase Support with a log of the server activity.
158+
159+
[#examining-the-cluster-metrics]
160+
== Examining the Cluster's Metrics
161+
162+
As well as examining the state of the cluster from the web console, (see the section on xref:examine-the-cluster-dashboard[Examining the cluster dashboard]),
163+
you can monitor more specific elements of the cluster operation, such as the indexes in real-time:
164+
165+
166+
. Select [.ui]*All Services* from the menu:Choose Dashboard[] dropdown menu.
167+
. The page will expand to include all the services available on the node.
168+
Click on [.ui]*Index* and you will be presented with a series of graphs depicting real-time metrics for the indexes running on the node.
169+
+
170+
image::showDashboardIndex.png["Index from UI dashboard", 720]
171+
+
172+
TIP: The graphs will allow you to see if loads across multiple nodes differ significantly.
173+
174+
130175
[#other-destinations]
131176
== Other Destinations
132177

0 commit comments

Comments
 (0)