-
Notifications
You must be signed in to change notification settings - Fork 721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds trimming and AOT related attribute definitions for down-level TFMs #4580
Closed
Closed
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
7439f07
Add the attributes
vitek-karas 2cb85bc
Auto include the attribute with PropertyFetcher
vitek-karas 7364854
Fix build break caused by merging new changes
vitek-karas 35bb940
Remove unwanted change
vitek-karas ab9b068
Remove unnecessary condition
vitek-karas 79eeae4
Apply suggestions from code review
vitek-karas 1d7ccae
Fix a style problem
vitek-karas bc35f0b
test
Yun-Ting fa8bc61
PR feedback
vitek-karas 344f036
ci
Yun-Ting 21baea0
Fixes all missing public API declarations and nullability marks
vitek-karas 7cc3277
Remove the attributes from Api
vitek-karas d151841
trigger ci
Yun-Ting File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletions
1
src/OpenTelemetry.Api.ProviderBuilderExtensions/.publicApi/net6.0/PublicAPI.Shipped.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
#nullable enable |
27 changes: 27 additions & 0 deletions
27
src/OpenTelemetry.Api.ProviderBuilderExtensions/.publicApi/net6.0/PublicApi.Unshipped.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions | ||
OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggingServiceCollectionExtensions | ||
OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions | ||
OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMetricsServiceCollectionExtensions | ||
OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions | ||
OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracingServiceCollectionExtensions | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Logs.LoggerProviderBuilder! loggerProviderBuilder) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Logs.LoggerProviderBuilder! loggerProviderBuilder, System.Func<System.IServiceProvider!, OpenTelemetry.Logs.LoggerProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Logs.LoggerProviderBuilder! loggerProviderBuilder, System.Func<System.IServiceProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Logs.LoggerProviderBuilder! loggerProviderBuilder, T! instrumentation) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggerProviderBuilderExtensions.ConfigureServices(this OpenTelemetry.Logs.LoggerProviderBuilder! loggerProviderBuilder, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection!>! configure) -> OpenTelemetry.Logs.LoggerProviderBuilder! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggingServiceCollectionExtensions.ConfigureOpenTelemetryLoggerProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<OpenTelemetry.Logs.LoggerProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! | ||
static OpenTelemetry.Logs.OpenTelemetryDependencyInjectionLoggingServiceCollectionExtensions.ConfigureOpenTelemetryLoggerProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<System.IServiceProvider!, OpenTelemetry.Logs.LoggerProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder) -> OpenTelemetry.Metrics.MeterProviderBuilder! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, System.Func<System.IServiceProvider!, OpenTelemetry.Metrics.MeterProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Metrics.MeterProviderBuilder! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, System.Func<System.IServiceProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Metrics.MeterProviderBuilder! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, T! instrumentation) -> OpenTelemetry.Metrics.MeterProviderBuilder! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMeterProviderBuilderExtensions.ConfigureServices(this OpenTelemetry.Metrics.MeterProviderBuilder! meterProviderBuilder, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection!>! configure) -> OpenTelemetry.Metrics.MeterProviderBuilder! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMetricsServiceCollectionExtensions.ConfigureOpenTelemetryMeterProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<OpenTelemetry.Metrics.MeterProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! | ||
static OpenTelemetry.Metrics.OpenTelemetryDependencyInjectionMetricsServiceCollectionExtensions.ConfigureOpenTelemetryMeterProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<System.IServiceProvider!, OpenTelemetry.Metrics.MeterProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder) -> OpenTelemetry.Trace.TracerProviderBuilder! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder, System.Func<System.IServiceProvider!, OpenTelemetry.Trace.TracerProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Trace.TracerProviderBuilder! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder, System.Func<System.IServiceProvider!, T!>! instrumentationFactory) -> OpenTelemetry.Trace.TracerProviderBuilder! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions.AddInstrumentation<T>(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder, T! instrumentation) -> OpenTelemetry.Trace.TracerProviderBuilder! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracerProviderBuilderExtensions.ConfigureServices(this OpenTelemetry.Trace.TracerProviderBuilder! tracerProviderBuilder, System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection!>! configure) -> OpenTelemetry.Trace.TracerProviderBuilder! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracingServiceCollectionExtensions.ConfigureOpenTelemetryTracerProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<OpenTelemetry.Trace.TracerProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! | ||
static OpenTelemetry.Trace.OpenTelemetryDependencyInjectionTracingServiceCollectionExtensions.ConfigureOpenTelemetryTracerProvider(this Microsoft.Extensions.DependencyInjection.IServiceCollection! services, System.Action<System.IServiceProvider!, OpenTelemetry.Trace.TracerProviderBuilder!>! configure) -> Microsoft.Extensions.DependencyInjection.IServiceCollection! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -2,7 +2,7 @@ | |||||||||||||
|
||||||||||||||
<PropertyGroup> | ||||||||||||||
<!-- OmniSharp/VS Code requires TargetFrameworks to be in descending order for IntelliSense and analysis. --> | ||||||||||||||
<TargetFrameworks>netstandard2.0;net462</TargetFrameworks> | ||||||||||||||
<TargetFrameworks>net6.0;netstandard2.0;net462</TargetFrameworks> | ||||||||||||||
<Description>Contains extensions to register OpenTelemetry in applications using Microsoft.Extensions.DependencyInjection</Description> | ||||||||||||||
<RootNamespace>OpenTelemetry</RootNamespace> | ||||||||||||||
<MinVerTagPrefix>core-</MinVerTagPrefix> | ||||||||||||||
|
@@ -17,4 +17,18 @@ | |||||||||||||
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" /> | ||||||||||||||
</ItemGroup> | ||||||||||||||
|
||||||||||||||
<ItemGroup> | ||||||||||||||
<Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\Shims\DynamicallyAccessedMembersAttribute.cs" Link="Includes\DynamicallyAccessedMembersAttribute.cs" /> | ||||||||||||||
<Compile Include="$(RepoRoot)\src\OpenTelemetry.Api\Internal\Shims\DynamicallyAccessedMemberTypes.cs" Link="Includes\DynamicallyAccessedMemberTypes.cs" /> | ||||||||||||||
</ItemGroup> | ||||||||||||||
|
||||||||||||||
<!-- | ||||||||||||||
v1.4.0 doesn't contain a net6.0 target, so we can't run ApiCompat against it. | ||||||||||||||
Instead, run net6.0's ApiCompat check against netstandard2.0. | ||||||||||||||
Remove this once 1.5.0 is released. | ||||||||||||||
Comment on lines
+26
to
+28
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 1.5.0 is already released.
Suggested change
|
||||||||||||||
--> | ||||||||||||||
<ItemGroup Condition="'$(CheckAPICompatibility)' == 'true' and '$(TargetFramework)' == 'net6.0'"> | ||||||||||||||
<ResolvedMatchingContract Remove="$(RepoRoot)\build\LastMajorVersionBinaries\$(AssemblyName)\$(OTelPreviousStableVer)\lib\$(TargetFramework)\$(AssemblyName).dll" /> | ||||||||||||||
<ResolvedMatchingContract Include="$(RepoRoot)\build\LastMajorVersionBinaries\$(AssemblyName)\$(OTelPreviousStableVer)\lib\netstandard2.0\$(AssemblyName).dll" /> | ||||||||||||||
</ItemGroup> | ||||||||||||||
</Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
src/OpenTelemetry.Api/Internal/Shims/DynamicallyAccessedMemberTypes.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
// <copyright file="DynamicallyAccessedMemberTypes.cs" company="OpenTelemetry Authors"> | ||
// Copyright The OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
// </copyright> | ||
|
||
#nullable enable | ||
#if NETFRAMEWORK || NETSTANDARD2_0_OR_GREATER | ||
namespace System.Diagnostics.CodeAnalysis | ||
{ | ||
/// <summary> | ||
/// Specifies the types of members that are dynamically accessed. | ||
/// | ||
/// This enumeration has a <see cref="FlagsAttribute"/> attribute that allows a | ||
/// bitwise combination of its member values. | ||
/// </summary> | ||
[Flags] | ||
internal enum DynamicallyAccessedMemberTypes | ||
{ | ||
/// <summary> | ||
/// Specifies no members. | ||
/// </summary> | ||
None = 0, | ||
|
||
/// <summary> | ||
/// Specifies the default, parameterless public constructor. | ||
/// </summary> | ||
PublicParameterlessConstructor = 0x0001, | ||
|
||
/// <summary> | ||
/// Specifies all public constructors. | ||
/// </summary> | ||
PublicConstructors = 0x0002 | PublicParameterlessConstructor, | ||
|
||
/// <summary> | ||
/// Specifies all non-public constructors. | ||
/// </summary> | ||
NonPublicConstructors = 0x0004, | ||
|
||
/// <summary> | ||
/// Specifies all public methods. | ||
/// </summary> | ||
PublicMethods = 0x0008, | ||
|
||
/// <summary> | ||
/// Specifies all non-public methods. | ||
/// </summary> | ||
NonPublicMethods = 0x0010, | ||
|
||
/// <summary> | ||
/// Specifies all public fields. | ||
/// </summary> | ||
PublicFields = 0x0020, | ||
|
||
/// <summary> | ||
/// Specifies all non-public fields. | ||
/// </summary> | ||
NonPublicFields = 0x0040, | ||
|
||
/// <summary> | ||
/// Specifies all public nested types. | ||
/// </summary> | ||
PublicNestedTypes = 0x0080, | ||
|
||
/// <summary> | ||
/// Specifies all non-public nested types. | ||
/// </summary> | ||
NonPublicNestedTypes = 0x0100, | ||
|
||
/// <summary> | ||
/// Specifies all public properties. | ||
/// </summary> | ||
PublicProperties = 0x0200, | ||
|
||
/// <summary> | ||
/// Specifies all non-public properties. | ||
/// </summary> | ||
NonPublicProperties = 0x0400, | ||
|
||
/// <summary> | ||
/// Specifies all public events. | ||
/// </summary> | ||
PublicEvents = 0x0800, | ||
|
||
/// <summary> | ||
/// Specifies all non-public events. | ||
/// </summary> | ||
NonPublicEvents = 0x1000, | ||
|
||
/// <summary> | ||
/// Specifies all interfaces implemented by the type. | ||
/// </summary> | ||
Interfaces = 0x2000, | ||
|
||
/// <summary> | ||
/// Specifies all members. | ||
/// </summary> | ||
All = ~None, | ||
} | ||
} | ||
#endif |
67 changes: 67 additions & 0 deletions
67
src/OpenTelemetry.Api/Internal/Shims/DynamicallyAccessedMembersAttribute.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
// <copyright file="DynamicallyAccessedMembersAttribute.cs" company="OpenTelemetry Authors"> | ||
// Copyright The OpenTelemetry Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
// </copyright> | ||
|
||
#nullable enable | ||
#if NETFRAMEWORK || NETSTANDARD2_0_OR_GREATER | ||
namespace System.Diagnostics.CodeAnalysis | ||
{ | ||
/// <summary> | ||
/// Indicates that certain members on a specified <see cref="Type"/> are accessed dynamically, | ||
/// for example through <see cref="Reflection"/>. | ||
/// </summary> | ||
/// <remarks> | ||
/// This allows tools to understand which members are being accessed during the execution | ||
/// of a program. | ||
/// | ||
/// This attribute is valid on members whose type is <see cref="Type"/> or <see cref="string"/>. | ||
/// | ||
/// When this attribute is applied to a location of type <see cref="string"/>, the assumption is | ||
/// that the string represents a fully qualified type name. | ||
/// | ||
/// When this attribute is applied to a class, interface, or struct, the members specified | ||
/// can be accessed dynamically on <see cref="Type"/> instances returned from calling | ||
/// <see cref="object.GetType"/> on instances of that class, interface, or struct. | ||
/// | ||
/// If the attribute is applied to a method it's treated as a special case and it implies | ||
/// the attribute should be applied to the "this" parameter of the method. As such the attribute | ||
/// should only be used on instance methods of types assignable to System.Type (or string, but no methods | ||
/// will use it there). | ||
/// </remarks> | ||
[AttributeUsage( | ||
AttributeTargets.Field | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter | | ||
AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Method | | ||
AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Struct, | ||
Inherited = false)] | ||
internal sealed class DynamicallyAccessedMembersAttribute : Attribute | ||
{ | ||
/// <summary> | ||
/// Initializes a new instance of the <see cref="DynamicallyAccessedMembersAttribute"/> class | ||
/// with the specified member types. | ||
/// </summary> | ||
/// <param name="memberTypes">The types of members dynamically accessed.</param> | ||
public DynamicallyAccessedMembersAttribute(DynamicallyAccessedMemberTypes memberTypes) | ||
{ | ||
this.MemberTypes = memberTypes; | ||
} | ||
|
||
/// <summary> | ||
/// Gets the <see cref="DynamicallyAccessedMemberTypes"/> which specifies the type | ||
/// of members dynamically accessed. | ||
/// </summary> | ||
public DynamicallyAccessedMemberTypes MemberTypes { get; } | ||
} | ||
} | ||
#endif |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to still target
net6.0
for this project? That was necessary for OpenTelemetry.Api because of InternalsVisibleTo. Is the same necessary here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes - it has IVT to
OpenTelemetry
, so basically the same problem asOpenTelemetry.Api
.opentelemetry-dotnet/src/OpenTelemetry.Api.ProviderBuilderExtensions/AssemblyInfo.cs
Line 19 in 5f825cb
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's also in-line with the result of a discussion around retargeting to .NET 6. The conclusion was that retargeting projects which actually make use of the new attributes is a good solution.