Skip to content

Commit

Permalink
Release 0.2.0-beta.1 (#923)
Browse files Browse the repository at this point in the history
* Fix BindingRedirect example

* Update releasing process
  • Loading branch information
pellared authored Jul 7, 2022
1 parent 3531260 commit 6229eb7
Show file tree
Hide file tree
Showing 15 changed files with 49 additions and 42 deletions.
39 changes: 21 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,31 @@ All notable changes to this project are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v0.1.0-beta.1...HEAD)
## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v0.2.0-beta.1...HEAD)

## [0.2.0-beta.1](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v0.2.0-beta.1)

This release is built on top of [OpenTelemetry .NET](https://github.com/open-telemetry/opentelemetry-dotnet):

- [Core components](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#core-components):
[`1.3.0`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.3.0)
- Non-core components: [`1.0.0-rc9.4`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/1.0.0-rc9.4)
- `System.Diagnostics.DiagnosticSource`: [`6.0.0`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/6.0.0)

You can find all OpenTelemetry references in
[OpenTelemetry.AutoInstrumentation.csproj](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v0.2.0-beta.1/src/OpenTelemetry.AutoInstrumentation/OpenTelemetry.AutoInstrumentation.csproj).

### Added

- Adds MongoDB instrumentation support from .NET Core 3.1+.
- Support for OpenTelemetry metric exporter related environment variables:
`OTEL_DOTNET_AUTO_METRICS_ENABLED`,
`OTEL_DOTNET_AUTO_LOAD_METER_AT_STARTUP`,
`OTEL_METRICS_EXPORTER`,
`OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED`,
`OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS`,
`OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS`,
`OTEL_DOTNET_AUTO_METRICS_PLUGINS`,
`OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES`.
- `OTEL_DOTNET_AUTO_METRICS_ENABLED`,
- `OTEL_DOTNET_AUTO_LOAD_METER_AT_STARTUP`,
- `OTEL_METRICS_EXPORTER`,
- `OTEL_DOTNET_AUTO_METRICS_CONSOLE_EXPORTER_ENABLED`,
- `OTEL_DOTNET_AUTO_METRICS_ENABLED_INSTRUMENTATIONS`,
- `OTEL_DOTNET_AUTO_METRICS_DISABLED_INSTRUMENTATIONS`,
- `OTEL_DOTNET_AUTO_METRICS_PLUGINS`,
- `OTEL_DOTNET_AUTO_METRICS_ADDITIONAL_SOURCES`.
- Support for .NET Runtime metrics collection using
the `OpenTelemetry.Instrumentation.Runtime` package.
- Support for ASP.NET and HttpClient metrics instrumentations.
Expand All @@ -39,14 +43,13 @@ This release is built on top of [OpenTelemetry .NET](https://github.com/open-tel
### Changed

- Rename generic environment variables to include trace.

`OTEL_DOTNET_AUTO_ENABLED`→`OTEL_DOTNET_AUTO_TRACES_ENABLED`
`OTEL_DOTNET_AUTO_LOAD_AT_STARTUP`→`OTEL_DOTNET_AUTO_LOAD_TRACER_AT_STARTUP`
`OTEL_DOTNET_AUTO_CONSOLE_EXPORTER_ENABLED`→`OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED`
`OTEL_DOTNET_AUTO_ENABLED_INSTRUMENTATIONS`→`OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS`
`OTEL_DOTNET_AUTO_DISABLED_INSTRUMENTATIONS`→`OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS`
`OTEL_DOTNET_AUTO_INSTRUMENTATION_PLUGINS`→`OTEL_DOTNET_AUTO_TRACES_PLUGINS`
`OTEL_DOTNET_AUTO_ADDITIONAL_SOURCES`→`OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES`
- `OTEL_DOTNET_AUTO_ENABLED` → `OTEL_DOTNET_AUTO_TRACES_ENABLED`,
- `OTEL_DOTNET_AUTO_LOAD_AT_STARTUP` → `OTEL_DOTNET_AUTO_LOAD_TRACER_AT_STARTUP`,
- `OTEL_DOTNET_AUTO_CONSOLE_EXPORTER_ENABLED` → `OTEL_DOTNET_AUTO_TRACES_CONSOLE_EXPORTER_ENABLED`,
- `OTEL_DOTNET_AUTO_ENABLED_INSTRUMENTATIONS` → `OTEL_DOTNET_AUTO_TRACES_ENABLED_INSTRUMENTATIONS`,
- `OTEL_DOTNET_AUTO_DISABLED_INSTRUMENTATIONS` → `OTEL_DOTNET_AUTO_TRACES_DISABLED_INSTRUMENTATIONS`,
- `OTEL_DOTNET_AUTO_INSTRUMENTATION_PLUGINS` → `OTEL_DOTNET_AUTO_TRACES_PLUGINS`,
- `OTEL_DOTNET_AUTO_ADDITIONAL_SOURCES` → `OTEL_DOTNET_AUTO_TRACES_ADDITIONAL_SOURCES`.

### Removed

Expand Down
4 changes: 3 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@ OpenTelemetry .NET Automatic Instrumentation is built on top of

- [Core components](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/VERSIONING.md#core-components):
[`1.3.0`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.3.0)
- Non-core components: [`1.0.0-rc9.4`](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/1.0.0-rc9.4)
- `System.Diagnostics.DiagnosticSource`: [`6.0.0`](https://www.nuget.org/packages/System.Diagnostics.DiagnosticSource/6.0.0)

You can find all OpenTelemetry references in
[OpenTelemetry.AutoInstrumentation.csproj](src/OpenTelemetry.AutoInstrumentation/OpenTelemetry.AutoInstrumentation.csproj).

To automatically instrument applications, the OpenTelemetry .NET Automatic
Instrumentation does the following:

Expand Down
4 changes: 2 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ for more details.

| ID | Library | Supported versions | Instrumentation type |
|-|-|-|-|
| `AspNet` | ASP.NET MVC Framework | * | source |
| `AspNet` | ASP.NET Framework | * | source |
| `AspNet` | ASP.NET Core | * | source |
| `GraphQL` | [GraphQL](https://www.nuget.org/packages/GraphQL/) | ≥2.3.0 & < 3.0.0 | bytecode |
| `HttpClient` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | * | source |
Expand All @@ -48,7 +48,7 @@ for more details.

| ID | Library | Supported versions | Instrumentation type |
|-|-|-|-|
| `AspNet` | ASP.NET MVC Framework | * | source |
| `AspNet` | ASP.NET Framework | * | source |
| `AspNet` | ASP.NET Core | * | source |
| `HttpClient` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | * | source |
| `NetRuntime` | [OpenTelemetry.Instrumentation.Runtime](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Runtime) | * | source |
Expand Down
16 changes: 9 additions & 7 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
# Release Process

1. Run the integration tests with Linux containers on Windows and macOS
(not covered by CI):

```bash
nuke Workflow --containers linux
```

1. Update the version in the following files:

- `TracerConstants.cs`
Expand All @@ -22,6 +15,15 @@

1. Create a pull request on GitHub with the changes described in the changelog.

1. Run the integration tests with Linux containers on Windows and macOS
(not covered by CI):

```bash
nuke Workflow --containers linux
```

1. Test the described [examples](../examples/README.md).

1. Once the pull request has been merged, create a signed tag for the merged commit.
You can do this using the following Bash snippet:

Expand Down
2 changes: 1 addition & 1 deletion examples/BindingRedirect/Examples.BindingRedirect.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFrameworks>net472</TargetFrameworks>
<TargetFrameworks>net462</TargetFrameworks>
<!-- Forcing binding redirection via app.config that references assemblies -->
<!-- only present if bytecode instrumentation is used. -->
<MSBuildWarningsAsMessages>MSB3277;MSB3836</MSBuildWarningsAsMessages>
Expand Down
2 changes: 1 addition & 1 deletion examples/OldReference/Examples.OldReference.csproj
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net472;netstandard2.0</TargetFrameworks>
<TargetFrameworks>net462;netstandard2.0</TargetFrameworks>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The following usage example is for Windows, as binding redirection only applies
to .NET Framework:

```bash
OTEL_DOTNET_AUTO_LEGACY_SOURCES="InstrumentedHttpCall.GetAsync" exampleApp=BindingRedirect exampleAppTargetFramework=net472 ./run-example.sh
OTEL_DOTNET_AUTO_LEGACY_SOURCES="InstrumentedHttpCall.GetAsync" exampleApp=BindingRedirect exampleAppTargetFramework=net462 ./run-example.sh
```

### ConsoleApp
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<AssemblyName>OpenTelemetry.AutoInstrumentation.Core</AssemblyName>

<!-- NuGet -->
<Version>0.1.0</Version>
<Version>0.2.0</Version>
<IsPackable>false</IsPackable>

<!-- Allow the GenerateAssemblyInfo task in the .NET SDK to generate all
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<OutputPath>..\bin\ProfilerResources\</OutputPath>

<!-- NuGet -->
<Version>0.1.0</Version>
<Version>0.2.0</Version>

<!-- Hide warnings for EOL .NET Core targets (e.g. netcoreapp2.0) -->
<CheckEolTargetFramework>false</CheckEolTargetFramework>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ cmake_policy(SET CMP0015 NEW)
# Project definition
# ******************************************************

project("OpenTelemetry.AutoInstrumentation.Native" VERSION 0.1.0)
project("OpenTelemetry.AutoInstrumentation.Native" VERSION 0.2.0)

# ******************************************************
# Environment detection
Expand Down
8 changes: 4 additions & 4 deletions src/OpenTelemetry.AutoInstrumentation.Native/Resource.rc
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ END
//

VS_VERSION_INFO VERSIONINFO
FILEVERSION 0,0,1,0
PRODUCTVERSION 0,0,1,0
FILEVERSION 0,2,0,0
PRODUCTVERSION 0,2,0,0
FILEFLAGSMASK 0x3fL
#ifdef _DEBUG
FILEFLAGS 0x1L
Expand All @@ -67,12 +67,12 @@ BEGIN
BEGIN
VALUE "CompanyName", "The OpenTelemetry Authors"
VALUE "FileDescription", "OpenTelemetry CLR Profiler"
VALUE "FileVersion", "0.1.0.0"
VALUE "FileVersion", "0.2.0.0"
VALUE "InternalName", "OpenTelemetry.AutoInstrumentation.Native.DLL"
VALUE "LegalCopyright", "Copyright 2021 The OpenTelemetry Authors"
VALUE "OriginalFilename", "OpenTelemetry.AutoInstrumentation.Native.DLL"
VALUE "ProductName", "OpenTelemetry .NET AutoInstrumentation"
VALUE "ProductVersion", "0.1.0"
VALUE "ProductVersion", "0.2.0"
END
END
BLOCK "VarFileInfo"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ const WSTRING system_private_corelib_assemblyName = WStr("System.Private.CoreLib
const WSTRING opentelemetry_autoinstrumentation_loader_assemblyName = WStr("OpenTelemetry.AutoInstrumentation.Loader");

const WSTRING managed_profiler_full_assembly_version =
WStr("OpenTelemetry.AutoInstrumentation, Version=0.1.0.0, Culture=neutral, PublicKeyToken=null");
WStr("OpenTelemetry.AutoInstrumentation, Version=0.2.0.0, Culture=neutral, PublicKeyToken=null");

const WSTRING managed_profiler_name = WStr("OpenTelemetry.AutoInstrumentation");

Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.AutoInstrumentation.Native/version.h
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#pragma once

constexpr auto PROFILER_VERSION = "0.1.0";
constexpr auto PROFILER_VERSION = "0.2.0";
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<Version>0.1.0</Version>
<Version>0.2.0</Version>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion src/OpenTelemetry.AutoInstrumentation/TracerConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace OpenTelemetry.AutoInstrumentation;
public static class TracerConstants
{
public const string Language = "dotnet";
public const string Version = "0.1.0";
public const string Version = "0.2.0";
}
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
#pragma warning restore SA1600 // Elements should be documented

0 comments on commit 6229eb7

Please sign in to comment.