[GitHub] [incubator-inlong-website] aloyszhang commented on a change in pull request #187: [INLONG-1808]DataProxy support monitor indicator with JMX.

[GitBox <gi...@apache.org>]

aloyszhang commented on a change in pull request #187:
URL: https://github.com/apache/incubator-inlong-website/pull/187#discussion_r752005175



##########
File path: docs/modules/dataproxy/architecture.md
##########
@@ -150,3 +150,51 @@ Sink configuration example and corresponding notes
     
     agent1.sinks.meta-sink-more1.max-survived-size = 3000000
     Maximum number of caches
+    
+# 4、Monitor metrics configuration instructions
+
+  DataProxy provide monitor indicator based on JMX, user can implement the code that read the metrics and report to user-defined monitor system.
+Source-module and Sink-module can add monitor metric class that is the subclass of org.apache.inlong.commons.config.metrics.MetricItemSet, and register it to MBeanServer. User-defined plugin can get module metric with JMX, and report metric data to different monitor system.
+
+  User can describe the configuration in the file "common.properties ". For example:
+  
+	metricDomains=DataProxy
+	metricDomains.DataProxy.domainListeners=org.apache.inlong.dataproxy.metrics.prometheus.PrometheusMetricListener
+	metricDomains.DataProxy.snapshotInterval=60000

Review comment:
       It's better to cover this in a code block or shell script block




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org