Refine docs

Author: liurui-1

CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 ==========
 
+## OJR Release v0.6.1
+
+- Some improvements of IBM MQ Receiver/Agent
+- Fix some documents issue
+
 ## OJR Release v0.6.0
 
 - Handled cardinality related concerns

README.md

@@ -71,4 +71,13 @@ User can use `OJR_CONFIG` environment variable or Java system property to specif
 
 According to the Java convention, the logging configuration file can also be specified by `java.util.logging.config.file` system property.
 
-User can also just specify the file directory of the OJR configuration file and logging configuration file by `OJR_DIR` environment variable or Java system property. For example, `OJR_DIR=/path/to/config/dir`.
+User can also just specify the file directory of the OJR configuration file and logging configuration file by `OJR_DIR` environment variable or Java system property. For example, `OJR_DIR=/path/to/config/dir`.
+
+
+## Some advanced configurations
+
+OJR recognizes the following standard OpenTelemetry environment variables:
+
+- `OTEL_RESOURCE_ATTRIBUTES` is used to add more OpenTelemetry resource attributes. For example, OTEL_RESOURCE_ATTRIBUTES="custom.bizID=xxx,customer.bizName=yyy".
+- `OTEL_EXPORTER_OTLP_HEADERS` is used to add more HTTP headers to the built-in OTLP exporter. For example, OTEL_EXPORTER_OTLP_HEADERS="api-key=key,other-config-value=value".
+- `OTEL_EXPORTER_OTLP_CERTIFICATE` is used to specify the path of the certificate file for the built-in OTLP exporter. For example, OTEL_EXPORTER_OTLP_CERTIFICATE='/tmp/lr/servercert.cer'.

ojr-dameng-db/build.gradle

@@ -47,9 +47,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 test {
     useJUnitPlatform()
 }

ojr-ibmmq/build.gradle

@@ -49,6 +49,11 @@ applicationDistribution.from("scripts") {
     into "scripts"
 }
 
+applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
+    into "logs"
+}
+
 test {
     useJUnitPlatform()
 }

ojr-ibmmq/config/config.yaml

@@ -12,8 +12,8 @@ instances:
     #cipherSuite: TLS_RSA_WITH_AES_256_CBC_SHA256
 
     ## Data collector properties:
-    poll.interval: 25
-    callback.interval: 30
+    otel.poll.interval: 25
+    otel.callback.interval: 30
     #otel.backend.url: http://localhost:4318
     otel.transport: prometheus
     prometheus.port: 16543
@@ -22,6 +22,7 @@ instances:
     isLocal: false
     #user: liurui
     #password: xxxxxxxx
+    #host: 192.168.1.1
     #port: 1414
     queuesMonitored: Q*
     #customEventQueues:
@@ -30,8 +31,8 @@ instances:
     #cipherSuite: TLS_RSA_WITH_AES_256_CBC_SHA256
 
     ## Data collector properties:
-    poll.interval: 25
-    callback.interval: 30
+    otel.poll.interval: 25
+    otel.callback.interval: 30
     #otel.backend.url: http://localhost:4318
     otel.transport: prometheus
     prometheus.port: 16543

ojr-informix-db/build.gradle

@@ -49,9 +49,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 applicationDistribution.from("scripts/informix") {
     into "scripts"
 }

ojr-informix-db/config/config.yaml

@@ -18,7 +18,7 @@ instances:
     otel.service.name: InformixDB
 
     #Data collector properties:
-    #Either use `poll.interval` or `custom.poll.interval`
+    #Either use `otel.poll.interval` or `custom.poll.interval`
     otel.poll.interval: 25
     #All three category value is Mandatory if leveraging Custom Poll Rate
     custom.poll.interval:

ojr-linux-host/build.gradle

@@ -45,9 +45,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 applicationDistribution.from("scripts") {
     into "scripts"
 }

ojr-mq-appliance/build.gradle

@@ -45,9 +45,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 applicationDistribution.from("scripts") {
     into "scripts"
 }

ojr-mq-appliance/config/config.yaml

@@ -6,8 +6,8 @@ instances:
     appliance.password: xxxxxxxx
 
     #Data collector properties:
-    poll.interval: 25
-    callback.interval: 30
+    otel.poll.interval: 25
+    otel.callback.interval: 30
     #otel.backend.url: http://localhost:4317
     otel.backend.url: http://localhost:4318
     otel.transport: http+prometheus

ojr-oceanbase-db/build.gradle

@@ -47,9 +47,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 test {
     useJUnitPlatform()
 }

ojr-snmp-host/build.gradle

@@ -47,9 +47,11 @@ applicationDistribution.from("config") {
 }
 
 applicationDistribution.from("logs") {
+    include "PLACE_HOLDER"
     into "logs"
 }
 
+
 applicationDistribution.from("scripts") {
     into "scripts"
 }

ojr-snmp-host/config/config.yaml

@@ -2,8 +2,8 @@ host.system: snmp_host
 
 instances:
   - snmp.host: udp:9.30.78.59/161
-    poll.interval: 25
-    callback.interval: 30
+    otel.poll.interval: 25
+    otel.callback.interval: 30
     #otel.backend.url: http://localhost:4317
     otel.backend.url: http://localhost:4318
     otel.transport: http+prometheus