Skip to content

[receiver/elasticsearch]: add fielddata memory size metrics on index level #14922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
djaglowski merged 1 commit into from
Nov 11, 2022
Merged

[receiver/elasticsearch]: add fielddata memory size metrics on index level #14922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .chloggen/elasticsearch-fielddata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 fielddata memory size metrics on index level

# 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:
1 change: 1 addition & 0 deletions receiver/elasticsearchreceiver/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ These are the metrics available for this scraper.
| **elasticsearch.cluster.state_queue** | Number of cluster states in queue. | 1 | Sum(Int) | <ul> <li>cluster_state_queue_state</li> </ul> |
| **elasticsearch.cluster.state_update.count** | The number of cluster state update attempts that changed the cluster state since the node started. | 1 | Sum(Int) | <ul> <li>cluster_state_update_state</li> </ul> |
| **elasticsearch.cluster.state_update.time** | The cumulative amount of time updating the cluster state since the node started. | ms | Sum(Int) | <ul> <li>cluster_state_update_state</li> <li>cluster_state_update_type</li> </ul> |
| elasticsearch.index.cache.memory.usage | The size in bytes of the cache for an index. | By | Sum(Int) | <ul> <li>cache_name</li> <li>index_aggregation_type</li> </ul> |
| **elasticsearch.index.operations.completed** | The number of operations completed for an index. | {operations} | Sum(Int) | <ul> <li>operation</li> <li>index_aggregation_type</li> </ul> |
| elasticsearch.index.operations.merge.docs_count | The total number of documents in merge operations for an index. | {documents} | Sum(Int) | <ul> <li>index_aggregation_type</li> </ul> |
| elasticsearch.index.operations.merge.size | The total size of merged segments for an index. | By | Sum(Int) | <ul> <li>index_aggregation_type</li> </ul> |
Expand Down
66 changes: 66 additions & 0 deletions receiver/elasticsearchreceiver/internal/metadata/generated_metrics.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions receiver/elasticsearchreceiver/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -838,3 +838,12 @@ metrics:
value_type: int
attributes: [index_aggregation_type]
enabled: false
elasticsearch.index.cache.memory.usage:
description: The size in bytes of the cache for an index.
unit: By
sum:
monotonic: false
aggregation: cumulative
value_type: int
attributes: [cache_name, index_aggregation_type]
enabled: false
9 changes: 8 additions & 1 deletion receiver/elasticsearchreceiver/scraper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ func (r *elasticsearchScraper) scrapeIndicesMetrics(ctx context.Context, now pco
indexStats, err := r.client.IndexStats(ctx, r.cfg.Indices)

if err != nil {
errs.AddPartial(16, err)
errs.AddPartial(18, err)
return
}

Expand Down Expand Up @@ -414,5 +414,12 @@ func (r *elasticsearchScraper) scrapeOneIndexMetrics(now pcommon.Timestamp, name
now, stats.Total.TranslogStats.SizeInBy, metadata.AttributeIndexAggregationTypeTotal,
)

r.mb.RecordElasticsearchIndexCacheMemoryUsageDataPoint(
now, stats.Primaries.FieldDataCache.MemorySizeInBy, metadata.AttributeCacheNameFielddata, metadata.AttributeIndexAggregationTypePrimaryShards,
)
r.mb.RecordElasticsearchIndexCacheMemoryUsageDataPoint(
now, stats.Total.FieldDataCache.MemorySizeInBy, metadata.AttributeCacheNameFielddata, metadata.AttributeIndexAggregationTypeTotal,
)

r.mb.EmitForResource(metadata.WithElasticsearchIndexName(name), metadata.WithElasticsearchClusterName(r.clusterName))
}
1 change: 1 addition & 0 deletions receiver/elasticsearchreceiver/scraper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ func TestScraper(t *testing.T) {
config.Metrics.ElasticsearchIndexSegmentsMemory.Enabled = true
config.Metrics.ElasticsearchIndexTranslogOperations.Enabled = true
config.Metrics.ElasticsearchIndexTranslogSize.Enabled = true
config.Metrics.ElasticsearchIndexCacheMemoryUsage.Enabled = true

sc := newElasticSearchScraper(componenttest.NewNopReceiverCreateSettings(), config)

Expand Down
98 changes: 98 additions & 0 deletions receiver/elasticsearchreceiver/testdata/expected_metrics/full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2768,6 +2768,55 @@
]
},
"unit": "By"
},
{
"description": "The size in bytes of the cache for an index.",
"name": "elasticsearch.index.cache.memory.usage",
"sum": {
"aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
"isMonotonic": false,
"dataPoints": [
{
"asInt": "3",
"attributes": [
{
"key": "cache_name",
"value": {
"stringValue": "fielddata"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "primary_shards"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
},
{
"asInt": "3",
"attributes": [
{
"key": "cache_name",
"value": {
"stringValue": "fielddata"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "total"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
}
]
},
"unit": "By"
}
],
"scope": {
Expand Down Expand Up @@ -3168,6 +3217,55 @@
]
},
"unit": "By"
},
{
"description": "The size in bytes of the cache for an index.",
"name": "elasticsearch.index.cache.memory.usage",
"sum": {
"aggregationTemporality": "AGGREGATION_TEMPORALITY_CUMULATIVE",
"isMonotonic": false,
"dataPoints": [
{
"asInt": "3",
"attributes": [
{
"key": "cache_name",
"value": {
"stringValue": "fielddata"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "primary_shards"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
},
{
"asInt": "3",
"attributes": [
{
"key": "cache_name",
"value": {
"stringValue": "fielddata"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "total"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
}
]
},
"unit": "By"
}
],
"scope": {
Expand Down
8 changes: 4 additions & 4 deletions receiver/elasticsearchreceiver/testdata/sample_payloads/indices.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
"evictions" : 0
},
"fielddata" : {
"memory_size_in_bytes" : 0,
"memory_size_in_bytes" : 3,
"evictions" : 0
},
"completion" : {
Expand Down Expand Up @@ -221,7 +221,7 @@
"evictions" : 0
},
"fielddata" : {
"memory_size_in_bytes" : 0,
"memory_size_in_bytes" : 3,
"evictions" : 0
},
"completion" : {
Expand Down Expand Up @@ -353,7 +353,7 @@
"evictions" : 0
},
"fielddata" : {
"memory_size_in_bytes" : 0,
"memory_size_in_bytes" : 3,
"evictions" : 0
},
"completion" : {
Expand Down Expand Up @@ -481,7 +481,7 @@
"evictions" : 0
},
"fielddata" : {
"memory_size_in_bytes" : 0,
"memory_size_in_bytes" : 3,
"evictions" : 0
},
"completion" : {
Expand Down