Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc 9499 document how to use an external prometheus to consume couchbase stats #2360

Merged
merged 9 commits into from Jan 21, 2022
Merged

Doc 9499 document how to use an external prometheus to consume couchbase stats #2360

merged 9 commits into from Jan 21, 2022

Conversation

RayOffiah
Copy link
Collaborator

No description provided.

@RayOffiah RayOffiah self-assigned this Jan 14, 2022
@RayOffiah RayOffiah requested a review from a team January 14, 2022 11:01
@RayOffiah
DOC-9499 Document how to use an external Prometheus to consume Couchb…
5f8089c 
…ase stats:

Added note to the monitor-intro.adoc
@RayOffiah RayOffiah added the enhancement New feature or request label Jan 14, 2022
shivaniguptacb
shivaniguptacb approved these changes Jan 14, 2022
View reviewed changes
Copy link
Contributor

@shivaniguptacb shivaniguptacb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good other than the 1 change I suggested.

modules/manage/pages/monitor/monitor-intro.adoc Outdated Show resolved Hide resolved
@RayOffiah
DOC-9499 Document how to use an external Prometheus to consume Couchb…
4a1ea20 
…ase stats:

Moved intro note to its own section.
Fixed broken link on monitor-intro.adoc
maria-robobug
maria-robobug approved these changes Jan 21, 2022
View reviewed changes
Copy link
Contributor

@maria-robobug maria-robobug left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just added some minor comments 👍 .

modules/manage/pages/monitor/monitor-intro.adoc Outdated Show resolved Hide resolved
modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Outdated Show resolved Hide resolved
modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Outdated
@@ -0,0 +1,100 @@
= Using Your Own Prometheus Server to Consume Couchbase Metrics
:description: With Couchbase 7.x, it's not necessary to write a custom Prometheus Exporter.This page will demonstrate how to enable a Prometheus server to read from Couchbase's Prometheus-ready endpoints.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonder if this is a bit long for the SEO description, maybe shorten this and add more in the abstract?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Effectively, only the first couple of dozen words in the description get used by Google.

modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Outdated

== Prerequisites

In this tutorial, we're going to use a https://www.docker.com/get-started[Docker] instance of https://prometheus.io/[Prometheus] to build our consumer. Make sure that you have Docker installed and running on your machine. You should also have an available Couchbase cluster with at least one running node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For ease of reviewing we tend to put new sentences on a newline.
https://docs.couchbase.com/home/contribute/pages.html#ventilate

There might be a few other sections where this needs to be updated, but as an example:

Suggested change
In this tutorial, we're going to use a https://www.docker.com/get-started[Docker] instance of https://prometheus.io/[Prometheus] to build our consumer. Make sure that you have Docker installed and running on your machine. You should also have an available Couchbase cluster with at least one running node.
In this tutorial, we're going to use a https://www.docker.com/get-started[Docker] instance of https://prometheus.io/[Prometheus] to build our consumer.
Make sure that you have Docker installed and running on your machine.
You should also have an available Couchbase cluster with at least one running node.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ease of reviewing, yes - in particular with diffs when a page is updated later.
(have fixed in my gardening edit).

modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Show resolved Hide resolved
modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Show resolved Hide resolved
modules/manage/pages/monitor/set-up-prometheus-for-monitoring.adoc Outdated
image::monitor/prometheus-alert.png[]



Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quite a few extra blank lines here, do we need these?

RayOffiah and others added 4 commits January 21, 2022 10:29
@RayOffiah RayOffiah merged commit 7bf7604 into couchbase:release/7.0 Jan 21, 2022
simon-dew
simon-dew reviewed Jan 21, 2022
View reviewed changes
Copy link
Collaborator

@simon-dew simon-dew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just wondering why a tutorial? Most of the Manage section is how-to guides.

@simon-dew
Copy link
Collaborator

Most of the Manage section is how-to guides

I mean, the information type is not very clearly defined in this section, but I would guess it's closer to how-to guide than anything else. Maybe information typing is something we need to start paying more attention to?

@RayOffiah
Copy link
Collaborator Author

RayOffiah commented Jan 21, 2022 •
edited

Mmm. 🤔

I think you have a point there. It's not really a springboard to further learning (tutorial). It's basically telling you how to do something. I'll have a think about reworking it. --> @simon-dew

