Skip to content

Commit

Permalink
Fix Prometheus metrics doc (#6514)
Browse files Browse the repository at this point in the history
Additionally, make validate-metrics-doc.sh output the diff if there is.

Signed-off-by: Quan Tian <quan.tian@broadcom.com>
  • Loading branch information
tnqn committed Jul 9, 2024
1 parent 60b22a4 commit efa4dfe
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion ci/kind/validate-metrics-doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ METRICS_DOC="$THIS_DIR/../../docs/prometheus-integration.md"
cp -v $METRICS_DOC $METRICS_TMP_DOC
$MAKE_CMD $METRICS_TMP_DOC
result=0
cmp -s $METRICS_DOC $METRICS_TMP_DOC || result=$?
diff $METRICS_DOC $METRICS_TMP_DOC || result=$?
if [ $result -ne 0 ]; then
echo "Error: Prometheus metrics document should be updated"
echo "You can update it by building the Antrea Docker image locally (with 'make'), running ./hack/make-metrics-doc.sh and committing the changes"
Expand Down
3 changes: 3 additions & 0 deletions docs/prometheus-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,9 @@ to a non-default GODEBUG=multipartmaxparts=... setting.
- **go_godebug_non_default_behavior_multipathtcp_events_total:** The number
of non-default behaviors executed by the net package due to a non-default
GODEBUG=multipathtcp=... setting.
- **go_godebug_non_default_behavior_netedns0_events_total:** The number
of non-default behaviors executed by the net package due to a non-default
GODEBUG=netedns0=... setting.
- **go_godebug_non_default_behavior_panicnil_events_total:** The number of
non-default behaviors executed by the runtime package due to a non-default
GODEBUG=panicnil=... setting.
Expand Down

0 comments on commit efa4dfe

Please sign in to comment.