This project is a redistribution of the OpenTelemetry Agent for DotNet, preconfigured for use with AWS services. Please check out that project too to get a better understanding of the underlying internals. You won't see much code in this repository since we only apply some small configuration changes, and our OpenTelemetry friends takes care of the rest.
- Having one of VSCode, Visual Studio, or ReSharper installed
- Having dotnet cli installed.
Although this repository is released under the Apache-2.0 license, some Dockerfiles uses Windows as a base image, which is licensed under the following terms https://learn.microsoft.com/en-us/virtualization/windowscontainers/images-eula.
To build the dll files for the AWS.Distro.OpenTelemetry.AutoInstrumentation project, just run
dotnet buildThis will build the dll under src/AWS.Distro.OpenTelemetry.AutoInstrumentation/bin/Debug/net8.0.
To build the project for release, packaged with OpenTelemetry DotNet Instrumentation, run the following in the root directory:
bash build.shThis runs build/Build.cs which basically pulls OpenTelemetry DotNet Instrumentation packaged zip file and adds the AWS.Distro.OpenTelemetry.AutoInstrumentation dll there.
This package uses StyleCop to enforce styling rules as well as having Copyright headers. More information about the rules themselves can be found here. The project is configured to use StyleCop so any file that is added that violates any of the rules, the Code Editor will complain. Alternatively, running dotnet build will complain as well. Unfortunately, it doesn't auto apply styling. To fix "most" of styling issues that come up, you can run dotnet format.
For Integration Testing, follow README under sample-applications/integration-test-app
For Unit Testing, followed this doc to create test/AWS.Distro.OpenTelemetry.AutoInstrumentation.Tests directory. You can use that doc to add more unit tests. To run the unit tests, run dotnet test
See CONTRIBUTING for more information.
This project is licensed under the Apache-2.0 License.