Sort span tags in alphabetical order #489

nabam · 2019-11-28T11:22:49Z

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

Trace span tags are getting sorted after deduplication in reducer
New option topTagPrefixes?: string[] introduced in UI configuration file. Tags with keys matching this prefixes will be displayed at the top preserving order of prefixes.

Signed-off-by: Lev Popov <[email protected]>

codecov · 2019-11-28T12:28:47Z

Codecov Report

Merging #489 into master will increase coverage by 0.02%.
The diff coverage is 94.73%.

@@            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

Impacted Files	Coverage Δ
...kages/jaeger-ui/src/model/transform-trace-data.tsx	`88.09% <94.73%> (+3.02%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 36ab156...129d8ac. Read the comment docs.

Signed-off-by: Lev Popov <[email protected]>

nabam · 2019-11-28T15:25:45Z

I'm not very familiar with javascript, react and redux. Please let me know if I'm doing something bizarre.

yurishkuro · 2019-12-01T23:45:05Z

packages/jaeger-ui/src/constants/default-config.tsx

@@ -66,6 +66,7 @@ export default deepFreeze(
        gaID: null,
        trackErrors: true,
      },
+      topTagPrefixes: ['http.'],


the priority sorting feels contrary to the intention of this PR. Is it really necessary?

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.

I like the priority sorting as a config option, but I wouldn't add a default value.

everett980

Thanks for the diff @nabam! I left some small change requests, but otherwise it looks good to me.

packages/jaeger-ui/src/model/transform-trace-data.tsx

everett980 · 2019-12-04T23:08:29Z

packages/jaeger-ui/src/model/transform-trace-data.tsx

@@ -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) => {


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())`;

I think that toLowerCase mapping can be done inside orderTags. It's a bit of performance loss but makes code more testable.

everett980 · 2019-12-04T23:11:08Z

packages/jaeger-ui/src/constants/default-config.tsx

@@ -66,6 +66,7 @@ export default deepFreeze(
        gaID: null,
        trackErrors: true,
      },
+      topTagPrefixes: ['http.'],


I like the priority sorting as a config option, but I wouldn't add a default value.

packages/jaeger-ui/src/model/transform-trace-data.tsx

packages/jaeger-ui/src/model/transform-trace-data.test.js

packages/jaeger-ui/src/model/transform-trace-data.tsx

Signed-off-by: Lev Popov <[email protected]>

everett980

Thanks again @nabam. I will merge once automatic checks run and pass.

Sort span tags in alphabetical order Signed-off-by: vvvprabhakar <[email protected]>

nabam force-pushed the sort-tags branch from 480f3c6 to 179f449 Compare November 28, 2019 11:29

stromkalle approved these changes Nov 28, 2019

View reviewed changes

sort span tags in alphabetical order

85a1a97

Signed-off-by: Lev Popov <[email protected]>

nabam force-pushed the sort-tags branch from 179f449 to 85a1a97 Compare November 28, 2019 12:17

nabam force-pushed the sort-tags branch 3 times, most recently from 098f54a to d31f2ec Compare November 28, 2019 14:29

ability to configure top tag keys for sorting

ca5884d

Signed-off-by: Lev Popov <[email protected]>

nabam force-pushed the sort-tags branch from d31f2ec to 6fff972 Compare November 28, 2019 14:56

test tags deduplication

23af4a8

Signed-off-by: Lev Popov <[email protected]>

nabam force-pushed the sort-tags branch from 6fff972 to 23af4a8 Compare November 28, 2019 15:06

yurishkuro reviewed Dec 1, 2019

View reviewed changes

yurishkuro requested a review from everett980 December 1, 2019 23:51

everett980 requested changes Dec 4, 2019

View reviewed changes

nabam force-pushed the sort-tags branch 2 times, most recently from fc4377b to a1ccb29 Compare December 5, 2019 10:01

nabam requested a review from everett980 December 5, 2019 10:02

nabam force-pushed the sort-tags branch 6 times, most recently from eaf2e8e to c68a5ed Compare December 5, 2019 12:36

reflect PR feedback

2eb7676

Signed-off-by: Lev Popov <[email protected]>

nabam force-pushed the sort-tags branch from c68a5ed to 2eb7676 Compare December 5, 2019 13:25

nabam requested a review from yurishkuro December 9, 2019 23:11

Merge branch 'master' into sort-tags

129d8ac

everett980 approved these changes Dec 10, 2019

View reviewed changes

everett980 merged commit 1ee0cf1 into jaegertracing:master Dec 10, 2019

nabam deleted the sort-tags branch May 4, 2020 09:16

vvvprabhakar pushed a commit to vvvprabhakar/jaeger-ui that referenced this pull request Jul 5, 2021

Merge pull request jaegertracing#489 from nabam/sort-tags

ee018de

Sort span tags in alphabetical order Signed-off-by: vvvprabhakar <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort span tags in alphabetical order #489

Sort span tags in alphabetical order #489

nabam commented Nov 28, 2019 •

edited

Loading

codecov bot commented Nov 28, 2019 •

edited

Loading

nabam commented Nov 28, 2019

yurishkuro Dec 1, 2019

nabam Dec 2, 2019 •

edited

Loading

everett980 Dec 4, 2019

everett980 left a comment •

edited

Loading

everett980 Dec 4, 2019

nabam Dec 5, 2019

everett980 Dec 4, 2019

everett980 left a comment

Sort span tags in alphabetical order #489

Sort span tags in alphabetical order #489

Conversation

nabam commented Nov 28, 2019 • edited Loading

Which problem is this PR solving?

Short description of the changes

codecov bot commented Nov 28, 2019 • edited Loading

Codecov Report

nabam commented Nov 28, 2019

yurishkuro Dec 1, 2019

Choose a reason for hiding this comment

nabam Dec 2, 2019 • edited Loading

Choose a reason for hiding this comment

everett980 Dec 4, 2019

Choose a reason for hiding this comment

everett980 left a comment • edited Loading

Choose a reason for hiding this comment

everett980 Dec 4, 2019

Choose a reason for hiding this comment

nabam Dec 5, 2019

Choose a reason for hiding this comment

everett980 Dec 4, 2019

Choose a reason for hiding this comment

everett980 left a comment

Choose a reason for hiding this comment

nabam commented Nov 28, 2019 •

edited

Loading

codecov bot commented Nov 28, 2019 •

edited

Loading

nabam Dec 2, 2019 •

edited

Loading

everett980 left a comment •

edited

Loading