From 1cb192559af9aa2de8acc88b86decb4409aad7a3 Mon Sep 17 00:00:00 2001 From: Euro Lew Date: Tue, 30 Jul 2024 16:43:01 +0100 Subject: [PATCH 1/3] docs: exporter metrics usage --- docs/self-managed/concepts/exporters.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/self-managed/concepts/exporters.md b/docs/self-managed/concepts/exporters.md index 78f6c463c5..84bd40f8ea 100644 --- a/docs/self-managed/concepts/exporters.md +++ b/docs/self-managed/concepts/exporters.md @@ -62,7 +62,13 @@ The last point is there to provide individual exporters to perform lightweight validation of their configuration (e.g. fail if missing arguments). For this validation call, the given context will report a partition ID (via `Context#getPartitionId()`) with a pseudo-null value, i.e. `Context#NULL_PARTITION_VALUE`). However, at runtime, it will report the appropriate partition ID on which the exporter is running. One caveat is that an instance of an exporter is created and immediately thrown away. Therefore, exporters should not perform any computationally -heavy work during instantiation/configuration. +heavy work during instantiation/configuration. + +### Metrics +The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Configuration)` method through the configuration. Any metrics to be exported +should interact with the registry. + +When an exporter is validated it is only provided with an in-memory register which is then discarded. :::note Zeebe creates a single isolated class loader for every JAR referenced by exporter configurations. If the same JAR is reused to define different exporters, these will share the same class loader. From 22fcd8a52dad852e1e77dc43c5c75366820c0f48 Mon Sep 17 00:00:00 2001 From: Euro Lew Date: Tue, 30 Jul 2024 16:50:47 +0100 Subject: [PATCH 2/3] style: prettier formatted --- docs/self-managed/concepts/exporters.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/self-managed/concepts/exporters.md b/docs/self-managed/concepts/exporters.md index 84bd40f8ea..1614b06d35 100644 --- a/docs/self-managed/concepts/exporters.md +++ b/docs/self-managed/concepts/exporters.md @@ -62,9 +62,10 @@ The last point is there to provide individual exporters to perform lightweight validation of their configuration (e.g. fail if missing arguments). For this validation call, the given context will report a partition ID (via `Context#getPartitionId()`) with a pseudo-null value, i.e. `Context#NULL_PARTITION_VALUE`). However, at runtime, it will report the appropriate partition ID on which the exporter is running. One caveat is that an instance of an exporter is created and immediately thrown away. Therefore, exporters should not perform any computationally -heavy work during instantiation/configuration. +heavy work during instantiation/configuration. ### Metrics + The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Configuration)` method through the configuration. Any metrics to be exported should interact with the registry. From d1a0dcf0c11fda999f0ec6f62062fbd4fe36ffeb Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Wed, 31 Jul 2024 08:42:21 -0400 Subject: [PATCH 3/3] style(formatting): minor grammatical tweaks --- docs/self-managed/concepts/exporters.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/self-managed/concepts/exporters.md b/docs/self-managed/concepts/exporters.md index 1614b06d35..42a7888c07 100644 --- a/docs/self-managed/concepts/exporters.md +++ b/docs/self-managed/concepts/exporters.md @@ -66,10 +66,9 @@ heavy work during instantiation/configuration. ### Metrics -The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Configuration)` method through the configuration. Any metrics to be exported -should interact with the registry. +The exporter is provided with a Micrometer [MeterRegistry](https://docs.micrometer.io/micrometer/reference/concepts/registry.html) in the `Exporter#configure(Configuration)` method through the configuration. Any metrics to be exported should interact with the registry. -When an exporter is validated it is only provided with an in-memory register which is then discarded. +When an exporter is validated, it is only provided with an in-memory register which is then discarded. :::note Zeebe creates a single isolated class loader for every JAR referenced by exporter configurations. If the same JAR is reused to define different exporters, these will share the same class loader.