Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Metric definitions in receiver_metrics.md are insufficient and unclear

Open
#258 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with pages/components/otel_collector/receiver_metrics.md and review the listed metrics and their current descriptions. Research the relevant BIG-IP internal counters and tmsh show equivalents, then document what each metric measures and its capacity, troubleshooting, performance, or security use cases. Done means all listed metrics have clear, operationally meaningful definitions.

Written by the indexing model from the issue text.

Description

Describe the bug

The metric descriptions provided in the following documentation are insufficient for understanding what the metrics actually represent:

https://github.com/f5devcentral/application-study-tool/blob/v0.9.6/pages/components/otel_collector/receiver_metrics.md

Most descriptions simply restate the metric name in sentence form and do not explain:
What is being measured,

To Reproduce
Steps to reproduce the behavior:

Locate the following metrics:

f5_virtual_server_clientside_connection_slow_killed_total
f5_virtual_server_ephemeral_connection_total
f5_profile_tcp_accepts_total
f5_profile_tcp_connections_total
f5_profile_tcp_tx_rexmits_total
f5.pool.queue_age.average
f5.pool.queue_age.recent_max
f5.profile.fastl4.rx_badsums
f5.profile.fastl4.rx_badpkts
f5.profile.fastl4.rx_unreachs

Read the provided descriptions.

Expected behavior
Each metric should have a clear and operationally meaningful explanation, including:

Typical use cases (capacity, troubleshooting, performance, security)
Any relevant BIG-IP internal counters or tmsh show equivalents

Dominant language
Python
Stars
106
Forks
44
PR merge metrics
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from f5devcentral/application-study-tool

All issues in f5devcentral/application-study-tool

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.