Skip to content

Commit

Permalink
Cleanup & Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RassK committed Feb 29, 2024
1 parent 65b7908 commit 5b6763b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ MD024:
allow_different_nesting: true
# Only check sibling headings
siblings_only: true

# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md033.md
MD033:
# Allowed elements
allowed_elements: ['a', 'img']
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h

- .NET only, warning in logs about End of Support date
and upcoming End of Support date for .NET version.
- ARM64 support for Ubuntu, Alpine and Debian based images.
- ARM64 support for the `OpenTelemetry.AutoInstrumentation` NuGet package.

### Changed

Expand Down
2 changes: 1 addition & 1 deletion build/Build.Steps.cs
Original file line number Diff line number Diff line change
Expand Up @@ -570,7 +570,7 @@ void RemoveFilesInNetFolderAvailableInAdditionalStore()
// Additional-deps probes the directory using SemVer format.
// Example: For netcoreapp3.1 framework, additional-deps uses 3.1.0 or 3.1.1 and so on.
// Major and Minor version are extracted from framework and default value of 0 is appended for patch.
.SetOutput(AdditionalDepsDirectory / "shared" / "Microsoft.NETCore.App" / framework.ToString().Substring(framework.ToString().Length - 3) + ".0"))); ;
.SetOutput(AdditionalDepsDirectory / "shared" / "Microsoft.NETCore.App" / framework.ToString().Substring(framework.ToString().Length - 3) + ".0")));

AdditionalDepsDirectory.GlobFiles("**/*deps.json")
.ForEach(file =>
Expand Down
24 changes: 17 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
[![Slack](https://img.shields.io/badge/slack-@cncf/otel--dotnet--auto--instr-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01NR1YLSE7)
[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.AutoInstrumentation.svg)](https://www.nuget.org/packages/OpenTelemetry.AutoInstrumentation)
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.AutoInstrumentation.svg)](https://www.nuget.org/packages/OpenTelemetry.AutoInstrumentation)
<a href="https://actuated.dev/">
<img
alt="Arm CI sponsored by Actuated"
src="https://docs.actuated.dev/images/actuated-badge.png" width="120px">
</img>
</a>

This project adds [OpenTelemetry instrumentation](https://opentelemetry.io/docs/concepts/instrumenting/#automatic-instrumentation)
to .NET applications without having to modify their source code.
Expand Down Expand Up @@ -87,19 +93,23 @@ Supported processor architectures are:

- x86
- AMD64 (x86-64)
- ARM64

> [!NOTE]
> ARM architectures are not supported yet,
> see [#2181](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/issues/2181).
> ARM64 build does not support CentOS based images.
CI tests run against the following operating systems:

- [Alpine](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/alpine.dockerfile)
- [CentOS 7](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/centos-build.dockerfile)
- [Alpine x64](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/alpine.dockerfile)
- [Alpine ARM64](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/alpine.dockerfile)
- [Debian x64](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/debian.dockerfile)
- [Debian ARM64](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/debian-arm64.dockerfile)
- [CentOS 7 x64](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docker/centos-build.dockerfile)
(.NET 8 is not supported)
- [macOS Big Sur 11](https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md)
- [Microsoft Windows Server 2022](https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md)
- [Ubuntu 20.04 LTS](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2004-Readme.md)
- [macOS Big Sur 11 x64](https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md)
- [Microsoft Windows Server 2022 x64](https://github.com/actions/runner-images/blob/main/images/windows/Windows2022-Readme.md)
- [Ubuntu 20.04 LTS x64](https://github.com/actions/runner-images/blob/main/images/ubuntu/Ubuntu2004-Readme.md)
- Ubuntu 22.04 LTS ARM64

### Instrumented libraries and frameworks

Expand Down

0 comments on commit 5b6763b

Please sign in to comment.