Support trace-scoped external links similar to tag links

[rubenvp8510]

Signed-off-by: Ruben Vargas [email protected]

Which problem is this PR solving?

• Implements external links at trace level Resolves Support trace-scoped external links similar to tag links #465

Short description of the changes

• Now render a link on the header title in traceview if external links is configured.

[codecov]

Codecov Report

Merging #480 into master will increase coverage by 0.04%.
The diff coverage is 93.54%.

@@            Coverage Diff             @@
##           master     #480      +/-   ##
==========================================
+ Coverage   92.74%   92.79%   +0.04%     
==========================================
  Files         193      194       +1     
  Lines        4672     4702      +30     
  Branches     1126     1132       +6     
==========================================
+ Hits         4333     4363      +30     
  Misses        299      299              
  Partials       40       40

Impacted Files	Coverage Δ
packages/jaeger-ui/src/model/link-patterns.tsx	94.44% <100%> (+2.89%)	⬆️
...ents/TracePage/TracePageHeader/TracePageHeader.tsx	96.42% <50%> (-3.58%)	⬇️
.../jaeger-ui/src/components/common/ExternalLinks.tsx	88.88% <88.88%> (ø)
...eViewer/TimelineHeaderRow/TimelineViewingLayer.tsx	89.83% <0%> (+1.69%)	⬆️

---

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 1ee0cf1...c39d6e6. Read the comment docs.

[yurishkuro]

Implements external links at trace level (Issue 465)

If it resolves that issue, please include text Resolves #465 in the description to enable auto-close.

Please include sample screenshots.

How are these links configured by the end user? Please create a documentation PR to add it to https://www.jaegertracing.io/docs/1.14/frontend-ui/

[rubenvp8510]

Attached screenshots.

[everett980]

Can you update the type in types/config.tsx? Unfortunately, due to _get, it doesn't currently matter, but I plan on fixing that.
Also, it serves as a form of documentation, in addition to what Yuri linked.

[rubenvp8510]

Can you update the type in types/config.tsx? Unfortunately, due to _get, it doesn't currently matter, but I plan on fixing that.
Also, it serves as a form of documentation, in addition to what Yuri linked.

Added.

[yurishkuro]

@everett980 is this ready to merge?

[everett980]

Thanks for the pr @rubenvp8510, sorry it took me so long to get to it!

It mostly looks good, aside from simplifying the caching strategy which is admittedly based off of an existing function. That and some minor TS changes and some props that seem unused.

[everett980]

Please update year to 2019

[rubenvp8510]

😳

[yurishkuro]

if this is a brand new file/code, the copyright should be The Jaeger Authors

[everett980]

@yurishkuro when did this change? should any existing files be updated from "Uber Technologies, Inc." to "The Jaeger Authors"?
Also, the CONTRIBUTING.md#license should probably mention to use the current year, right?

[yurishkuro]

It's always been the guideline. The link also says Jaeger Authors.

Yes, we might fix the year there so that people can copy & paste, although a preferred way is to auto-generate the headers like we do in the other repos (e.g. make fmt adds them).

[everett980]

what children should this component expect? the use case above does not seem to provide children.

[everett980]

@rubenvp8510 are there any expected children? If not, this prop and its consumption in render can be removed.

[rubenvp8510]

I've already address all comments here. Ready for another review!

[rubenvp8510]

Done!

[everett980]

Looks good! 👍

[yurishkuro]

🎉

[rwkarg]

Is there an example on how to configure this?

[pathikritmodak]

Any example or documentation around this would help. We are planning to use this.
@rubenvp8510 can you please add docs or example as well.

[rubenvp8510]

@rwkarg @pathikritmodak

Sorry, I haven't had a chance to write documentation about this. I'll send a PR today. You can add trace links to your traces adding an entry into linkPatterns node of the UI config with type= 'traces'

here is an example:

linkPatterns: [
  {
    type: 'traces',
    url : 'http://localhost:8080/more?traceId=#{traceID}',
    text : "External Link to #{traceID}"
  },
  {
    type: 'traces',
    url : 'http://localhost/stats/more?traceId=#{traceID}',
    text : "Other external to #{traceName}"
  }
],

Both url and text can be defined as templates (i.e. using #{field-name}) (same as other linkPatterns). Supported template fields: duration, endTime, startTime,traceName, traceID