Merge branch 'main' into docs/service-troubleshooting-tool

.github/CONTRIBUTING.md

@@ -162,8 +162,7 @@ When you're ready to submit a pull request:
    | --- | --- |
    | `pr/no-changelog` | This PR does not have an intended changelog entry |
    | `pr/no-metrics-test` | This PR does not require any testing for metrics |
-   | `backport/stable-website` | This PR contains documentation changes that are ready to be deployed immediately. Changes will also automatically get backported to the latest release branch |
-   | `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page to view active releases. |
+   | `backport/1.12.x` | Backport the changes in this PR to the targeted release branch. Consult the [Consul Release Notes](https://www.consul.io/docs/release-notes) page to view active releases. Website documentation merged to the latest release branch is deployed immediately |
    Other labels may automatically be added by the Github Action CI.
 7. After you submit, the Consul maintainers team needs time to carefully review your
    contribution and ensure it is production-ready, considering factors such as: security,

.github/workflows/backport-assistant.yml

@@ -18,33 +18,6 @@ jobs:
     runs-on: ubuntu-latest
     container: hashicorpdev/backport-assistant:0.3.0
     steps:
-      - name: Run Backport Assistant for stable-website
-        run: |
-          backport-assistant backport -merge-method=squash -gh-automerge
-        env:
-          BACKPORT_LABEL_REGEXP: "type/docs-(?P<target>cherrypick)"
-          BACKPORT_TARGET_TEMPLATE: "stable-website"
-          BACKPORT_MERGE_COMMIT: true
-          GITHUB_TOKEN: ${{ secrets.ELEVATED_GITHUB_TOKEN }}
-      - name: Backport changes to latest release branch
-        run: |
-          # Use standard token here 
-          resp=$(curl -f -s -H 'authorization: Bearer ${{ secrets.GITHUB_TOKEN }}' "https://api.github.com/repos/$GITHUB_REPOSITORY/labels?per_page=100")
-          ret="$?"
-          if [[ "$ret" -ne 0 ]]; then
-              echo "The GitHub API returned $ret"
-              exit $ret
-          fi
-          # get the latest backport label excluding any website labels, ex: `backport/0.3.x` and not `backport/website`
-          latest_backport_label=$(echo "$resp" | jq -r '.[] | select(.name | (startswith("backport/") and (contains("website") | not))) | .name' | sort -rV | head -n1)
-          echo "Latest backport label: $latest_backport_label"
-          # set BACKPORT_TARGET_TEMPLATE for backport-assistant
-          # trims backport/ from the beginning with parameter substitution
-          export BACKPORT_TARGET_TEMPLATE="release/${latest_backport_label#backport/}.x"
-          backport-assistant backport -merge-method=squash -gh-automerge
-        env:
-          BACKPORT_LABEL_REGEXP: "type/docs-(?P<target>cherrypick)"
-          GITHUB_TOKEN: ${{ secrets.ELEVATED_GITHUB_TOKEN }}
       - name: Run Backport Assistant for release branches
         run: |
           backport-assistant backport -merge-method=squash -gh-automerge

agent/consul/server_log_verification.go

@@ -62,12 +62,12 @@ func makeLogVerifyReportFn(logger hclog.Logger) verifier.ReportFn {
 			if r.WrittenSum > 0 && r.WrittenSum != r.ExpectedSum {
 				// The failure occurred before the follower wrote to the log so it
 				// must be corrupted in flight from the leader!
-				l2.Info("verification checksum FAILED: in-flight corruption",
+				l2.Error("verification checksum FAILED: in-flight corruption",
 					"followerWriteChecksum", fmt.Sprintf("%08x", r.WrittenSum),
 					"readChecksum", fmt.Sprintf("%08x", r.ReadSum),
 				)
 			} else {
-				l2.Info("verification checksum FAILED: storage corruption",
+				l2.Error("verification checksum FAILED: storage corruption",
 					"followerWriteChecksum", fmt.Sprintf("%08x", r.WrittenSum),
 					"readChecksum", fmt.Sprintf("%08x", r.ReadSum),
 				)

agent/metrics_test.go

@@ -432,3 +432,193 @@ func TestHTTPHandlers_AgentMetrics_CACertExpiry_Prometheus(t *testing.T) {
 	})
 
 }
+
+func TestHTTPHandlers_AgentMetrics_WAL_Prometheus(t *testing.T) {
+	skipIfShortTesting(t)
+	// This test cannot use t.Parallel() since we modify global state, ie the global metrics instance
+
+	t.Run("client agent emits nothing", func(t *testing.T) {
+		hcl := `
+		server = false
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_4"
+		}
+		raft_logstore {
+			backend = "wal"
+		}
+		bootstrap = false
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		require.NotContains(t, respRec.Body.String(), "agent_4_raft_wal")
+	})
+
+	t.Run("server with WAL enabled emits WAL metrics", func(t *testing.T) {
+		hcl := `
+		server = true
+		bootstrap = true
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_5"
+		}
+		connect {
+			enabled = true
+		}
+		raft_logstore {
+			backend = "wal"
+		}
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+		testrpc.WaitForLeader(t, a.RPC, "dc1")
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		out := respRec.Body.String()
+		require.Contains(t, out, "agent_5_raft_wal_head_truncations")
+		require.Contains(t, out, "agent_5_raft_wal_last_segment_age_seconds")
+		require.Contains(t, out, "agent_5_raft_wal_log_appends")
+		require.Contains(t, out, "agent_5_raft_wal_log_entries_read")
+		require.Contains(t, out, "agent_5_raft_wal_log_entries_written")
+		require.Contains(t, out, "agent_5_raft_wal_log_entry_bytes_read")
+		require.Contains(t, out, "agent_5_raft_wal_log_entry_bytes_written")
+		require.Contains(t, out, "agent_5_raft_wal_segment_rotations")
+		require.Contains(t, out, "agent_5_raft_wal_stable_gets")
+		require.Contains(t, out, "agent_5_raft_wal_stable_sets")
+		require.Contains(t, out, "agent_5_raft_wal_tail_truncations")
+	})
+
+	t.Run("server without WAL enabled emits no WAL metrics", func(t *testing.T) {
+		hcl := `
+		server = true
+		bootstrap = true
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_6"
+		}
+		connect {
+			enabled = true
+		}
+		raft_logstore {
+			backend = "boltdb"
+		}
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+		testrpc.WaitForLeader(t, a.RPC, "dc1")
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		require.NotContains(t, respRec.Body.String(), "agent_6_raft_wal")
+	})
+
+}
+
+func TestHTTPHandlers_AgentMetrics_LogVerifier_Prometheus(t *testing.T) {
+	skipIfShortTesting(t)
+	// This test cannot use t.Parallel() since we modify global state, ie the global metrics instance
+
+	t.Run("client agent emits nothing", func(t *testing.T) {
+		hcl := `
+		server = false
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_4"
+		}
+		raft_logstore {
+			verification {
+				enabled = true
+				interval = "1s"
+			}
+		}
+		bootstrap = false
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		require.NotContains(t, respRec.Body.String(), "agent_4_raft_logstore_verifier")
+	})
+
+	t.Run("server with verifier enabled emits all metrics", func(t *testing.T) {
+		hcl := `
+		server = true
+		bootstrap = true
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_5"
+		}
+		connect {
+			enabled = true
+		}
+		raft_logstore {
+			verification {
+				enabled = true
+				interval = "1s"
+			}
+		}
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+		testrpc.WaitForLeader(t, a.RPC, "dc1")
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		out := respRec.Body.String()
+		require.Contains(t, out, "agent_5_raft_logstore_verifier_checkpoints_written")
+		require.Contains(t, out, "agent_5_raft_logstore_verifier_dropped_reports")
+		require.Contains(t, out, "agent_5_raft_logstore_verifier_ranges_verified")
+		require.Contains(t, out, "agent_5_raft_logstore_verifier_read_checksum_failures")
+		require.Contains(t, out, "agent_5_raft_logstore_verifier_write_checksum_failures")
+	})
+
+	t.Run("server with verifier disabled emits no extra metrics", func(t *testing.T) {
+		hcl := `
+		server = true
+		bootstrap = true
+		telemetry = {
+			prometheus_retention_time = "5s",
+			disable_hostname = true
+			metrics_prefix = "agent_6"
+		}
+		connect {
+			enabled = true
+		}
+		raft_logstore {
+			verification {
+				enabled = false
+			}
+		}
+		`
+
+		a := StartTestAgent(t, TestAgent{HCL: hcl})
+		defer a.Shutdown()
+		testrpc.WaitForLeader(t, a.RPC, "dc1")
+
+		respRec := httptest.NewRecorder()
+		recordPromMetrics(t, a, respRec)
+
+		require.NotContains(t, respRec.Body.String(), "agent_6_raft_logstore_verifier")
+	})
+
+}