dsmiley commented on code in PR #3682:
URL: https://github.com/apache/solr/pull/3682#discussion_r2402052779
##########
solr/solr-ref-guide/modules/deployment-guide/pages/metrics-reporting.adoc:
##########
@@ -684,18 +684,18 @@ The following merge metrics are collected:
* 'solr_indexwriter_merge_time_milliseconds' - timer for total duration of
merge operations
The following metrics, in addition to the above labels for "minor"/"major"
`merge_type` also have a label for `merge_state`.
-This label can have a value of either "started" or "finished" indicating when
the value was reported ("started" when a merge
-is being prepared and "finished" when a merge is concluded).
+This label can have a value of "started", "finished", or "failed" indicating
when the value was reported ("started" when a merge
+is being prepared, "finished" when a merge is successfully concluded,
otherwise "failed").
Review Comment:
I think we would use the word "finished" to mean, finish _either_ success or
failure. Thus to determine successes only, subtract failures from finished.
If we want to count successes as you document we do, then I think this label
value should be "succeeded" so that it's clear it's only success. That's fine
too; either works. I like the better clarity in the latter.
##########
solr/solr-ref-guide/modules/deployment-guide/pages/metrics-reporting.adoc:
##########
@@ -684,18 +684,18 @@ The following merge metrics are collected:
* 'solr_indexwriter_merge_time_milliseconds' - timer for total duration of
merge operations
The following metrics, in addition to the above labels for "minor"/"major"
`merge_type` also have a label for `merge_state`.
-This label can have a value of either "started" or "finished" indicating when
the value was reported ("started" when a merge
-is being prepared and "finished" when a merge is concluded).
+This label can have a value of "started", "finished", or "failed" indicating
when the value was reported ("started" when a merge
+is being prepared, "finished" when a merge is successfully concluded,
otherwise "failed").
These metrics are monotonically increasing, and so the values for specific
merge operations can be calculated by taking
the diff of the values between times or between `started` / `finished` types.
-* 'solr_indexwriter_docs_merged' - counter for total number of documents
included in the merge (this excludes deleted docs)
-* 'solr_solr_indexwriter_docs_deleted' - counter for total number of documents
deleted by the merge
-* 'solr_indexwriter_segments' - counter for total number of segments merged
+* 'solr_indexwriter_merges' - counter for total number of merge operations
+* 'solr_indexwriter_merge_docs' - counter for total number of documents
included in the merge
+ * This metric further has a label specific to it called `merge_op`, which
can be "merge" (for documents merged) or "delete" (for documents deleted)
+* 'solr_indexwriter_merge_segments' - counter for total number of segments
merged
Review Comment:
Now that we are standardizing on Prometheus (yay!), no longer having Solr's
bespoke API that lacked descriptions, I think we should reconsider the
documentation **burden** of this file. Documentation has a cost and we are now
double-paying. I think this ref guide file should be extremely light,
describing in broad strokes what's available. I don't think it should document
any specific metric... or at least do very sparingly / deliberately.
Discussion of label values could go into descriptions.
CC @mlbiscoc
--
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]
