[receiver/elasticsearch] add jvm heap percentage usage metric (open-t…

…elemetry#16173)

* feat: add jvm heap percentage usage metric

.chloggen/elastic-jvm-heap-percent.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: elasticsearchreceiver
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: add jvm heap percentage usage metric
+
+# One or more tracking issues related to the change
+issues: [14635]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

receiver/elasticsearchreceiver/README.md

@@ -55,6 +55,5 @@ The following metric are available with versions:
 - `elasticsearch.cluster.state_update.time` >= [7.16.0](https://www.elastic.co/guide/en/elasticsearch/reference/7.16/release-notes-7.16.0.html)
 
 Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)
-
 [beta]:https://github.com/open-telemetry/opentelemetry-collector#beta
 [contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

receiver/elasticsearchreceiver/documentation.md

@@ -82,6 +82,7 @@ These are the metrics available for this scraper.
 | **jvm.memory.heap.committed** | The amount of memory that is guaranteed to be available for the heap | By | Gauge(Int) | <ul> </ul> |
 | **jvm.memory.heap.max** | The maximum amount of memory can be used for the heap | By | Gauge(Int) | <ul> </ul> |
 | **jvm.memory.heap.used** | The current heap memory usage | By | Gauge(Int) | <ul> </ul> |
+| jvm.memory.heap.utilization | Fraction of heap memory usage | 1 | Gauge(Double) | <ul> </ul> |
 | **jvm.memory.nonheap.committed** | The amount of memory that is guaranteed to be available for non-heap purposes | By | Gauge(Int) | <ul> </ul> |
 | **jvm.memory.nonheap.used** | The current non-heap memory usage | By | Gauge(Int) | <ul> </ul> |
 | **jvm.memory.pool.max** | The maximum amount of memory can be used for the memory pool | By | Gauge(Int) | <ul> <li>memory_pool_name</li> </ul> |

receiver/elasticsearchreceiver/internal/model/nodestats.go

@@ -267,6 +267,7 @@ type JVMMemoryInfo struct {
  NonHeapUsedInBy int64 `json:"non_heap_used_in_bytes"`
  MaxHeapInBy int64 `json:"heap_max_in_bytes"`
  HeapCommittedInBy int64 `json:"heap_committed_in_bytes"`
+ HeapUsedPercent int64 `json:"heap_used_percent"`
  NonHeapComittedInBy int64 `json:"non_heap_committed_in_bytes"`
  MemoryPools JVMMemoryPools `json:"pools"`
 }

receiver/elasticsearchreceiver/metadata.yaml

@@ -473,6 +473,13 @@ metrics:
  value_type: int
  attributes: []
  enabled: true
+ jvm.memory.heap.utilization:
+ description: Fraction of heap memory usage
+ unit: 1
+ gauge:
+ value_type: double
+ attributes: []
+ enabled: false
  jvm.memory.heap.committed:
  description: The amount of memory that is guaranteed to be available for the heap
  unit: By

receiver/elasticsearchreceiver/scraper.go

@@ -220,6 +220,8 @@ func (r *elasticsearchScraper) scrapeNodeMetrics(ctx context.Context, now pcommo
  r.mb.RecordJvmMemoryHeapMaxDataPoint(now, info.JVMInfo.JVMMemoryInfo.MaxHeapInBy)
  r.mb.RecordJvmMemoryHeapUsedDataPoint(now, info.JVMInfo.JVMMemoryInfo.HeapUsedInBy)
  r.mb.RecordJvmMemoryHeapCommittedDataPoint(now, info.JVMInfo.JVMMemoryInfo.HeapCommittedInBy)
+ // Elasticsearch sends this data in percent, but we want to represent it as a number between 0 and 1, so we need to divide.
+ r.mb.RecordJvmMemoryHeapUtilizationDataPoint(now, float64(info.JVMInfo.JVMMemoryInfo.HeapUsedPercent)/100)
 
  r.mb.RecordJvmMemoryNonheapUsedDataPoint(now, info.JVMInfo.JVMMemoryInfo.NonHeapUsedInBy)
  r.mb.RecordJvmMemoryNonheapCommittedDataPoint(now, info.JVMInfo.JVMMemoryInfo.NonHeapComittedInBy)

receiver/elasticsearchreceiver/scraper_test.go

@@ -46,6 +46,8 @@ func TestScraper(t *testing.T) {
  config.Metrics.ElasticsearchNodeOperationsGetCompleted.Enabled = true
  config.Metrics.ElasticsearchNodeOperationsGetTime.Enabled = true
 
+ config.Metrics.JvmMemoryHeapUtilization.Enabled = true
+
  config.Metrics.ElasticsearchIndexOperationsMergeSize.Enabled = true
  config.Metrics.ElasticsearchIndexOperationsMergeDocsCount.Enabled = true
  config.Metrics.ElasticsearchIndexSegmentsCount.Enabled = true

receiver/elasticsearchreceiver/testdata/expected_metrics/full.json

@@ -2249,6 +2249,20 @@
  },
  "name": "jvm.threads.count",
  "unit": "1"
+ },
+ {
+ "description": "Fraction of heap memory usage",
+ "gauge": {
+ "dataPoints": [
+ {
+ "asDouble": "0.56",
+ "startTimeUnixNano": "1661811689941624000",
+ "timeUnixNano": "1661811689943245000"
+ }
+ ]
+ },
+ "name": "jvm.memory.heap.utilization",
+ "unit": "1"
  }
  ],
  "scope": {