microsoft / microsoft/retina

Documentation and Code for adv_tcpretrans_count doesn't align

Open
#1,999 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
3.2k
Forks
304
Avg merge
1d 19h
Merged PRs (30d)
78

Description

**Describe the bug**
Based on the documentation available most of not all MetricNames can be used in the MetricsConfiguration CRD. There is at least one metric that doesn't align with this and that is 'adv_tcpretrans_count' where 'tcp_retransmission_count' instead should be used.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to 'https://retina.sh/docs/Concepts/CRDs/MetricsConfiguration'
2. Go to 'https://retina.sh/docs/Metrics/modes/advanced'
3. See the correlation between the metric names
4. Use the 'tcpretrans_count' and see that the crd gets state 'Errorred'

**Expected behavior**
It should be clear documentation on what metric name should be used

**Screenshots**
n/a

**Platform:**

- OS: Ubuntu
- Kubernetes Version: 1.21, 1.28, 1.3x
- Host: k3s self-hosted
- Retina Version:

**Additional context**
Add any other context about the problem here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.