This is an automated email from the ASF dual-hosted git repository.
sk0x50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new a114067fc63 IGNITE-26064 Update metric log exporter config params
(#6417)
a114067fc63 is described below
commit a114067fc6374182f9966a3158db7dc6eb97844b
Author: jinxxxoid <[email protected]>
AuthorDate: Thu Aug 21 17:07:02 2025 +0400
IGNITE-26064 Update metric log exporter config params (#6417)
---
.../metrics/configuring-metrics.adoc | 37 +++++++++++++++++++++-
1 file changed, 36 insertions(+), 1 deletion(-)
diff --git a/docs/_docs/administrators-guide/metrics/configuring-metrics.adoc
b/docs/_docs/administrators-guide/metrics/configuring-metrics.adoc
index b5ea350c651..5597c9636fa 100644
--- a/docs/_docs/administrators-guide/metrics/configuring-metrics.adoc
+++ b/docs/_docs/administrators-guide/metrics/configuring-metrics.adoc
@@ -90,6 +90,41 @@ After you do, JMX monitoring tools will be able to collect
enabled metrics from
image::images/jmc-metrics.png[]
+=== Log Exporter
+
+Log exporter writes metrics data to the application log, so they can be
consumed by log collectors or inspected manually. To configure it, use the
following parameters:
+
+[cols="30%,60%,10%",opts="header"]
+|===
+|Name
+|Description
+|Default value
+
+|periodMillis|Export interval for the metrics, in milliseconds.|30000
+|oneLinePerMetricSource|Define whether to print all metrics from one metric
source on a single log line.|true
+|enabledMetrics|List of enabled metric sources. If this list is non-empty,
only the listed metric sources will be printed, all others will be skipped. A
wildcard can be used to match a prefix (for example, `jvm.*`). By default, the
metrics of some background activities are printed. |"metastorage",
"placement-driver", "resource.vacuum"
+|===
+
+To add log exporter to cluster exporters list, run the following command and
define all the metrics to print in `enabledMetrics` list:
+[source, bash]
+----
+cluster config update ignite.metrics.exporters.logPush
'{"exporterName":"logPush","periodMillis":30000,"oneLinePerMetricSource":true,"enabledMetrics":[]}'
+----
+
+Updated exporters configuration should look like this:
+
+----
+exporters=[
+ {
+ enabledMetrics=[]
+ exporterName=logPush
+ name=logPush
+ oneLinePerMetricSource=true
+ periodMillis=30000
+ }
+]
+----
+
=== OpenTelemetry
The link:https://opentelemetry.io/[OpenTelemetry] exporter connects to an
OpenTelemetry service that is provided in configuration and sends cluster
information to it. Each node sends metrics independently, and requires access
to the specified endpoint.
@@ -166,7 +201,7 @@ cluster config update ignite.metrics.exporters.test:
{exporterName:otlp, endpoin
==== Connection to Prometheus
-When connecting to Prometheus, you need to use the protobuf protocol and send
metrics to the `/api/v1/otlp/v1/metrics` after the otlp metrics receiver is
enabled as described in
link:https://prometheus.io/docs/guides/opentelemetry/[Prometheus documentation]:
+When connecting to Prometheus, you need to use the protobuf protocol and send
metrics to the `/api/v1/otlp/v1/metrics` after the OTLP metrics receiver is
enabled as described in
link:https://prometheus.io/docs/guides/opentelemetry/[Prometheus documentation]:
----
cluster config update ignite.metrics.exporters.test: {exporterName:otlp,
endpoint:"http://localhost:9090/api/v1/otlp/v1/metrics";,
protocol:"http/protobuf"}
