Add configuration for JMX metrics.

Author: jefchien

instrumentation/jmx-metrics/build.gradle.kts

@@ -0,0 +1,21 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+plugins {
+  java
+  id("com.github.johnrengelman.shadow")
+}
+
+base.archivesBaseName = "aws-instrumentation-jmx-metrics"

instrumentation/jmx-metrics/src/main/resources/README.md

@@ -0,0 +1,20 @@
+## JMX Metrics
+The package provides all the configurations needed to have the [JMX Metric Insight](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/javaagent/README.md)
+instrumentation support the same metrics as the [JMX Metric Gatherer](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/jmx-metrics).
+
+It is required at least until [open-telemetry/opentelemetry-java-instrumentation#9765](https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/9765) is addressed.
+
+### view.yaml
+A [Metric View](https://opentelemetry.io/docs/specs/otel/metrics/sdk/#view) is functionality the OpenTelemetry SDK
+supports that allows users to customize the metrics outputted by the SDK. The SDK also supports [configuring views
+via YAML](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/incubator#view-file-configuration),
+which can be specified via property or environment variable. In this case, the view is configured to only retain metrics
+from the JMX Metric Insight instrumentation.
+
+```
+OTEL_EXPERIMENTAL_METRICS_VIEW_CONFIG: classpath:/jmx/view.yaml 
+```
+
+### rules/*.yaml
+The rules are a translation of the JMX Metric Gatherer's [target systems](https://github.com/open-telemetry/opentelemetry-java-contrib/tree/main/jmx-metrics/src/main/resources/target-systems)
+based on the [JMX metric rule YAML schema](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/javaagent/README.md#basic-syntax).

instrumentation/jmx-metrics/src/main/resources/jmx/rules/jvm.yaml

@@ -0,0 +1,53 @@
+---
+rules:
+  - bean: java.lang:type=ClassLoading
+    unit: "1"
+    prefix: jvm.classes.
+    type: gauge
+    mapping:
+      LoadedClassCount:
+        metric: loaded
+        desc: Number of loaded classes
+  - bean: java.lang:type=GarbageCollector,*
+    prefix: jvm.gc.collections.
+    type: counter
+    metricAttribute:
+      name: param(name)
+    mapping:
+      CollectionCount:
+        metric: count
+        unit: "1"
+        desc: Total number of collections that have occurred
+      CollectionTime:
+        metric: elapsed
+        unit: ms
+        desc: The approximate accumulated collection elapsed time in milliseconds
+  - bean: java.lang:type=Memory
+    unit: by
+    prefix: jvm.memory.
+    type: gauge
+    mapping:
+      HeapMemoryUsage.used:
+        metric: heap
+        desc: The current heap usage
+      NonHeapMemoryUsage.used:
+        metric: nonheap
+        desc: The current non-heap usage
+  - bean: java.lang:type=MemoryPool,*
+    unit: by
+    prefix: jvm.memory.pool.
+    type: gauge
+    metricAttribute:
+      name: param(name)
+    mapping:
+      Usage.used:
+        metric: usage
+        desc: Current memory pool usage
+  - bean: java.lang:type=Threading
+    unit: "1"
+    prefix: jvm.threads.
+    type: gauge
+    mapping:
+      ThreadCount:
+        metric: count
+        desc: Number of threads

instrumentation/jmx-metrics/src/main/resources/jmx/rules/kafka-consumer.yaml

@@ -0,0 +1,51 @@
+---
+rules:
+  - bean: kafka.consumer:client-id=*,type=consumer-fetch-manager-metrics
+    metricAttribute:
+      client-id: param(client-id)
+    mapping:
+      fetch-rate:
+        metric: kafka.consumer.fetch-rate
+        type: gauge
+        desc: The number of fetch requests for all topics per second
+        unit: "1"
+      records-lag-max:
+        metric: kafka.consumer.records-lag-max
+        type: gauge
+        desc: Number of messages the consumer lags behind the producer
+        unit: "1"
+      bytes-consumed-rate:
+        metric: kafka.consumer.total.bytes-consumed-rate
+        type: gauge
+        desc: The average number of bytes consumed for all topics per second
+        unit: by
+      fetch-size-avg:
+        metric: kafka.consumer.total.fetch-size-avg
+        type: gauge
+        desc: The average number of bytes fetched per request for all topics
+        unit: by
+      records-consumed-rate:
+        metric: kafka.consumer.total.records-consumed-rate
+        type: gauge
+        desc: The average number of records consumed for all topics per second
+        unit: "1"
+  - bean: kafka.consumer:client-id=*,topic=*,type=consumer-fetch-manager-metrics
+    metricAttribute:
+      client-id: param(client-id)
+      topic: param(topic)
+    mapping:
+      bytes-consumed-rate:
+        metric: kafka.consumer.bytes-consumed-rate
+        type: gauge
+        desc: The average number of bytes consumed per second
+        unit: by
+      fetch-size-avg:
+        metric: kafka.consumer.fetch-size-avg
+        type: gauge
+        desc: The average number of bytes fetched per request
+        unit: by
+      records-consumed-rate:
+        metric: kafka.consumer.records-consumed-rate
+        type: gauge
+        desc: The average number of records consumed per second
+        unit: "1"

instrumentation/jmx-metrics/src/main/resources/jmx/rules/kafka-producer.yaml

@@ -0,0 +1,61 @@
+---
+rules:
+  - bean: kafka.producer:client-id=*,type=producer-metrics
+    metricAttribute:
+      client-id: param(client-id)
+    mapping:
+      io-wait-time-ns-avg:
+        metric: kafka.producer.io-wait-time-ns-avg
+        type: gauge
+        desc: The average length of time the I/O thread spent waiting for a socket ready for reads or writes
+        unit: ns
+      outgoing-byte-rate:
+        metric: kafka.producer.outgoing-byte-rate
+        type: gauge
+        desc: The average number of outgoing bytes sent per second to all servers
+        unit: by
+      request-latency-avg:
+        metric: kafka.producer.request-latency-avg
+        type: gauge
+        desc: The average request latency
+        unit: ms
+      request-rate:
+        metric: kafka-producer.request-rate
+        type: gauge
+        desc: The average number of requests sent per second
+        unit: "1"
+      response-rate:
+        metric: kafka.producer.response-rate
+        type: gauge
+        desc: Responses received per second
+        unit: "1"
+  - bean: kafka.producer:client-id=*,topic=*,type=producer-topic-metrics
+    metricAttribute:
+      client-id: param(client-id)
+      topic: param(topic)
+    mapping:
+      byte-rate:
+        metric: kafka.producer.byte-rate
+        type: gauge
+        desc: The average number of bytes sent per second for a topic
+        unit: by
+      compression-rate:
+        metric: kafka.producer.compression-rate
+        type: gauge
+        desc: The average compression rate of record batches for a topic
+        unit: "1"
+      record-error-rate:
+        metric: kafka.producer.record-error-rate
+        type: gauge
+        desc: The average per-second number of record sends that resulted in errors for a topic
+        unit: "1"
+      record-retry-rate:
+        metric: kafka.producer.record-retry-rate
+        type: gauge
+        desc: The average per-second number of retried record sends for a topic
+        unit: "1"
+      record-send-rate:
+        metric: kafka.producer.record-send-rate
+        type: gauge
+        desc: The average number of records sent per second for a topic
+        unit: "1"