Loki: Renames metric 'loki_log_messages_total' to 'loki_internal_log_messages_total'

CHANGELOG.md

@@ -40,6 +40,7 @@
 * [6349](https://github.com/grafana/loki/pull/6349) **simonswine**: Update the default HTTP listen port from 80 to 3100. Make sure to configure the port explicitly if you are using port 80.
 * [6835](https://github.com/grafana/loki/pull/6835) **DylanGuedes**: Add new per-tenant query timeout configuration and remove engine query timeout.
 * [7212](https://github.com/grafana/loki/pull/7212) **Juneezee**: Replaces deprecated `io/ioutil` with `io` and `os`.
+* [7361](https://github.com/grafana/loki/pull/7361) **szczepad**: Renames metric `loki_log_messages_total` to `loki_internal_log_messages_total`
 
 #### Promtail
 

docs/sources/operations/observability.md

@@ -12,10 +12,11 @@ for more information.
 
 All components of Loki expose the following metrics:
 
-| Metric Name                     | Metric Type | Description                              |
-| ------------------------------- | ----------- | ---------------------------------------- |
-| `loki_log_messages_total`       | Counter     | Total number of messages logged by Loki. |
-| `loki_request_duration_seconds` | Histogram   | Number of received HTTP requests.        |
+| Metric Name                        | Metric Type | Description                                                                                                                  |
+| ---------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `loki_log_messages_total`          | Counter     | DEPRECATED. Use internal_log_messages_total for the same functionality. Total number of log messages created by loki itself. |
+| `loki_internal_log_messages_total` | Counter     | Total number of log messages created by loki itself.                                                                         |
+| `loki_request_duration_seconds`    | Histogram   | Number of received HTTP requests.                                                                                            |
 
 The Loki Distributors expose the following metrics:
 

docs/sources/upgrading/_index.md

@@ -98,6 +98,10 @@ The global `deletion_mode` option in the compactor configuration moved to runtim
 - The `deletion_mode` global override needs to be set to the desired mode: `disabled`, `filter-only`, or `filter-and-delete`. By default, `filter-and-delete` is enabled.
 - Any `allow_delete` per-tenant overrides need to be removed or changed to `deletion_mode` overrides with the desired mode.
 
+#### Metric name for `loki_log_messages_total` changed 
+
+The name of this metric was changed to `loki_internal_log_messages_total` to reduce ambiguity. The previous name is still present but is deprecated.
+
 ### Promtail
 
 #### `gcp_push_target_parsing_errors_total` has a new `reason` label

pkg/util/log/log.go

@@ -39,9 +39,10 @@ func InitLogger(cfg *server.Config, reg prometheus.Registerer, buffered bool, sy
 
 // prometheusLogger exposes Prometheus counters for each of go-kit's log levels.
 type prometheusLogger struct {
-	logger      log.Logger
-	logMessages *prometheus.CounterVec
-	logFlushes  prometheus.Histogram
+	logger              log.Logger
+	logMessages         *prometheus.CounterVec
+	internalLogMessages *prometheus.CounterVec
+	logFlushes          prometheus.Histogram
 
 	useBufferedLogger bool
 	useSyncLogger     bool
@@ -61,7 +62,12 @@ func newPrometheusLogger(l logging.Level, format logging.Format, reg prometheus.
 	logMessages := promauto.With(reg).NewCounterVec(prometheus.CounterOpts{
 		Namespace: "loki",
 		Name:      "log_messages_total",
-		Help:      "Total number of log messages.",
+		Help:      "DEPRECATED. Use internal_log_messages_total for the same functionality. Total number of log messages created by Loki itself.",
+	}, []string{"level"})
+	internalLogMessages := promauto.With(reg).NewCounterVec(prometheus.CounterOpts{
+		Namespace: "loki",
+		Name:      "internal_log_messages_total",
+		Help:      "Total number of log messages created by Loki itself.",
 	}, []string{"level"})
 	logFlushes := promauto.With(reg).NewHistogram(prometheus.HistogramOpts{
 		Namespace: "loki",
@@ -96,9 +102,10 @@ func newPrometheusLogger(l logging.Level, format logging.Format, reg prometheus.
 	logger = level.NewFilter(logger, levelFilter(l.String()))
 
 	plogger := &prometheusLogger{
-		logger:      logger,
-		logMessages: logMessages,
-		logFlushes:  logFlushes,
+		logger:              logger,
+		logMessages:         logMessages,
+		internalLogMessages: internalLogMessages,
+		logFlushes:          logFlushes,
 	}
 	// Initialise counters for all supported levels:
 	supportedLevels := []level.Value{
@@ -109,6 +116,7 @@ func newPrometheusLogger(l logging.Level, format logging.Format, reg prometheus.
 	}
 	for _, level := range supportedLevels {
 		plogger.logMessages.WithLabelValues(level.String())
+		plogger.internalLogMessages.WithLabelValues(level.String())
 	}
 
 	// return a Logger without caller information, shouldn't use directly
@@ -126,6 +134,7 @@ func (pl *prometheusLogger) Log(kv ...interface{}) error {
 		}
 	}
 	pl.logMessages.WithLabelValues(l).Inc()
+	pl.internalLogMessages.WithLabelValues(l).Inc()
 	return nil
 }