Rename avg metrics, improve descriptions

Author: nantiferov

exporter/exporter.go

@@ -493,14 +493,14 @@ func NewRedisExporter(uri string, opts Options) (*Exporter, error) {
 		"search_index_doc_table_size_bytes":                  {txt: "Memory used by the document table, contains metadata about each document in the index", lbls: []string{"index_name"}},
 		"search_index_sortable_values_size_bytes":            {txt: "Memory used by sortable values, used for sorting purposes", lbls: []string{"index_name"}},
 		"search_index_key_table_size_bytes":                  {txt: "Memory used by the key table, stores mapping between document IDs and keys", lbls: []string{"index_name"}},
-		"search_index_tag_overhead_size_bytes":               {txt: "Memory overhead of the TAG TrieMaps", lbls: []string{"index_name"}},
-		"search_index_text_overhead_size_bytes":              {txt: "Memory overhead of the TEXT Tries", lbls: []string{"index_name"}},
-		"search_index_total_index_memory_size_bytes":         {txt: "Total memory used by search index", lbls: []string{"index_name"}},
+		"search_index_tag_overhead_size_bytes":               {txt: "Size of the TAG index structures used for optimising performance", lbls: []string{"index_name"}},
+		"search_index_text_overhead_size_bytes":              {txt: "Size of the TEXT index structures used for optimising performance", lbls: []string{"index_name"}},
+		"search_index_total_index_memory_size_bytes":         {txt: "Total memory consumed by all indexes in the DB", lbls: []string{"index_name"}},
 		"search_index_geoshapes_size_bytes":                  {txt: "Memory used by GEO-related fields", lbls: []string{"index_name"}},
-		"search_index_records_per_doc_avg":                   {txt: "Average number of records (including deletions) per document", lbls: []string{"index_name"}},
-		"search_index_bytes_per_record_avg":                  {txt: "Average size of each record in bytes", lbls: []string{"index_name"}},
-		"search_index_offsets_per_term_avg":                  {txt: "Average number of offsets (position information) per term", lbls: []string{"index_name"}},
-		"search_index_offset_bits_per_record_avg":            {txt: "Average number of bits used for offsets per record", lbls: []string{"index_name"}},
+		"search_index_avg_per_doc_records":                   {txt: "Average number of records (including deletions) per document", lbls: []string{"index_name"}},
+		"search_index_avg_per_record_bytes":                  {txt: "Average size of each record in bytes", lbls: []string{"index_name"}},
+		"search_index_avg_per_term_offsets":                  {txt: "Average number of offsets (position information) per term", lbls: []string{"index_name"}},
+		"search_index_avg_per_record_offset_bits":            {txt: "Average number of bits used for offsets per record", lbls: []string{"index_name"}},
 		"search_index_indexing":                              {txt: "Indicates whether the index is currently being generated", lbls: []string{"index_name"}},
 		"search_index_percent_indexed":                       {txt: "Percentage of the index that has been successfully generated (0-1)", lbls: []string{"index_name"}},
 		"search_index_hash_indexing_failures":                {txt: "Number of failures encountered during indexing", lbls: []string{"index_name"}},

exporter/search_indexes.go

@@ -83,10 +83,10 @@ func (e *Exporter) extractSearchIndexesMetrics(ch chan<- prometheus.Metric, c re
 		e.registerConstMetricGauge(ch, "search_index_text_overhead_size_bytes", indexInfo.TextOverheadSizeMb*1048576, indexInfo.IndexName)
 		e.registerConstMetricGauge(ch, "search_index_total_index_memory_size_bytes", indexInfo.TotalIndexMemorySizeMb*1048576, indexInfo.IndexName)
 		e.registerConstMetricGauge(ch, "search_index_geoshapes_size_bytes", indexInfo.GeoshapesSizeMb*1048576, indexInfo.IndexName)
-		e.registerConstMetricGauge(ch, "search_index_records_per_doc_avg", indexInfo.RecordsPerDocAvg, indexInfo.IndexName)
-		e.registerConstMetricGauge(ch, "search_index_bytes_per_record_avg", indexInfo.BytesPerRecordAvg, indexInfo.IndexName)
-		e.registerConstMetricGauge(ch, "search_index_offsets_per_term_avg", indexInfo.OffsetsPerTermAvg, indexInfo.IndexName)
-		e.registerConstMetricGauge(ch, "search_index_offset_bits_per_record_avg", indexInfo.OffsetBitsPerRecordAvg, indexInfo.IndexName)
+		e.registerConstMetricGauge(ch, "search_index_avg_per_doc_records", indexInfo.RecordsPerDocAvg, indexInfo.IndexName)
+		e.registerConstMetricGauge(ch, "search_index_avg_per_record_bytes", indexInfo.BytesPerRecordAvg, indexInfo.IndexName)
+		e.registerConstMetricGauge(ch, "search_index_avg_per_term_offsets", indexInfo.OffsetsPerTermAvg, indexInfo.IndexName)
+		e.registerConstMetricGauge(ch, "search_index_avg_per_record_offset_bits", indexInfo.OffsetBitsPerRecordAvg, indexInfo.IndexName)
 		e.registerConstMetricGauge(ch, "search_index_indexing", float64(indexInfo.Indexing), indexInfo.IndexName)
 		e.registerConstMetricGauge(ch, "search_index_percent_indexed", indexInfo.PercentIndexed, indexInfo.IndexName)
 		e.registerConstMetricGauge(ch, "search_index_hash_indexing_failures", float64(indexInfo.HashIndexingFailures), indexInfo.IndexName)

exporter/search_indexes_test.go

@@ -68,10 +68,10 @@ func TestExtractSearchIndexesMetrics(t *testing.T) {
 			"search_index_text_overhead_size_bytes":      false,
 			"search_index_total_index_memory_size_bytes": false,
 			"search_index_geoshapes_size_bytes":          false,
-			"search_index_records_per_doc_avg":           false,
-			"search_index_bytes_per_record_avg":          false,
-			"search_index_offsets_per_term_avg":          false,
-			"search_index_offset_bits_per_record_avg":    false,
+			"search_index_avg_per_doc_records":           false,
+			"search_index_avg_per_record_bytes":          false,
+			"search_index_avg_per_term_offsets":          false,
+			"search_index_avg_per_record_offset_bits":    false,
 			"search_index_indexing":                      false,
 			"search_index_percent_indexed":               false,
 			"search_index_hash_indexing_failures":        false,