This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 1067f45 GEODE-8363: Label Micrometer docs as experimental (#5386)
1067f45 is described below
commit 1067f4545c344d16314fc803264cee793e082416
Author: Karen Miller <[email protected]>
AuthorDate: Mon Jul 20 13:20:01 2020 -0700
GEODE-8363: Label Micrometer docs as experimental (#5386)
Co-authored-by: Karen Miller <[email protected]>
---
.../tools_modules/micrometer/micrometer-configuration.html.md.erb | 2 --
geode-docs/tools_modules/micrometer/micrometer-overview.html.md.erb | 3 +++
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git
a/geode-docs/tools_modules/micrometer/micrometer-configuration.html.md.erb
b/geode-docs/tools_modules/micrometer/micrometer-configuration.html.md.erb
index 0aaf90c..c80c4d7 100644
--- a/geode-docs/tools_modules/micrometer/micrometer-configuration.html.md.erb
+++ b/geode-docs/tools_modules/micrometer/micrometer-configuration.html.md.erb
@@ -105,8 +105,6 @@ Add a line inside the file indicating the fully qualified
class name of your imp
```pre
my.domain.SimpleMetricsPublishingService
```
-Note: The above APIs are considered experimental. Micrometer metrics is a new
addition to <%=vars.product_name%> and the API may change.
-
### Add Your jar File to the classpath When You Start a Server or Locator
To add your metrics publishing service to a server or locator, add your jar
file to the classpath when you start the server or locator via `GFSH` and
specify the `prometheus.metrics.port` listed in SimpleMetricsPublishingService:
diff --git
a/geode-docs/tools_modules/micrometer/micrometer-overview.html.md.erb
b/geode-docs/tools_modules/micrometer/micrometer-overview.html.md.erb
index c5a95e6..676e9bc 100644
--- a/geode-docs/tools_modules/micrometer/micrometer-overview.html.md.erb
+++ b/geode-docs/tools_modules/micrometer/micrometer-overview.html.md.erb
@@ -21,6 +21,9 @@ limitations under the License.
By default, Micrometer is enabeled and can emit metrics to any meter registry.
However, time-based meters are available only when the `time-statistics`
property is turned on.
+The API is currently marked experimental.
+The `MetricsSession` and `MetricsPublishingService` interfaces may change.
+
- **[Micrometer configuration and
publishing](micrometer-configuration.html)**
Using Micrometer may require configuration, and in order to emit
Micrometer metrics to one of the supported APM tools, or to a custom
format/tool, a Meter Registry and accompanying publishing service will need to
be used.
