Skip to content

Commit

Permalink
Merge branch 'main' into #229
Browse files Browse the repository at this point in the history
  • Loading branch information
IevgenPlatonov authored Mar 17, 2022
2 parents f864e84 + 8b456b4 commit bf4af7a
Show file tree
Hide file tree
Showing 22 changed files with 91 additions and 65 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/package-Exporter.Stackdriver.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Pack OpenTelemetry.Contrib.Exporter.Stackdriver
name: Pack OpenTelemetry.Exporter.Stackdriver

on:
workflow_dispatch:
Expand All @@ -15,7 +15,7 @@ jobs:
build-test-pack:
runs-on: ${{ matrix.os }}
env:
PROJECT: OpenTelemetry.Contrib.Exporter.Stackdriver
PROJECT: OpenTelemetry.Exporter.Stackdriver

strategy:
matrix:
Expand Down
90 changes: 53 additions & 37 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,22 @@ You can contribute to this project from a Windows, macOS or Linux machine.
On all platforms, the minimum requirements are:

* Git client and command line tools.
* .NET Core 3.1+
* .NET 6.0+

Please note that individual project requirements might vary.

### Linux or MacOS

* Visual Studio for Mac or Visual Studio Code

Mono might be required by your IDE but is not required by this project. This is
because unit tests targeting .NET Framework (i.e: `net46`) are disabled outside
of Windows.
because unit tests targeting .NET Framework (`net452`, `net46`, `net461` etc.)
are disabled outside of Windows.

### Windows

* Visual Studio 2017+ or Visual Studio Code
* .NET Framework 4.6+
* Visual Studio 2022+ or Visual Studio Code
* .NET Framework 4.6.1+

## Pull Requests

