Sort span tags in alphabetical order #489
Conversation
Signed-off-by: Lev Popov <leo@nabam.net>
Codecov Report
@@ Coverage Diff @@
## master #489 +/- ##
==========================================
+ Coverage 92.71% 92.74% +0.02%
==========================================
Files 193 193
Lines 4655 4672 +17
Branches 1121 1126 +5
==========================================
+ Hits 4316 4333 +17
Misses 299 299
Partials 40 40
Continue to review full report at Codecov.
|
nabam
force-pushed
the
sort-tags
branch
3 times, most recently
from
098f54a
to
d31f2ec
Compare
Signed-off-by: Lev Popov <leo@nabam.net>
Signed-off-by: Lev Popov <leo@nabam.net>
|
I'm not very familiar with javascript, react and redux. Please let me know if I'm doing something bizarre. |
| @@ -66,6 +66,7 @@ export default deepFreeze( | |||
| gaID: null, | |||
| trackErrors: true, | |||
| }, | |||
| topTagPrefixes: ['http.'], | |||
There was a problem hiding this comment.
the priority sorting feels contrary to the intention of this PR. Is it really necessary?
There was a problem hiding this comment.
Sorting by itself makes it much easier to find relevant information in a trace compare to experience with tags in the random order. At least the tag one is trying to follow is at the same position in every span.
I was trying to find a way to access tags that that are more relevant than others faster. Issue #218 mentions that and in my installation I have a similar problem
Without priority sorting I would have to name tags the way they are alphabetically in order of importance to get most relevant ones in that view.
Though I bet there are more elegant solutions for that UX problem than priority sorting. I think it's quite a standard approach to have many tags some of which are used rarely for things like troubleshooting corner cases and others are crucial for most of the usage scenarios.
There was a problem hiding this comment.
I like the priority sorting as a config option, but I wouldn't add a default value.
There was a problem hiding this comment.
Thanks for the diff @nabam! I left some small change requests, but otherwise it looks good to me.
| @@ -32,6 +33,24 @@ function deduplicateTags(spanTags: Array<KeyValuePair>) { | |||
| return { tags, warnings }; | |||
| } | |||
|
|
|||
| export function orderTags(spanTags: Array<KeyValuePair>, topPrefixes: Array<string>) { | |||
| const orderedTags: Array<KeyValuePair> = [...spanTags]; | |||
| orderedTags.sort((a, b) => { | |||
There was a problem hiding this comment.
I think this should be case insensitive, so below this I would add:
const aKey = a.key.toLowerCase();
const bKey = b.key.toLowerCase();
and then use aKey and bKey in place of a.key and b.key
and above tree.walk on line 111 I would add:
const prefixes = getConfigValue('topTagPrefixes');
const topTagPrefixes = prefixes && prefixes.map(p => p.toLowerCase())`;
There was a problem hiding this comment.
I think that toLowerCase mapping can be done inside orderTags. It's a bit of performance loss but makes code more testable.
| @@ -66,6 +66,7 @@ export default deepFreeze( | |||
| gaID: null, | |||
| trackErrors: true, | |||
| }, | |||
| topTagPrefixes: ['http.'], | |||
There was a problem hiding this comment.
I like the priority sorting as a config option, but I wouldn't add a default value.
nabam
force-pushed
the
sort-tags
branch
2 times, most recently
from
fc4377b
to
a1ccb29
Compare
nabam
force-pushed
the
sort-tags
branch
6 times, most recently
from
eaf2e8e
to
c68a5ed
Compare
Signed-off-by: Lev Popov <leo@nabam.net>
There was a problem hiding this comment.
Thanks again @nabam. I will merge once automatic checks run and pass.
Sort span tags in alphabetical order Signed-off-by: vvvprabhakar <vvvprabhakar@gmail.com>
Which problem is this PR solving?
Resolves #218
Expanding a span on the UI shows collapsed list of tags which can be expanded again. When there are many tags it's hard to find the one a person is looking for
Short description of the changes
topTagPrefixes?: string[]introduced in UI configuration file. Tags with keys matching this prefixes will be displayed at the top preserving order of prefixes.