Skip to content

Commit

Permalink
Update GDI Specification to 1.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Kielek committed Jan 21, 2025
1 parent 9584391 commit 97464ed
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ GitHub provides additional documentation on [forking a
repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull
request](https://help.github.com/articles/creating-a-pull-request/).

Before your contribution can be accepted, you will be asked to sign our
[Splunk Contributor License Agreement (CLA)](https://github.com/splunk/cla-agreement/blob/main/CLA.md).

## Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute
Expand All @@ -86,7 +89,3 @@ any 'help wanted' issues is a great place to start.

See the [LICENSE](LICENSE) file for our repository's licensing. We will ask you to
confirm the licensing of your contribution.

### Contributor License Agreement

Before contributing, you must sign the [Splunk Contributor License Agreement (CLA)](https://www.splunk.com/en_us/form/contributions.html).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![OpenTelemetry .NET](https://img.shields.io/badge/OTel-1.10.0-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet/releases/tag/core-1.10.0)
[![OpenTelemetry .NET Auto Instrumentation](https://img.shields.io/badge/OTelAuto-v1.10.0.beta.1-blueviolet)](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v1.10.0-beta.1)
[![Splunk GDI Specification](https://img.shields.io/badge/GDI-1.6.0-blueviolet)](https://github.com/signalfx/gdi-specification/releases/tag/v1.6.0)
[![Splunk GDI Specification](https://img.shields.io/badge/GDI-1.7.0-blueviolet)](https://github.com/signalfx/gdi-specification/releases/tag/v1.7.0)
[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-%23E05735)](CHANGELOG.md)
[![LICENSE](https://img.shields.io/github/license/signalfx/splunk-otel-dotnet)](LICENSE)

Expand Down
13 changes: 10 additions & 3 deletions docs/advanced-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ for configuration details.

## Splunk distribution configuration

## Manual installation
### Manual installation

Download and install the latest binaries from
[the latest release](https://github.com/signalfx/splunk-otel-dotnet/releases/latest).

> The path where you place the binaries is referenced as `$INSTALL_DIR` in this documentation.
## Manual instrumentation
### Manual instrumentation

When running your application, make sure to:

Expand Down Expand Up @@ -47,7 +47,7 @@ When running your application, make sure to:

> Some settings can be omitted on .NET. For more information, see the [documentation](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/v1.10.0-beta.1/docs/config.md#net-clr-profiler).
## Splunk plugin settings
### Splunk plugin settings

Note: .NET Framework apps can read settings also from `Web.config` and `App.config`.

Expand All @@ -64,3 +64,10 @@ Note: .NET Framework apps can read settings also from `Web.config` and `App.conf
based on the defined realm. If both `SPLUNK_REALM` and
`OTEL_EXPORTER_*_ENDPOINT` are set then `OTEL_EXPORTER_*_ENDPOINT` takes
precedence.

### Known differences to GDI Specification

This distribution follows [GDI Specification](https://github.com/signalfx/gdi-specification/blob/v1.7.0).
There is one known difference in the default configuration.
This package by default sets `OTEL_TRACES_SAMPLER`
to `parentbased_always_on` instead of `always_on`.

Check warning on line 73 in docs/advanced-config.md

View workflow job for this annotation

GitHub Actions / build

Unknown word (parentbased)

0 comments on commit 97464ed

Please sign in to comment.