-
Notifications
You must be signed in to change notification settings - Fork 508
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into dependabot/go_modules/tools/github.com/gol…
…angci/golangci-lint-1.27.0
- Loading branch information
Showing
18 changed files
with
91 additions
and
11 deletions.
There are no files selected for viewing
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,28 @@ | ||
| name: Dependabot-Tidier | ||
| on: | ||
| pull_request: | ||
| types: [ labeled ] | ||
|
|
||
| jobs: | ||
| mod_tidier: | ||
| if: ${{ contains(github.event.pull_request.labels.*.name, 'dependencies') }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| ref: ${{ github.head_ref }} | ||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: '^1.14.0' | ||
| - uses: evantorrie/mott-the-tidier@v1-beta | ||
| id: modtidy | ||
| with: | ||
| gomods: '**/go.mod' | ||
| gosum_only: true | ||
| - uses: stefanzweifel/git-auto-commit-action@v4 | ||
| id: autocommit | ||
| with: | ||
| commit_message: Auto-fix go.sum changes in dependent modules | ||
| - name: changes | ||
| run: | | ||
| echo "Changes detected: ${{ steps.autocommit.outputs.changes_detected }}" |
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 |
|---|---|---|
| @@ -1,7 +1,17 @@ | ||
| # opentelemetry-go-contrib | ||
| # OpenTelemetry-Go Contrib | ||
|
|
||
| This repo contains packages that facilitate instrumenting commonly | ||
| used libraries with OpenTelemetry for distributed tracing and | ||
| monitoring. | ||
| [](https://circleci.com/gh/open-telemetry/opentelemetry-go-contrib) | ||
| [](https://pkg.go.dev/go.opentelemetry.io/contrib) | ||
| [](https://goreportcard.com/report/go.opentelemetry.io/contrib) | ||
| [](https://gitter.im/open-telemetry/opentelemetry-go?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
|
|
||
| Collection of 3rd-party instrumentation and exporters for [OpenTelemetry-Go](https://github.com/open-telemetry/opentelemetry-go). | ||
|
|
||
| ## Contents | ||
|
|
||
| - [Instrumentation](./instrumentation/): Packages providing OpenTelemetry instrumentation for 3rd-party libraries. | ||
| - [Exporters](./exporters/): Packages providing OpenTelemetry exporters for 3rd-party telemetry systems. | ||
|
|
||
| ## Contributing | ||
|
|
||
| For information on how to contribute, consult [the contributing guidelines](./CONTRIBUTING.md) |
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 |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Instrumentation | ||
|
|
||
| Code contained in this directory contains instrumentation for 3rd-party Go packages. | ||
|
|
||
| ## Organization | ||
|
|
||
| In order to ensure the maintainability and discoverability of instrumentation packages, the following guidelines MUST be followed. | ||
|
|
||
| ### Packaging | ||
|
|
||
| All instrumentation packages MUST be of the form: | ||
|
|
||
| ``` | ||
| go.opentelemetry.io/contrib/instrumentation/{PACKAGE} | ||
| ``` | ||
|
|
||
| Where `{PACKAGE}` is the name of the package being instrumented. | ||
|
|
||
| For example: | ||
|
|
||
| - `go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux` | ||
| - `go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1` | ||
| - `go.opentelemetry.io/contrib/instrumentation/database/sql` | ||
|
|
||
| Consequentially, this means that all instrumentation MUST be contained in a sub-directory structure matching the package name. | ||
|
|
||
| ### Contents | ||
|
|
||
| All instrumentation packages MUST adhere to [the projects' contributing guidelines](../CONTRIBUTING.md). | ||
| Additionally the following guidelines for package composition need to be followed. | ||
|
|
||
| - All instrumentation packages MUST be a Go package. | ||
| Therefore, an appropriately configured `go.mod` and `go.sum` need to exist for each package. | ||
| - To help understand the instrumentation a Go package documentation SHOULD be included. | ||
| This documentation SHOULD be in a dedicated `doc.go` file if the package is more than one file. | ||
| It SHOULD contain useful information like what the purpose of the instrumentation is, how to use it, and any compatibility restrictions that might exist. | ||
| - Examples of how to actually use the instrumentation SHOULD be included. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
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