Expand Down Expand Up @@ -110,13 +112,17 @@ Open a pull request against the main `opentelemetry-dotnet-contrib` repo.
* If the PR is not ready for review, please mark it as
[`draft`](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
* Make sure CLA is signed and CI is clear.
* Submit small, focused PRs addressing a single concern/issue.
* Make sure the PR title reflects the contribution.
* Write a summary that helps understand the change.
* Include usage examples in the summary, where applicable.

### How to Get PRs Merged

A PR is considered to be **ready to merge** when:

* It has received approval from
[Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver).
[Approvers](https://github.com/open-telemetry/community/blob/master/community-membership.md#approver)
/
[Maintainers](https://github.com/open-telemetry/community/blob/master/community-membership.md#maintainer).
* Major feedbacks are resolved.
Expand All @@ -131,8 +137,8 @@ and the new feature doesn't fit it.

### How to request for release of package

Submit a PR with `CHANGELOG.md` file reflecting the version to be released. Also,
tag the maintainers of this repository who can release the package.
Submit a PR with `CHANGELOG.md` file reflecting the version to be released.
Also, tag the maintainers of this repository who can release the package.

## Style Guide

Expand All @@ -148,36 +154,33 @@ build. Breaking the rules will result in a build failure.

## Contributing a new project

This repo is a great place to contribute a new instrumentation, exporter or
any kind of extension. Please refer to
[this page](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#extending-the-opentelemetry-net-sdk)
for help writing your component.
Although the projects within this repo share some
properties and configurations, they are built and released independently.
This repo is a great place to contribute a new instrumentation, exporter or any
kind of extension. Please refer to [this
page](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/docs/trace/extending-the-sdk/README.md#extending-the-opentelemetry-net-sdk)
for help writing your component. Although the projects within this repo share
some properties and configurations, they are built and released independently.
So if you are creating a new project within `/src` and corresponding test
project within `/test`, here are a few things you should do to ensure that
your project is automatically built and shipped through CI.

* Based on what your project is, you may need to depend on the
[OpenTelemetry SDK](https://www.nuget.org/packages/OpenTelemetry)
or the
[OpenTelemetry API](https://www.nuget.org/packages/OpenTelemetry.Api)
Include the necessary package in your project.
You can choose the version that you want to depend on.
project within `/test`, here are a few things you should do to ensure that your
project is automatically built and shipped through CI.

* Based on what your project is, you may need to depend on the [OpenTelemetry
SDK](https://www.nuget.org/packages/OpenTelemetry) or the [OpenTelemetry
API](https://www.nuget.org/packages/OpenTelemetry.Api) Include the necessary
package in your project. You can choose the version that you want to depend on.
Usually it is a good idea to use the latest version. Example:

```xml
<ItemGroup>
<PackageReference Include="OpenTelemetry" Version="1.0.0-rc4" />
<PackageReference Include="OpenTelemetry" Version="1.2.0-rc3" />
</ItemGroup>
```

* The assembly and nuget versioning is managed through
[MinVer](https://github.com/adamralph/minver) for all the projects in the
repo. MinVer will assign the version to your project based on the tag prefix
specified by you. To ensure your project is versioned appropriately, specify
a `<MinVerTagPrefix>` property in your project file. If your project is named
as "OpenTelemetry.Contrib.Foo.Bar", the MinVerTagPrefix must be "Foo.Bar-".
[MinVer](https://github.com/adamralph/minver) for all the projects in the repo.
MinVer will assign the version to your project based on the tag prefix specified
by you. To ensure your project is versioned appropriately, specify a
`<MinVerTagPrefix>` property in your project file. If your project is named as
"OpenTelemetry.Contrib.Foo.Bar", the MinVerTagPrefix must be "Foo.Bar-".
Example:

```xml
Expand All @@ -186,18 +189,31 @@ Example:
</PropertyGroup>
```

* To build and release your project as nuget, you must provide a GitHub
workflow to be triggered when a tag with prefix "Foo.Bar-" is pushed to the
main branch. The workflow file should be named as `package-Foo.Bar.yml` and
to be placed in the `.github/workflows/` folder.
* To build and release your project as nuget, you must provide a GitHub workflow
to be triggered when a tag with prefix "Foo.Bar-" is pushed to the main branch.
The workflow file should be named as `package-Foo.Bar.yml` and to be placed in
the `.github/workflows/` folder.

You can copy one of the
[existing workflow files](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/workflows/package-Extensions.AWSXRay.yml)
You can copy one of the [existing workflow
files](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/workflows/package-Extensions.AWSXRay.yml)
and replace the
[`tags`](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/workflows/package-Extensions.AWSXRay.yml#L12)
value to "Foo.Bar-*" and
[`PROJECT`](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/.github/workflows/package-Extensions.AWSXRay.yml#L18)
value to "OpenTelemetry.Contrib.Foo.Bar".

* When contributing a new project you are expected to assign yourself to your
project in the [code_owners](./.github/code_owners.yml) file
* Add a README file for your project describing how to install and use your
package. Every project's README file needs to have a link to the Nuget
package. You can use the below snippet for reference:

<!-- markdownlint-disable MD040 -->
```
[![NuGet](https://img.shields.io/nuget/v/{your_package_name}.svg)](https://www.nuget.org/packages/{your_package_name})
[![NuGet](https://img.shields.io/nuget/dt/{your_package_name}.svg)](https://www.nuget.org/packages/{your_package_name})
```
<!-- markdownlint-enable MD040 -->

* When contributing a new project you are expected to assign either yourself or
someone else who would take ownership for the component you are contributing.
Please add the right onwer for your project in the
[component_owners](./.github/component_owners.yml) file.
28 changes: 14 additions & 14 deletions opentelemetry-dotnet-contrib.sln
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{E0F52FDB-2
test\Directory.Build.targets = test\Directory.Build.targets
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Exporter.Stackdriver", "src\OpenTelemetry.Contrib.Exporter.Stackdriver\OpenTelemetry.Contrib.Exporter.Stackdriver.csproj", "{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Instrumentation.EntityFrameworkCore", "src\OpenTelemetry.Contrib.Instrumentation.EntityFrameworkCore\OpenTelemetry.Contrib.Instrumentation.EntityFrameworkCore.csproj", "{09525C6C-68B7-405E-B476-23E64D91C11B}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Instrumentation.MassTransit", "src\OpenTelemetry.Contrib.Instrumentation.MassTransit\OpenTelemetry.Contrib.Instrumentation.MassTransit.csproj", "{301BFB9F-6D73-4DEE-93D1-75F480816F63}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Exporter.Stackdriver.Tests", "test\OpenTelemetry.Contrib.Exporter.Stackdriver.Tests\OpenTelemetry.Contrib.Exporter.Stackdriver.Tests.csproj", "{11839CC5-F02B-4812-969A-52CDF5FE9394}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Instrumentation.MassTransit.Tests", "test\OpenTelemetry.Contrib.Instrumentation.MassTransit.Tests\OpenTelemetry.Contrib.Instrumentation.MassTransit.Tests.csproj", "{1F4B5983-EA2E-4DAC-8E02-20C0CDA9FA93}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Instrumentation.ElasticsearchClient", "src\OpenTelemetry.Contrib.Instrumentation.ElasticsearchClient\OpenTelemetry.Contrib.Instrumentation.ElasticsearchClient.csproj", "{5F10395B-DF38-438A-B5DB-5F6449184F67}"
Expand Down Expand Up @@ -169,16 +165,16 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentati
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Instrumentation.Runtime.Tests", "test\OpenTelemetry.Contrib.Instrumentation.Runtime.Tests\OpenTelemetry.Instrumentation.Runtime.Tests.csproj", "{FB907DF7-F3F3-4A07-885D-E5FECAE36BDA}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Exporter.Stackdriver", "src\OpenTelemetry.Exporter.Stackdriver\OpenTelemetry.Exporter.Stackdriver.csproj", "{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OpenTelemetry.Contrib.Exporter.Stackdriver.Tests", "test\OpenTelemetry.Exporter.Stackdriver.Tests\OpenTelemetry.Contrib.Exporter.Stackdriver.Tests.csproj", "{8DABC11A-624E-4554-ACA4-D5B80146B9C6}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A}.Release|Any CPU.ActiveCfg = Release|Any CPU
{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A}.Release|Any CPU.Build.0 = Release|Any CPU
{09525C6C-68B7-405E-B476-23E64D91C11B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{09525C6C-68B7-405E-B476-23E64D91C11B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{09525C6C-68B7-405E-B476-23E64D91C11B}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand All @@ -187,10 +183,6 @@ Global
{301BFB9F-6D73-4DEE-93D1-75F480816F63}.Debug|Any CPU.Build.0 = Debug|Any CPU
{301BFB9F-6D73-4DEE-93D1-75F480816F63}.Release|Any CPU.ActiveCfg = Release|Any CPU
{301BFB9F-6D73-4DEE-93D1-75F480816F63}.Release|Any CPU.Build.0 = Release|Any CPU
{11839CC5-F02B-4812-969A-52CDF5FE9394}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{11839CC5-F02B-4812-969A-52CDF5FE9394}.Debug|Any CPU.Build.0 = Debug|Any CPU
{11839CC5-F02B-4812-969A-52CDF5FE9394}.Release|Any CPU.ActiveCfg = Release|Any CPU
{11839CC5-F02B-4812-969A-52CDF5FE9394}.Release|Any CPU.Build.0 = Release|Any CPU
{1F4B5983-EA2E-4DAC-8E02-20C0CDA9FA93}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1F4B5983-EA2E-4DAC-8E02-20C0CDA9FA93}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1F4B5983-EA2E-4DAC-8E02-20C0CDA9FA93}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down Expand Up @@ -335,6 +327,14 @@ Global
{FB907DF7-F3F3-4A07-885D-E5FECAE36BDA}.Debug|Any CPU.Build.0 = Debug|Any CPU
{FB907DF7-F3F3-4A07-885D-E5FECAE36BDA}.Release|Any CPU.ActiveCfg = Release|Any CPU
{FB907DF7-F3F3-4A07-885D-E5FECAE36BDA}.Release|Any CPU.Build.0 = Release|Any CPU
{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7}.Release|Any CPU.Build.0 = Release|Any CPU
{8DABC11A-624E-4554-ACA4-D5B80146B9C6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8DABC11A-624E-4554-ACA4-D5B80146B9C6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8DABC11A-624E-4554-ACA4-D5B80146B9C6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8DABC11A-624E-4554-ACA4-D5B80146B9C6}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand All @@ -343,10 +343,8 @@ Global
{43CAFE52-F329-4431-87DA-7FEE1454D9A9} = {1A06E14B-DD2F-4536-9D2E-F708C0C43555}
{0112BD4F-B7A6-4E43-AB23-B6E961E27A49} = {824BD1DE-3FA8-4FE0-823A-FD365EAC78AF}
{E0F52FDB-23D1-4927-BAB8-332655DD7A0B} = {824BD1DE-3FA8-4FE0-823A-FD365EAC78AF}
{BAFDB2B7-A8D4-4725-81CB-F69A9C8A362A} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{09525C6C-68B7-405E-B476-23E64D91C11B} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{301BFB9F-6D73-4DEE-93D1-75F480816F63} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{11839CC5-F02B-4812-969A-52CDF5FE9394} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
{1F4B5983-EA2E-4DAC-8E02-20C0CDA9FA93} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
{5F10395B-DF38-438A-B5DB-5F6449184F67} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{BC839E07-108A-4184-B1F9-EF28A1E81088} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
Expand Down Expand Up @@ -386,6 +384,8 @@ Global
{72EBA81D-2933-417C-8F21-D4CFFD72F530} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
{F01E8C75-2791-4DBE-BD7A-5510871EBF56} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{FB907DF7-F3F3-4A07-885D-E5FECAE36BDA} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
{8A25B43D-BBB2-40FF-B0EB-33AACCD15AD7} = {22DF5DC0-1290-4E83-A9D8-6BB7DE3B3E63}
{8DABC11A-624E-4554-ACA4-D5B80146B9C6} = {2097345F-4DD3-477D-BC54-A922F9B2B402}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {B0816796-CDB3-47D7-8C3C-946434DE3B66}
Expand Down
11 changes: 0 additions & 11 deletions src/OpenTelemetry.Contrib.Exporter.Stackdriver/CHANGELOG.md

This file was deleted.

21 changes: 21 additions & 0 deletions src/OpenTelemetry.Exporter.Stackdriver/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Changelog

## Unreleased

## 1.0.0-beta.2

* Going forward the NuGet package will be
[`OpenTelemetry.Exporter.Stackdriver`](https://www.nuget.org/packages/OpenTelemetry.Exporter.Stackdriver).
Older versions will remain at
[`OpenTelemetry.Contrib.Exporter.Stackdriver`](https://www.nuget.org/packages/OpenTelemetry.Contrib.Exporter.Stackdriver).
[(#223)](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/223)

## 1.0.0-beta1

* Update OTel SDK package version to 1.1.0
* Log exceptions when failing to export data to stackdriver

## Initial Release

* Updated OTel SDK package version to 1.1.0-beta1
([#100](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/100))
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Contrib.Exporter.Stackdriver\OpenTelemetry.Contrib.Exporter.Stackdriver.csproj" />
<ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Exporter.Stackdriver\OpenTelemetry.Exporter.Stackdriver.csproj" />
</ItemGroup>

<ItemGroup>
Expand Down

0 comments on commit bf4af7a

Please sign in to comment.