[DOC-14397]: DOC: Application Telemetry needs additional info.#4123
Open
RayOffiah wants to merge 3 commits into
Open
[DOC-14397]: DOC: Application Telemetry needs additional info.#4123RayOffiah wants to merge 3 commits into
RayOffiah wants to merge 3 commits into
Conversation
Added more information on application telemetry to application-telemetry.adoc Added link to the new information on metrics-reference.adoc
There was a problem hiding this comment.
Pull request overview
Adds more guidance on enabling Couchbase Server application telemetry and surfaces a new navigation link from the metrics reference to the application telemetry documentation.
Changes:
- Added an “Enabling telemetry” IMPORTANT callout with example
curlcommands and SDK tracing links. - Added an “Application Telemetry” link entry to the metrics reference index.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| modules/rest-api/pages/application-telemetry.adoc | Adds an IMPORTANT block documenting how to check/enable telemetry and where to find SDK tracing guidance. |
| modules/metrics-reference/pages/metrics-reference.adoc | Adds a new link entry referencing the application telemetry documentation from the metrics reference page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Made corrections following the Copilot review Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
Added diagram and section for the histograms. Signed-off-by: Ray Offiah <ray.offiah@couchbase.com>
avsej
suggested changes
Jun 11, 2026
avsej
left a comment
avsej
left a comment
Member
There was a problem hiding this comment.
Looks good, only couple of markup fixes. And also I am not sure what is the accepted format for hostname in cURL snippets, personally I like how one of your examples used placeholders which got highlighted with yellow, but maybe the other variant with just localhost:8091 is more copy/paste friendly. But they must be consistent throughout the document, I believe
|
|
||
| [source, bash] | ||
| ---- | ||
| curl -u Administrator:password -X GET http://localhost:8091/settings/appTelemetry | jq |
Member
There was a problem hiding this comment.
Suggested change
| curl -u Administrator:password -X GET http://localhost:8091/settings/appTelemetry | jq | |
| curl -u Administrator:password -X GET http://##{host}##:##{port}##/settings/appTelemetry | jq |
| [source, bash] | ||
| ---- | ||
| curl -u Administrator:password -X POST \ | ||
| http://localhost:8091/settings/appTelemetry \ |
Member
There was a problem hiding this comment.
Suggested change
| http://localhost:8091/settings/appTelemetry \ | |
| http://##{host}##:##{port}##/settings/appTelemetry \ |
|
|
||
| [#histogram-output] | ||
| .Histogram output | ||
| ==== |
Member
There was a problem hiding this comment.
Suggested change
| ==== | |
| [source] | |
| ---- |
| sdk_kv_retrieval_duration_milliseconds_bucket{le="+Inf",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 144320 | ||
| sdk_kv_retrieval_duration_milliseconds_sum{agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 53423000 | ||
| sdk_kv_retrieval_duration_milliseconds_count{agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 144320 | ||
| ==== |
| [#histogram-output] | ||
| .Histogram output | ||
| ==== | ||
| #sdk_kv_retrieval_duration_milliseconds_bucket{le="1",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 24054# |
Member
There was a problem hiding this comment.
Suggested change
| #sdk_kv_retrieval_duration_milliseconds_bucket{le="1",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 24054# | |
| sdk_kv_retrieval_duration_milliseconds_bucket{le="1",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 24054 |
|
|
||
| <<histogram-output>> demonstrates a series of `kv` retrieval times for the buckets in a node. | ||
| Each line gives the retrieval count for a particular range. | ||
| (The count for retrieval durations for milliseconds stem:[le 1] is 24,054, milliseconds stem:[le 10] is 33,444, etc). |
Member
There was a problem hiding this comment.
Suggested change
| (The count for retrieval durations for milliseconds stem:[le 1] is 24,054, milliseconds stem:[le 10] is 33,444, etc). | |
| The retrieval duration counts are grouped by latency buckets: for example, requests completed in `<= 1 ms` total `24,054`, those in `<=10 ms` total `33,444`, and so on. |
this paragraph is not clear. I believe "bucket" term will be better fit here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added detailed information on enabling application telemetry.
Added a link for the application telemetry page to the metrics reference.
preview URLs
https://preview.docs-test.couchbase.com/docs-server-DOC-14397--8.0--Application-Telemetry-needs-additional-info/server/current/rest-api/application-telemetry.html
https://preview.docs-test.couchbase.com/docs-server-DOC-14397--8.0--Application-Telemetry-needs-additional-info/server/current/metrics-reference/application-telemetry-metrics.html
https://preview.docs-test.couchbase.com/docs-server-DOC-14397--8.0--Application-Telemetry-needs-additional-info/server/current/metrics-reference/metrics-reference.html