Skip to content
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.

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

[receiver/elasticsearch]: add metrics for merge operations with total shard aggregation #14870

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .chloggen/elasticsearch-total-merge.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
change_type: enhancement
component: elasticsearchreceiver
note: Add metrics related to merge operations with aggregated for all shards
issues: [14635]

2 changes: 2 additions & 0 deletions receiver/elasticsearchreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ These are the metrics available for this scraper.
| **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.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> |
| **elasticsearch.index.operations.time** | Time spent on operations for an index. | ms | Sum(Int) | <ul> <li>operation</li> <li>index_aggregation_type</li> </ul> |
| **elasticsearch.index.shards.size** | The size of the shards assigned to this index. | By | Sum(Int) | <ul> <li>index_aggregation_type</li> </ul> |
| **elasticsearch.indexing_pressure.memory.limit** | Configured memory limit, in bytes, for the indexing requests. | By | Gauge(Int) | <ul> </ul> |
Expand Down

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

Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ type NodeStatsNodesInfoIndices struct {
IndexingOperations IndexingOperations `json:"indexing"`
GetOperation GetOperation `json:"get"`
SearchOperations SearchOperations `json:"search"`
MergeOperations BasicIndexOperation `json:"merges"`
MergeOperations MergeOperations `json:"merges"`
RefreshOperations BasicIndexOperation `json:"refresh"`
FlushOperations BasicIndexOperation `json:"flush"`
WarmerOperations BasicIndexOperation `json:"warmer"`
Expand All @@ -195,6 +195,12 @@ type BasicIndexOperation struct {
TotalTimeInMs int64 `json:"total_time_in_millis"`
}

type MergeOperations struct {
BasicIndexOperation
TotalSizeInBytes int64 `json:"total_size_in_bytes"`
TotalDocs int64 `json:"total_docs"`
}

type IndexingOperations struct {
IndexTotal int64 `json:"index_total"`
IndexTimeInMs int64 `json:"index_time_in_millis"`
Expand Down
18 changes: 18 additions & 0 deletions receiver/elasticsearchreceiver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -767,3 +767,21 @@ metrics:
value_type: int
attributes: [index_aggregation_type]
enabled: true
elasticsearch.index.operations.merge.size:
description: The total size of merged segments for an index.
unit: By
sum:
monotonic: true
aggregation: cumulative
value_type: int
attributes: [index_aggregation_type]
enabled: false
elasticsearch.index.operations.merge.docs_count:
description: The total number of documents in merge operations for an index.
unit: "{documents}"
sum:
monotonic: true
aggregation: cumulative
value_type: int
attributes: [index_aggregation_type]
enabled: false
12 changes: 11 additions & 1 deletion receiver/elasticsearchreceiver/scraper.go
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(4, err)
errs.AddPartial(8, err)
return
}

Expand All @@ -359,6 +359,16 @@ func (r *elasticsearchScraper) scrapeOneIndexMetrics(now pcommon.Timestamp, name
r.mb.RecordElasticsearchIndexOperationsTimeDataPoint(
now, stats.Total.SearchOperations.QueryTimeInMs, metadata.AttributeOperationQuery, metadata.AttributeIndexAggregationTypeTotal,
)
r.mb.RecordElasticsearchIndexOperationsTimeDataPoint(
now, stats.Total.MergeOperations.TotalTimeInMs, metadata.AttributeOperationMerge, metadata.AttributeIndexAggregationTypeTotal,
)

r.mb.RecordElasticsearchIndexOperationsMergeSizeDataPoint(
now, stats.Total.MergeOperations.TotalSizeInBytes, metadata.AttributeIndexAggregationTypeTotal,
)
r.mb.RecordElasticsearchIndexOperationsMergeDocsCountDataPoint(
now, stats.Total.MergeOperations.TotalDocs, metadata.AttributeIndexAggregationTypeTotal,
)

r.mb.RecordElasticsearchIndexShardsSizeDataPoint(
now, stats.Total.StoreInfo.SizeInBy, metadata.AttributeIndexAggregationTypeTotal,
Expand Down
6 changes: 5 additions & 1 deletion receiver/elasticsearchreceiver/scraper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ const noNodesExpectedMetricsPath = "./testdata/expected_metrics/noNodes.json"
func TestScraper(t *testing.T) {
t.Parallel()

sc := newElasticSearchScraper(componenttest.NewNopReceiverCreateSettings(), createDefaultConfig().(*Config))
config := createDefaultConfig().(*Config)
config.Metrics.ElasticsearchIndexOperationsMergeSize.Enabled = true
config.Metrics.ElasticsearchIndexOperationsMergeDocsCount.Enabled = true

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

err := sc.start(context.Background(), componenttest.NewNopHost())
require.NoError(t, err)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2297,6 +2297,25 @@
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
},
{
"asInt": "12",
"attributes": [
{
"key": "operation",
"value": {
"stringValue": "merge"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "total"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
}
]
},
Expand Down Expand Up @@ -2447,6 +2466,25 @@
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
},
{
"asInt": "12",
"attributes": [
{
"key": "operation",
"value": {
"stringValue": "merge"
}
},
{
"key": "aggregation",
"value": {
"stringValue": "total"
}
}
],
"startTimeUnixNano": "1661811689941624000",
"timeUnixNano": "1661811689943245000"
}
]
},
Expand Down
Loading