Skip to content

Commit 2a6e774

Browse files
SDK app telemetry in the Server
1 parent 5008377 commit 2a6e774

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

modules/howtos/pages/collecting-information-and-logging.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,3 +255,29 @@ Note that you need to run this command before any of the SDK code is initialized
255255
Once the SDK writes the logs with the tags to a file, you can then use the xref:7.2@server:cli:cbcli/cblogredaction.adoc[`cblogredaction` tool] to obfuscate the log.
256256

257257
* You may wish to read more on Log Redaction xref:7.2@server:manage:manage-logging/manage-logging.adoc#understanding_redaction[in the Server docs].
258+
259+
== SDK Telemetry from the Server
260+
261+
In addition to Tracing and other metrics, and client logging, SDK is telemetry is also sent to the Server -- available from 8.0, and in new Capella Operational clusters -- for ingestion with other Prometheus metrics.
262+
Capella Operatioal exposes these metrics through the UI.
263+
264+
For self-managed Server, collection can be disabled and enabled through the REST API:
265+
266+
[source,console]
267+
----
268+
curl --user Administrator:password http://172.17.0.2:8091/settings/appTelemetry -d enabled=true
269+
----
270+
271+
And the Prometheus-format metrics fetched with:
272+
273+
[source,console]
274+
----
275+
curl --user Administrator:password http://172.17.0.2:8091/metrics
276+
----
277+
278+
There may be advantages to collecting information this way,
279+
but note that metrics are collected per node,
280+
and a central Prometheus instance should be set to collect all metrics so that information is not lost in case of a sudden failover.
281+
282+
Also note that if the cluster is behind a load balancer, the collected metrics may not accurately record the actual correct node with which the SDK interacts.
283+

0 commit comments

Comments
 (0)