mlbiscoc commented on code in PR #3482:
URL: https://github.com/apache/solr/pull/3482#discussion_r2288136695
##########
solr/core/src/java/org/apache/solr/search/SolrIndexSearcher.java:
##########
@@ -2589,95 +2602,145 @@ public SolrMetricsContext getSolrMetricsContext() {
return solrMetricsContext;
}
- // TODO SOLR-17458: Migrate to Otel
@Override
public void initializeMetrics(
- SolrMetricsContext parentContext, Attributes attributes, String scope) {
- parentContext.gauge(() -> name, true, "searcherName",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> cachingEnabled, true, "caching",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> openTime, true, "openedAt",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> warmupTime, true, "warmupTime",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- () -> registerTime, true, "registeredAt",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- fullSortCount::sum, true, "fullSortCount",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- skipSortCount::sum, true, "skipSortCount",
Category.SEARCHER.toString(), scope);
- final MetricsMap liveDocsCacheMetrics =
- new MetricsMap(
- (map) -> {
- map.put("inserts", liveDocsInsertsCount.sum());
- map.put("hits", liveDocsHitCount.sum());
- map.put("naiveHits", liveDocsNaiveCacheHitCount.sum());
- });
- parentContext.gauge(
- liveDocsCacheMetrics, true, "liveDocsCache",
Category.SEARCHER.toString(), scope);
- // reader stats
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.numDocs()),
- true,
- "numDocs",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.maxDoc()),
- true,
- "maxDoc",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.maxDoc() -
reader.numDocs()),
- true,
- "deletedDocs",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullString(), () -> reader.toString()),
- true,
- "reader",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullString(), () ->
reader.directory().toString()),
- true,
- "readerDir",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.getVersion()),
- true,
- "indexVersion",
- Category.SEARCHER.toString(),
- scope);
+ SolrMetricsContext solrMetricsContext, Attributes attributes, String
scope) {
+ var baseAttributes =
+ attributes.toBuilder().put(CATEGORY_ATTR,
Category.SEARCHER.toString()).build();
+ // caching (boolean -> 0/1)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_caching_enabled",
+ "1 if caching enabled",
+ obs -> obs.record(cachingEnabled ? 1 : 0, baseAttributes));
+
+ // warmupTime (ms)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_warmup_time",
+ "Searcher warmup time (ms)",
+ obs -> obs.record(warmupTime, baseAttributes),
+ OtelUnit.MILLISECONDS);
+ // registeredAt (ms)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_registered_at",
+ "Searcher registered time (ms)",
+ obs -> obs.record(registerTime.getTime(), baseAttributes),
+ OtelUnit.MILLISECONDS);
+
+ // fullSortCount
+ solrMetricsContext.observableLongCounter(
+ "solr_searcher_full_sort",
+ "Number of queries that required building a full DocList with sorting",
+ obs -> obs.record(fullSortCount.sum(), baseAttributes));
+
+ // skipSortCount
+ solrMetricsContext.observableLongCounter(
+ "solr_searcher_skip_sort",
+ "Number of queries where Solr skipped building a full sorted DocList
and instead returned results directly from the DocSet",
+ obs -> obs.record(skipSortCount.sum(), baseAttributes));
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_live_docs_cache",
+ "LiveDocs cache metrics",
+ obs -> {
+ obs.record(
+ liveDocsInsertsCount.sum(),
+ baseAttributes.toBuilder().put(TYPE_ATTR, "inserts").build());
+ obs.record(
+ liveDocsHitCount.sum(),
baseAttributes.toBuilder().put(TYPE_ATTR, "hits").build());
+ obs.record(
+ liveDocsNaiveCacheHitCount.sum(),
+ baseAttributes.toBuilder().put(TYPE_ATTR, "naive_hits").build());
+ });
+ // reader stats (numeric)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_num_docs",
+ "Number of live docs",
+ obs -> {
+ try {
+ obs.record(reader.numDocs(), baseAttributes);
+ } catch (Exception ignore) {
+ // replacement for nullNumber
+ }
+ });
+
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_max_doc",
+ "Max doc (including deletions)",
+ obs -> {
+ try {
+ obs.record(reader.maxDoc(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
+
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_deleted_docs",
+ "Number of deleted docs",
+ obs -> {
+ try {
+ obs.record(reader.maxDoc() - reader.numDocs(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
+ // indexVersion (numeric)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_index_version",
+ "Lucene index version",
+ obs -> {
+ try {
+ obs.record(reader.getVersion(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
// size of the currently opened commit
- parentContext.gauge(
- () -> {
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_index_commit_size_bytes",
+ "Size of the current index commit (bytes)",
+ obs -> {
try {
- Collection<String> files = reader.getIndexCommit().getFileNames();
- long total = 0;
- for (String file : files) {
+ long total = 0L;
+ for (String file : reader.getIndexCommit().getFileNames()) {
total += DirectoryFactory.sizeOf(reader.directory(), file);
}
- return total;
+ obs.record(total, baseAttributes);
} catch (Exception e) {
- return parentContext.nullNumber();
+ // skip recording if unavailable (no nullNumber in OTel)
}
- },
- true,
- "indexCommitSize",
- Category.SEARCHER.toString(),
- scope);
+ });
+ var cacheBaseAttribute = Attributes.of(CATEGORY_ATTR,
Category.CACHE.toString());
// statsCache metrics
- parentContext.gauge(
- new MetricsMap(
- map -> {
- statsCache.getCacheMetrics().getSnapshot(map::putNoEx);
- map.put("statsCacheImpl", statsCache.getClass().getSimpleName());
- }),
- true,
- "statsCache",
- Category.CACHE.toString(),
- scope);
+ solrMetricsContext.observableLongGauge(
Review Comment:
Looks like these LongAdder values can reset to 0. Maybe worth noting that in
the description when these go to 0 or how.
##########
solr/core/src/java/org/apache/solr/search/SolrIndexSearcher.java:
##########
@@ -2589,95 +2602,145 @@ public SolrMetricsContext getSolrMetricsContext() {
return solrMetricsContext;
}
- // TODO SOLR-17458: Migrate to Otel
@Override
public void initializeMetrics(
- SolrMetricsContext parentContext, Attributes attributes, String scope) {
- parentContext.gauge(() -> name, true, "searcherName",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> cachingEnabled, true, "caching",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> openTime, true, "openedAt",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(() -> warmupTime, true, "warmupTime",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- () -> registerTime, true, "registeredAt",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- fullSortCount::sum, true, "fullSortCount",
Category.SEARCHER.toString(), scope);
- parentContext.gauge(
- skipSortCount::sum, true, "skipSortCount",
Category.SEARCHER.toString(), scope);
- final MetricsMap liveDocsCacheMetrics =
- new MetricsMap(
- (map) -> {
- map.put("inserts", liveDocsInsertsCount.sum());
- map.put("hits", liveDocsHitCount.sum());
- map.put("naiveHits", liveDocsNaiveCacheHitCount.sum());
- });
- parentContext.gauge(
- liveDocsCacheMetrics, true, "liveDocsCache",
Category.SEARCHER.toString(), scope);
- // reader stats
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.numDocs()),
- true,
- "numDocs",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.maxDoc()),
- true,
- "maxDoc",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.maxDoc() -
reader.numDocs()),
- true,
- "deletedDocs",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullString(), () -> reader.toString()),
- true,
- "reader",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullString(), () ->
reader.directory().toString()),
- true,
- "readerDir",
- Category.SEARCHER.toString(),
- scope);
- parentContext.gauge(
- rgauge(parentContext.nullNumber(), () -> reader.getVersion()),
- true,
- "indexVersion",
- Category.SEARCHER.toString(),
- scope);
+ SolrMetricsContext solrMetricsContext, Attributes attributes, String
scope) {
+ var baseAttributes =
+ attributes.toBuilder().put(CATEGORY_ATTR,
Category.SEARCHER.toString()).build();
+ // caching (boolean -> 0/1)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_caching_enabled",
+ "1 if caching enabled",
+ obs -> obs.record(cachingEnabled ? 1 : 0, baseAttributes));
+
+ // warmupTime (ms)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_warmup_time",
+ "Searcher warmup time (ms)",
+ obs -> obs.record(warmupTime, baseAttributes),
+ OtelUnit.MILLISECONDS);
+ // registeredAt (ms)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_registered_at",
+ "Searcher registered time (ms)",
+ obs -> obs.record(registerTime.getTime(), baseAttributes),
+ OtelUnit.MILLISECONDS);
+
+ // fullSortCount
+ solrMetricsContext.observableLongCounter(
+ "solr_searcher_full_sort",
+ "Number of queries that required building a full DocList with sorting",
+ obs -> obs.record(fullSortCount.sum(), baseAttributes));
+
+ // skipSortCount
+ solrMetricsContext.observableLongCounter(
+ "solr_searcher_skip_sort",
+ "Number of queries where Solr skipped building a full sorted DocList
and instead returned results directly from the DocSet",
+ obs -> obs.record(skipSortCount.sum(), baseAttributes));
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_live_docs_cache",
+ "LiveDocs cache metrics",
+ obs -> {
+ obs.record(
+ liveDocsInsertsCount.sum(),
+ baseAttributes.toBuilder().put(TYPE_ATTR, "inserts").build());
+ obs.record(
+ liveDocsHitCount.sum(),
baseAttributes.toBuilder().put(TYPE_ATTR, "hits").build());
+ obs.record(
+ liveDocsNaiveCacheHitCount.sum(),
+ baseAttributes.toBuilder().put(TYPE_ATTR, "naive_hits").build());
+ });
+ // reader stats (numeric)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_num_docs",
+ "Number of live docs",
+ obs -> {
+ try {
+ obs.record(reader.numDocs(), baseAttributes);
+ } catch (Exception ignore) {
+ // replacement for nullNumber
+ }
+ });
+
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_max_doc",
+ "Max doc (including deletions)",
+ obs -> {
+ try {
+ obs.record(reader.maxDoc(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
+
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_deleted_docs",
+ "Number of deleted docs",
+ obs -> {
+ try {
+ obs.record(reader.maxDoc() - reader.numDocs(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
+ // indexVersion (numeric)
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_index_version",
+ "Lucene index version",
+ obs -> {
+ try {
+ obs.record(reader.getVersion(), baseAttributes);
+ } catch (Exception ignore) {
+ }
+ });
// size of the currently opened commit
- parentContext.gauge(
- () -> {
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_index_commit_size_bytes",
+ "Size of the current index commit (bytes)",
+ obs -> {
try {
- Collection<String> files = reader.getIndexCommit().getFileNames();
- long total = 0;
- for (String file : files) {
+ long total = 0L;
+ for (String file : reader.getIndexCommit().getFileNames()) {
total += DirectoryFactory.sizeOf(reader.directory(), file);
}
- return total;
+ obs.record(total, baseAttributes);
} catch (Exception e) {
- return parentContext.nullNumber();
+ // skip recording if unavailable (no nullNumber in OTel)
}
- },
- true,
- "indexCommitSize",
- Category.SEARCHER.toString(),
- scope);
+ });
+ var cacheBaseAttribute = Attributes.of(CATEGORY_ATTR,
Category.CACHE.toString());
// statsCache metrics
- parentContext.gauge(
- new MetricsMap(
- map -> {
- statsCache.getCacheMetrics().getSnapshot(map::putNoEx);
- map.put("statsCacheImpl", statsCache.getClass().getSimpleName());
- }),
- true,
- "statsCache",
- Category.CACHE.toString(),
- scope);
+ solrMetricsContext.observableLongGauge(
+ "solr_searcher_stats_cache",
+ "Operation counts for the searcher stats cache, reported per operation
type",
+ obs -> {
+ var cacheMetrics = statsCache.getCacheMetrics();
+ obs.record(
+ cacheMetrics.lookups.sum(),
+ cacheBaseAttribute.toBuilder().put(TYPE_ATTR,
"lookups").build());
+ obs.record(
+ cacheMetrics.missingGlobalFieldStats.sum(),
+ cacheBaseAttribute.toBuilder().put(TYPE_ATTR,
"missing_global_field_stats").build());
Review Comment:
You can drop `_stats` suffix from this attribute name.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
