-
Notifications
You must be signed in to change notification settings - Fork 182
[DOC-14397]: DOC: Application Telemetry needs additional info. #4123
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.
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
Open
RayOffiah
wants to merge
4
commits into
release/8.0
Choose a base branch
from
DOC-14397--8.0--Application-Telemetry-needs-additional-info
base: release/8.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
89f1f3b
[DOC-14397]: DOC: Application Telemetry needs additional info.
RayOffiah 0b29278
[DOC-14397]: DOC: Application Telemetry needs additional info.
RayOffiah 7258a5c
[DOC-14397]: DOC: Application Telemetry needs additional info
RayOffiah 3234ce4
[DOC-14397]: DOC: Application Telemetry needs additional info
RayOffiah File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
modules/metrics-reference/pages/application-telemetry-metrics.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| = Application Telemetry Metrics | ||
| :description: Couchbase can be configured to collect metrics related to Couchbase SDK calls made from applications. | ||
| :stem: asciimath | ||
|
|
||
| [abstract] | ||
| {description} | ||
|
|
||
| == Prerequisites | ||
|
|
||
| === Activating Telemetry on Couchbase Server | ||
|
|
||
| Before generating metrics from application telemetry, you must enable application telemetry on your Couchbase Server installation. | ||
| You can do this by executing the following CURL command: | ||
|
|
||
| [source, bash, subs="+quotes"] | ||
| ---- | ||
| curl -u Administrator:password -X POST \ | ||
| https://##{host}##:##{port}##/settings/appTelemetry \ | ||
| -d enabled=true | ||
| ---- | ||
|
|
||
| For more information on enabling application telemetry, see xref:rest-api:application-telemetry.adoc[] | ||
|
|
||
| == Telemetry Counters | ||
|
|
||
| Couchbase can record the number of SDK calls made for specific services. The metrics follow the same basic patterns: | ||
|
|
||
| [%header] | ||
| |=== | ||
| | Metric| Description | ||
|
|
||
| | `sdk_\{service}_r_total` | ||
| | The total number of operations | ||
|
|
||
| |`sdk_\{service}_r_canceled` | ||
| | The total number of operations that were canceled. | ||
|
|
||
| | `sdk_\{service}_r_timedout` | ||
| | The total number of operations that timed out. | ||
|
|
||
| |=== | ||
|
|
||
| To access the counter for a particular service, you replace `\{service}` with one of the following: | ||
|
|
||
| * `kv` | ||
| * `query` | ||
| * `search` | ||
| * `analytics` | ||
| * `management` | ||
| * `eventing` | ||
|
|
||
| So to access the number of calls that timed out for the query service, | ||
| you would use the command: `sdk_query_r_timedout`. | ||
|
|
||
| == Histograms | ||
|
|
||
| The same service labeling is used in the retrieval of histograms: | ||
|
|
||
|
|
||
| [%header, cols="2,1"] | ||
| |=== | ||
| | Metric| Description | ||
|
|
||
| | `sdk_\{service}_retrieval_duration_milliseconds_bucket` | ||
| | Time take for retrieval | ||
|
|
||
| |`sdk_\{service}_mutation_nondurable` | ||
| | Time taken for non-durable mutations. | ||
|
|
||
| | `sdk_\{service}__mutation_durable` | ||
| | Time taken for ndurable mutations. | ||
| |=== | ||
|
|
||
| The histogram metrics can take the same `service` values as the metric counters. | ||
|
|
||
| * `kv` | ||
| * `query` | ||
| * `search` | ||
| * `analytics` | ||
| * `management` | ||
| * `eventing` | ||
|
|
||
| [#histogram-output] | ||
| .Histogram output | ||
| ==== | ||
| [source] | ||
| ---- | ||
| 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="10",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 33444 | ||
| sdk_kv_retrieval_duration_milliseconds_bucket{le="100",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 100392 | ||
| sdk_kv_retrieval_duration_milliseconds_bucket{le="500",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 129389 | ||
| sdk_kv_retrieval_duration_milliseconds_bucket{le="1000",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 133988 | ||
| sdk_kv_retrieval_duration_milliseconds_bucket{le="2500",agent="sdk/2.4.5.0",bucket="travel-sample",node="node1",node_uuid="91442eb8202e0e16bbb59624d9ccdb0a"} 139823 | ||
| 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 | ||
| ---- | ||
| ==== | ||
|
RayOffiah marked this conversation as resolved.
|
||
| xref:histogram-output[xrefstyle=short] demonstrates a series of `kv` retrieval times for the buckets in a node. | ||
| Each line gives the retrieval count for a particular range. | ||
| The retrieval duration counts are grouped by latency buckets: for example, requests completed in stem:[le 1] ms total 24,054, those in stem:[le 10] ms total 33,444, and so on. | ||
|
|
||
| There are two special metrics associated with each histogram: `_sum` and `_count` that represent the overall sum of all buckets, and total number of the points in the histogram. | ||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.