Name log fields, metrics and the Core Rule Set package for what they are (closes #192)

Log field, metric, action and event names now say what they count
and, for timings, the unit. Package internal/waf is internal/coreruleset.

Model: opus-5-5

internal/metrics/metrics.go

@@ -28,15 +28,15 @@ type Metrics struct {
 	registry prometheus.Registerer
 	handler  http.Handler
 
-	inFlight         prometheus.Gauge
-	requests         *prometheus.CounterVec
-	requestBytes     *prometheus.CounterVec
-	responseBytes    *prometheus.CounterVec
-	requestDuration  prometheus.Histogram
-	upstreamDuration prometheus.Histogram
-	rateLimitHits    *prometheus.CounterVec
-	offences         *prometheus.CounterVec
-	wafMatches       *prometheus.CounterVec
+	inFlight           prometheus.Gauge
+	requests           *prometheus.CounterVec
+	requestBytes       *prometheus.CounterVec
+	responseBytes      *prometheus.CounterVec
+	requestDuration    prometheus.Histogram
+	upstreamDuration   prometheus.Histogram
+	rateLimitHits      *prometheus.CounterVec
+	offences           *prometheus.CounterVec
+	coreRuleSetMatches *prometheus.CounterVec
 	// ruleMatches are made by AddRules, and reputationHits by
 	// AddReputation.
 	ruleMatches    *prometheus.CounterVec
@@ -45,12 +45,12 @@ type Metrics struct {
 	asns           *busiest
 
 	// GeoJSRequests are the requests to GeoJS, and GeoJSFailures those
-	// that failed. GeoJSUnanswered are the requests that needed their
-	// client's answer, for a setting that acts on it, and went on without
-	// it because GeoJS had not given it in time.
-	GeoJSRequests   prometheus.Counter
-	GeoJSFailures   prometheus.Counter
-	GeoJSUnanswered prometheus.Counter
+	// that failed. RequestsWithoutGeoJSAnswer are the requests that needed
+	// their client's answer, for a setting that acts on it, and went on
+	// without it because GeoJS had not given it in time.
+	GeoJSRequests              prometheus.Counter
+	GeoJSFailures              prometheus.Counter
+	RequestsWithoutGeoJSAnswer prometheus.Counter
 
 	stateFileWrites        *prometheus.CounterVec
 	stateFileWriteFailures *prometheus.CounterVec
@@ -101,7 +101,7 @@ func New(topN int, instanceName string) *Metrics {
 			[]string{"window", "kind"}),
 		offences: counterVec("sww_offences_total",
 			"Offences, by kind.", []string{"kind"}),
-		wafMatches: counterVec("sww_waf_matches_total",
+		coreRuleSetMatches: counterVec("sww_core_rule_set_matches_total",
 			"Requests that matched a rule of the Core Rule Set, by SWW_WAF_MODE "+
 				"and the rule's id.", []string{"mode", "rule_id"}),
 		countries: newCountries(topN),
@@ -114,8 +114,8 @@ func New(topN int, instanceName string) *Metrics {
 			Name: "sww_geojs_failures_total",
 			Help: "Requests to GeoJS that failed.",
 		}),
-		GeoJSUnanswered: prometheus.NewCounter(prometheus.CounterOpts{
-			Name: "sww_geojs_unanswered_total",
+		RequestsWithoutGeoJSAnswer: prometheus.NewCounter(prometheus.CounterOpts{
+			Name: "sww_requests_without_geojs_answer_total",
 			Help: "Requests that needed their client's answer from GeoJS and " +
 				"went on without it, because GeoJS had not given it in time.",
 		}),
@@ -139,9 +139,9 @@ func New(topN int, instanceName string) *Metrics {
 		collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}),
 		m.inFlight, m.requests, m.requestBytes, m.responseBytes,
 		m.requestDuration, m.upstreamDuration,
-		m.rateLimitHits, m.offences, m.wafMatches,
+		m.rateLimitHits, m.offences, m.coreRuleSetMatches,
 		m.countries, m.asns,
-		m.GeoJSRequests, m.GeoJSFailures, m.GeoJSUnanswered,
+		m.GeoJSRequests, m.GeoJSFailures, m.RequestsWithoutGeoJSAnswer,
 		m.stateFileWrites, m.stateFileWriteFailures,
 		m.stateFileLastWrite, m.stateFileSize,
 		m.stateFileEditsTakenIn, m.stateFileEditsSetAside,
@@ -232,7 +232,7 @@ func (m *Metrics) AddRemoteLog(remote *remotelog.Sender) {
 			return float64(remote.Dropped())
 		}),
 		prometheus.NewGaugeFunc(prometheus.GaugeOpts{
-			Name: "sww_remote_log_buffer_depth",
+			Name: "sww_remote_log_lines_waiting",
 			Help: "Log lines in the buffer, waiting to be sent.",
 		}, func() float64 {
 			return float64(remote.Depth())
@@ -355,7 +355,7 @@ func (m *Metrics) AddAlerts(queue *alerts.Queue) {
 				return float64(queue.Counts(name).Sent)
 			}),
 			prometheus.NewCounterFunc(prometheus.CounterOpts{
-				Name:        "sww_alerts_failed_total",
+				Name:        "sww_alert_send_failures_total",
 				Help:        "Requests to the destination that failed.",
 				ConstLabels: destination,
 			}, func() float64 {
@@ -424,10 +424,10 @@ func (m *Metrics) LimitHit(hit ratelimit.Hit) {
 // them.
 func (m *Metrics) Offences(r ratelimit.Request) {
 	for kind, committed := range map[string]bool{
-		"limit":                 r.BrokeLimit,
-		"attack":                r.Attack,
-		"blocked_by_block_rule": r.BlockedByBlockRule,
-		"waf_blocked":           r.WAFBlocked,
+		"limit":                    r.BrokeLimit,
+		"attack":                   r.Attack,
+		"blocked_by_block_rule":    r.BlockedByBlockRule,
+		"blocked_by_core_rule_set": r.BlockedByCoreRuleSet,
 	} {
 		if committed {
 			m.offences.WithLabelValues(kind).Inc()
@@ -441,10 +441,10 @@ func (m *Metrics) RuleMatched(id, action string) {
 	m.ruleMatches.WithLabelValues(id, action).Inc()
 }
 
-// WAFMatched counts a request that matched the Core Rule Set's rule id,
+// CoreRuleSetMatched counts a request that matched the Core Rule Set's rule id,
 // with SWW_WAF_MODE at mode.
-func (m *Metrics) WAFMatched(mode string, id int) {
-	m.wafMatches.WithLabelValues(mode, strconv.Itoa(id)).Inc()
+func (m *Metrics) CoreRuleSetMatched(mode string, id int) {
+	m.coreRuleSetMatches.WithLabelValues(mode, strconv.Itoa(id)).Inc()
 }
 
 // StateFileWritten counts a write of the state file name, of size bytes,