Fix the default endpoint for OTLP exporter when using http/protobuf protocol

[Kielek]

Fixes #2857.

Changes

Default endpoint for OTLP exporter based on chosen protocol.

For significant contributions please make sure you have completed the following items:

• Appropriate CHANGELOG.md updated for non-trivial changes
  * [ ] Design discussion issue #
  * [ ] Changes in public API reviewed

[pellared]

LGTM

[codecov]

Codecov Report

Merging #2868 (ee14574) into main (84821ff) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2868      +/-   ##
==========================================
+ Coverage   84.22%   84.23%   +0.01%     
==========================================
  Files         251      251              
  Lines        8883     8889       +6     
==========================================
+ Hits         7482     7488       +6     
  Misses       1401     1401              

Impacted Files	Coverage Δ
...orter.OpenTelemetryProtocol/OtlpExporterOptions.cs	100.00% <100.00%> (ø)
...TelemetryProtocol/OtlpExporterOptionsExtensions.cs	97.80% <100.00%> (ø)
...nTelemetryProtocol/OtlpMetricExporterExtensions.cs	100.00% <100.00%> (ø)
...metryProtocol/OtlpTraceExporterHelperExtensions.cs	94.73% <100.00%> (-0.27%)	⬇️

[Kielek]

@CodeBlanch, I see that Compatibility API check is failing
with following errors

C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(82,5): error : CannotRemoveAttribute : Attribute 'System.Runtime.CompilerServices.CompilerGeneratedAttribute' exists on 'OpenTelemetry.Exporter.OtlpExporterOptions.Endpoint.get()' in the contract but not the implementation. [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj]
C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(82,5): error : CannotRemoveAttribute : Attribute 'System.Runtime.CompilerServices.CompilerGeneratedAttribute' exists on 'OpenTelemetry.Exporter.OtlpExporterOptions.Endpoint.set(System.Uri)' in the contract but not the implementation. [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj]
C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for 'D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\bin\Release\netstandard2.1\OpenTelemetry.Exporter.OpenTelemetryProtocol.dll' [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj]
C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(82,5): error : CannotRemoveAttribute : Attribute 'System.Runtime.CompilerServices.CompilerGeneratedAttribute' exists on 'OpenTelemetry.Exporter.OtlpExporterOptions.Endpoint.get()' in the contract but not the implementation. [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj]
C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(82,5): error : CannotRemoveAttribute : Attribute 'System.Runtime.CompilerServices.CompilerGeneratedAttribute' exists on 'OpenTelemetry.Exporter.OtlpExporterOptions.Endpoint.set(System.Uri)' in the contract but not the implementation. [D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\OpenTelemetry.Exporter.OpenTelemetryProtocol.csproj]
C:\Users\runneradmin\.nuget\packages\microsoft.dotnet.apicompat\6.0.0-beta.21308.1\build\Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for 'D:\a\opentelemetry-dotnet\opentelemetry-dotnet\src\OpenTelemetry.Exporter.OpenTelemetryProtocol\bin\Release\netstandard2.0\OpenTelemetry.Exporter.OpenTelemetryProtocol.dll' [D:\a\opentelemetry-dotnet\opentelemetry-

As I understand the issue is related to Microsoft.DotNet.ApiCompat tool.
The second tool using PublicApi.Shipped.txt and PublicApi.Unshipped.txt is passing correctly. Do you have any advice how to handle such issue?

[CodeBlanch]

@Kielek

I see that Compatibility API check is failing

No idea. It seems like an issue because we are going from an auto-property to one with implementation.

Try updating this version:

opentelemetry-dotnet/build/Common.prod.props

Line 15 in 7ce2e4c

<PackageReference Include="Microsoft.DotNet.ApiCompat" Version="6.0.0-beta.21308.1" PrivateAssets="All" />

To 6.0.0-beta.22107.2. That is the latest 6.0.0 version. There are some newer 7.0.0 ones: https://pkgs.dev.azure.com/dnceng/9ee6d478-d288-47f7-aacc-f6e6d082ae6d/_packaging/1a5f89f6-d8da-4080-b15f-242650c914a8/nuget/v3/flat2/microsoft.dotnet.apicompat/index.json

Maybe we will get lucky and it is an issue that has already been fixed.

@cijothomas Might need some help on this.

[utpilla]

@Kielek For the APICompat issue, could you please run the below command locally at the root of the repo?

dotnet build /p:CheckAPICompatibility=true,BaselineAllAPICompatError=true --configuration Release

This should create a file named ApiCompatBaseline.txt under src/OpenTelemetry.Exporter.OpenTelemetryProtocol/. Please add this file and commit the changes.

[Kielek]

@Kielek For the APICompat issue, could you please run the below command locally at the root of the repo?

dotnet build /p:CheckAPICompatibility=true,BaselineAllAPICompatError=true --configuration Release

This should create a file named ApiCompatBaseline.txt under src/OpenTelemetry.Exporter.OpenTelemetryProtocol/. Please add this file and commit the changes.

@utpilla do you consider this as a workaround or good solution? In my opinion the changes should not be detected as breaking change.

File commited.

[pellared]

This looks more readable and maintainable 👍

[utpilla]

@utpilla do you consider this as a workaround or good solution? In my opinion the changes should not be detected as breaking change.

File commited.

This is the defined way of suppressing any error if you feel that you want to ignore it. I'm not sure if this should be detected as a breaking change or not. I'll provide the feedback to the ApiCompat team about this.

[alanwest]

LGTM. Thanks, @Kielek!

[cijothomas]

Merging now, as this should be part of the 1.2 stable. Has enough approvals. and waited 2+days.