feat: include additional metadata for tracing the collaboration service

[jvillafanez]

Description

Improve tracing of the collaboration service. This includes:

• Content data upload and download through the WOPI server will be traced. Upload and download times are shown now.
• Some file and user metadata included in the collaboration span. This can help to filter traces by user or by file. It might be useful if users come from different idps, or files are stored in multiple places
• Included the request method in the span name.

It might be better if the X-WOPI-Override header was part of the span name, but it seems we'd need to replace the otelchi middleware with our custom version. For now, the header is included as span attribute.

Related Issue

no open issue

Motivation and Context

This should reflect better how much time is spent in other services, specially since the upload and download times weren't being shown before.

How Has This Been Tested?

Manually checked with a jaeger instance.

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Technical debt
• Tests only (no source changes)

Checklist:

• Code changes
• Unit tests added
• Acceptance tests added
• Documentation ticket raised:

Additional things to consider

• Tracing middleware might be merged with the wopiContext one. This could improve the performance because with this PR we need to get the wopiContext several times per requests. However, this could be confusing in the long run because the resulting middleware would do multiple things.
• Including the X-WOPI-Override header in the span name might be ideal. However, there is no good way to do it.
  • We can set a new name, but we can't get the current name. In order to set the name we want, we'd need to copy the otelchi code in our tracing code (at least the relevant part in order to get the name), so we'd do the same thing twice adding more overhead to every request.
  • We can replace the otelchi implementation with a custom one. However, the setup is kind of standard in ocis. Using a custom implementation in a specific service might be confusing.
• I don't think there isn't any other useful information that could be added in the span attributes

[update-docs]

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
10.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[butonic]

❤️