[V2]Add Script for metrics markdown table #5941
Conversation
Signed-off-by: vvs-personalstash <viralkverma0987@gmail.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5941 +/- ##
==========================================
+ Coverage 91.04% 96.48% +5.43%
==========================================
Files 345 352 +7
Lines 18062 19973 +1911
==========================================
+ Hits 16445 19270 +2825
+ Misses 1430 520 -910
+ Partials 187 183 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
In terminal, run |
scripts/metrics-md.py
Outdated
| @@ -0,0 +1,101 @@ | |||
| import json | |||
There was a problem hiding this comment.
- move this into script/utils
- please document how to use that
- include generated MD file(s) - you can put then under cmd/jaeger/docs/migration
Signed-off-by: vvs-personalstash <viralkverma0987@gmail.com>
|
|
||
| | Metric Name | Inner Parameters | | ||
| |-------------|------------------| | ||
| | go_gc_duration_seconds | | |
There was a problem hiding this comment.
@Wise-Wizard we should investigate how these standard Go metrics are being generated in v1 and decide how we can enable them in v2.
There was a problem hiding this comment.
this is what we might want: https://github.com/open-telemetry/opentelemetry-go-contrib/blob/main/instrumentation/runtime/runtime.go
ideally Collector would expose those automatically, but it's not implemented currently -- open-telemetry/opentelemetry-collector#2155
| @@ -0,0 +1,92 @@ | |||
| ### Common Metrics | |||
|
|
|||
| | Metric Name | Inner Parameters | | |||
There was a problem hiding this comment.
Inner Parameters
The official term in Prometheus is Labels
scripts/utils/metrics-md.py
Outdated
| print('Dict successfully converted to md') | ||
|
|
||
| # Usage | ||
| fn = '' #Enter the path of the JSON file generated by compare_metrics.py |
There was a problem hiding this comment.
- let's move compare_metrics.py to utils too.
- could we just add the logic here to compare_metrics.py ? Maybe as an optional parameter
--out=json|md
There was a problem hiding this comment.
- I still don't see instructions how to run these things - the compare_metrics.py seems to hardcode the input file names like
./V1_Metrics.json-- please document how those JSON files should be produced.
There was a problem hiding this comment.
ok should i create a separate documentation md file for this in scripts/utils or should i just add the instruction as comments
There was a problem hiding this comment.
in comments is fine, this isn't something we'd use often
| | processor_batch_timeout_trigger_send | processor, service_instance_id, service_name, service_version | | ||
| | receiver_accepted_spans | receiver, service_instance_id, service_name, service_version, transport | | ||
| | receiver_refused_spans | receiver, service_instance_id, service_name, service_version, transport | | ||
| | target_info | service_instance_id, service_name, service_version | |
There was a problem hiding this comment.
arguably this is equivalent to jaeger_build_info
|
|
||
| | Metric Name | Inner Parameters | | ||
| |-------------|------------------| | ||
| | jaeger_badger_compaction_current_num_lsm | | |
There was a problem hiding this comment.
the storage-specific files will have large overlap with all-in-one, I recommend filtering out only the storage-related metrics.
| @@ -0,0 +1,92 @@ | |||
| ### Common Metrics | |||
There was a problem hiding this comment.
could we just have a single table with a format similar to ### Equivalent Metrics? When one side is missing, put n/a
yurishkuro
added
the
changelog:exprimental
Signed-off-by: vvs-personalstash <viralkverma0987@gmail.com>
vvs-personalstash
force-pushed
the
metrics-markdown
branch
from
e2545d4
to
02f40db
Compare
|
@yurishkuro I have made changes as per your reviews,kindly review if there are any changes or errors i may have not noticed |
Description of the changes
Checklist
jaeger:make lint testjaeger-ui:yarn lintandyarn test