simon-dew added a commit that referenced this pull request Feb 7, 2022
@simon-dew @RayOffiah
@RichardSmedley @RekhaDS @malscent @ed6767 @maria-robobug @tonyjhillman @abhinavdangeti @nawazish-github @osfameron @jon-strabala
Merge 7.0 changes forward to 7.1 (#2430)
b17796e 
* DOC-8454 add sizing information to server docs (#2323)

* Update AWS Marketplace Deployment instructions (#2335)

* list tweak (#2336)

* missing [] (#2337)

* DOC-9455 CE to EE Upgrade Path needs to be clarified (#2311)

* MB-50105 - Add documentation for Disk Encryption to AWS Best Practices (#2333)
  MB-50104 - Add documentation for Secret Manager Secret Access and Rotation to AWS Best Practices

* DOC-9120: improve description of event rebalancing (#2214)

* correct typo "THe" -> "The" (#2342)

* MB-48904 Version 7.0 - Need to remove cbdocloader code snippet #2299

* Fixed spelling mistake. (#2340)

* Fixing Couchbase tickets drop 3 (#2319)

* DOC-9515 "Couchbase Client Deployment Strategies" link goes to the generic SDK intro. (#2349)

* DOC-9540: Clarify formulations for setup (#2352)

* DOC-9491: Added ports 11280 and 9123. Moved 9124. (#2328)

* DOC-9521 Inconsistency between Table 1 and Table 2 sections (#2351)

* Fixed issues reported by Sreekanth (#2362)

* DOC-9471: Removed duplicate nav entry (#2313)

* DOC-9286: Fixed typo (#2241)

* DOC-9550: Corrected pathname (#2366)

* [DOC-9566] External users should use TLS when communicating with cluster (#2364)

* DOC-9585: Rename fts-creating-index.adoc to fts-creating-indexes.adoc (#2377)

* Update cluster-manager.adoc (#2359)

* Doc 9499 document how to use an external prometheus to consume couchbase stats (#2360)

* DOC-9481: Typo in the documentation header (#2376)

* tutorial fix for new couchbase download page (#2389)

* DOC-9196: How-to Guides for Server Developers (#2373)

* DOC-9204: Developer Guides Overview (#2224)

* DOC-9206: How-to Guides for Server Developers: Query — Read Data (#2249)

* DOC-9207: Query — Manipulate Data (#2277)

* DOC-9205 - KV Operations dev-reorg (#2275)

* DOC-9217: How-to Guides for Server Developers › Index Advisor (#2331)

  - DOC-9240: Restore query result tree
  - DOC-9240: Add patch release markup for 7.0-7.0.1
  - DOC-9018: Move Charts section under Query Results and rewrite for Couchbase Server 7.0.2

* DOC-9216: Import Data guide (#2317)

* DOC-9210:  How-to Guides for Server Developers › Transactions (#2353)

* DOC-9209: How-to Guides for Server Developers › Query › Indexes (#2307)

* DOC-9412 - Connect to server (#2339)

* DOC-9204: Developer Guides Overview (#2371)

  - DOC-9209: transaction fixes
  - DOC-9216: Minor wording changes for consistency
  - DOC-9412: Update nav and overview page

* DOC-8818: node-to-node encryption and eventing storage (#2385)

* DOC-9294 improve terminology avoid function/handler confusion (#2390)

* DOC-9190 Scopes & Collections name length incorrect #2370

* [ray offiah] fixing the prometheus installation instructions (#2393)

* DOC-9588: Information on group correspondences for LDAP (#2392)

* [DOC-9611] Wrong output for OBJECT_INNER_VALUES (#2399)

* test_kroki_on_production (#2423)

* DOC-9198: Gradual Learning Progression (#2424)

  - DOC-9201: Move Learn and Manage after Develop
  - DOC-9202: Combine Tutorial and Guides into Develop

* Remove subqueries from description of JOIN how-to guide (#2428)

* Revert launch dialog image for 7.1

* DOC-9240 Remove query workbench tree results for 7.1

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>
Co-authored-by: Richard Smedley <rgsmedley@gmail.com>
Co-authored-by: RekhaDS <rexshyam@gmail.com>
Co-authored-by: Justin Ashworth <justin.ashworth@couchbase.com>
Co-authored-by: Ed.E <edxtdev@gmail.com>
Co-authored-by: quickdraft <80592148+quickdraft@users.noreply.github.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Tony Hillman <tonyjhillman@gmail.com>
Co-authored-by: Tony Hillman <tonyhillman@Tonys-MacBook-Pro-2.local>
Co-authored-by: Abhinav Dangeti <abhinav@couchbase.com>
Co-authored-by: Ray Offiah <ray.offiah@couchbase.com>
Co-authored-by: Nawazish Mohammad Khan <md.nawazish.khan@gmail.com>
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Co-authored-by: Jon Strabala <54073900+jon-strabala@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RichardSmedley RichardSmedley RichardSmedley approved these changes

@simon-dew simon-dew simon-dew left review comments

@maria-robobug maria-robobug maria-robobug approved these changes

@shivaniguptacb shivaniguptacb shivaniguptacb approved these changes

Assignees

@RayOffiah RayOffiah

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
5 participants
@RayOffiah @simon-dew @RichardSmedley @maria-robobug @shivaniguptacb