Skip to content

Commit

Permalink
Merge branch 'main' into add-embrace-vendor-list
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm authored Apr 8, 2024
2 parents 0e4a73d + 97afffa commit 9e1ebe7
Show file tree
Hide file tree
Showing 99 changed files with 334 additions and 235 deletions.
1 change: 1 addition & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ version: '0.2'
caseSensitive: true
ignorePaths:
- '*.svg'
- 'vendors.yaml'
# words here are only listed for their spelling, if there is a certain way
# to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs
# cloud-native), edit the text-lint rules in .textlintrc.yml
Expand Down
23 changes: 16 additions & 7 deletions .github/workflows/check-text.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Make sure that we only install the dependencies for textlint to speed up install
- run: |
- name: Create and use reduced-dependencies package.json
run: |
mkdir -p tmp
jq '.devDependencies |= with_entries( select(.key | startswith("textlint")))
| del(.dependencies, .optionalDependencies)' \
package.json > tmp/package-min.json
cp tmp/package-min.json package.json
package.json > tmp/package-ci.json
cp tmp/package-ci.json package.json
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: tmp/package-ci.json
- run: npm install --ignore-scripts --omit=optional
- run: .github/workflows/scripts/textlint.sh

Expand All @@ -24,15 +29,19 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Create and use reduced-dependencies package.json
run: |
mkdir -p tmp
jq '.devDependencies |= with_entries(
select(.key | test("gulp|markdown|through|require|yargs"))
)
| del(.dependencies, .optionalDependencies)' \
package.json > tmp/package-min.json
cp tmp/package-min.json package.json
package.json > tmp/package-ci.json
cp tmp/package-ci.json package.json
- uses: actions/setup-node@v4
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: tmp/package-ci.json
- run: npm install --ignore-scripts --omit=optional
- run: npm run check:markdown
2 changes: 1 addition & 1 deletion .github/workflows/pr-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
pull-requests: write

env:
DEPTH: --depth 100 # submodule clone depth
DEPTH: --depth 1000 # submodule clone depth

steps:
- name: Extract action name
Expand Down
9 changes: 5 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/cncf/docsy.git
url = https://github.com/google/docsy.git
docsy-pin = v0.9.1-17-gb077a74
docsy-reminder = "Ensure that all tags from google/docsy are also present in cncf/docsy, otherwise add (push) them."
docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
[submodule "content-modules/opentelemetry-specification"]
path = content-modules/opentelemetry-specification
url = https://github.com/open-telemetry/opentelemetry-specification.git
Expand All @@ -14,11 +15,11 @@
[submodule "content-modules/opentelemetry-proto"]
path = content-modules/opentelemetry-proto
url = https://github.com/open-telemetry/opentelemetry-proto
otlp-pin = v1.1.0
otlp-pin = v1.2.0
[submodule "content-modules/semantic-conventions"]
path = content-modules/semantic-conventions
url = https://github.com/open-telemetry/semantic-conventions
semconv-pin = v1.24.0
semconv-pin = v1.25.0
[submodule "content-modules/opamp-spec"]
path = content-modules/opamp-spec
url = https://github.com/open-telemetry/opamp-spec
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ PR shortly or let maintainers now if you run into any blockers.
## Contributor's guide

To learn how to contribute fixes and new content to this project, read the
[Contributor's guide](/content/en/docs/contributing), which includes a style
guide and useful information on the review process.
[Contributor's guide](https://opentelemetry.io/docs/contributing/), which
includes a style guide and useful information on the review process.

## Development

Expand Down
2 changes: 1 addition & 1 deletion content-modules/semantic-conventions
3 changes: 2 additions & 1 deletion content/en/docs/collector/building/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ pipeline and send it to the metrics pipeline. Historically, some processors
transmitted data by making use of a work-around that follows a bad practice
where a processor directly exports data after processing. The connector
component solves the need for this work-around and the processors that used the
work around have been deprecated.
work around have been deprecated. On the same line, above mentioned processors
are also now deprecated in recent releases and are replaced by the connectors.

Additional details about the connector's full capabilities can be found at the
following links:
Expand Down
3 changes: 0 additions & 3 deletions content/en/docs/collector/deployment/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ Let's have a look at such a case where we are using the load-balancing exporter:
signals to a group of collectors.
3. The collectors are configured to send telemetry data to one or more backends.

{{% alert title="Note" color="info" %}} Currently, the load-balancing exporter
only supports pipelines of the `traces` type. {{% /alert %}}

## Examples

### NGINX as an "out-of-the-box" load balancer
Expand Down
5 changes: 3 additions & 2 deletions content/en/docs/demo/scenarios/recommendation-cache/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ traces to determine the cause of a memory leak.
## Setup

To run this scenario, you will need to deploy the demo application and enable
the `recommendationCache` feature flag. Let the application run for about 10
minutes or so after enabling the feature flag to allow for data to populate.
the `recommendationServiceCacheFailure` feature flag. Let the application run
for about 10 minutes or so after enabling the feature flag to allow for data to
populate.

## Diagnosis

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/go/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ docker run -d --name jaeger \
jaegertracing/all-in-one:latest
```

### OTLP metrics over HTTP (Experimental)
### OTLP metrics over HTTP

[`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp)
contains an implementation of OTLP metrics exporter using HTTP with binary
Expand All @@ -129,7 +129,7 @@ func newExporter(ctx context.Context) (metric.Exporter, error) {
}
```

### OTLP metrics over gRPC (Experimental)
### OTLP metrics over gRPC

[`go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc)
contains an implementation of OTLP metrics exporter using gRPC.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.2.0
otel: 1.36.0
otel: 1.37.0
semconv: 1.24.0
weight: 18
---
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/net/automatic/nuget-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To automatically instrument your application with OpenTelemetry .NET add the
`OpenTelemetry.AutoInstrumentation` package to your project:

```terminal
dotnet add [<PROJECT>] package OpenTelemetry.AutoInstrumentation --prerelease
dotnet add [<PROJECT>] package OpenTelemetry.AutoInstrumentation
```

If the application references packages that can be instrumented, but, require
Expand All @@ -46,7 +46,7 @@ you to either add the missing instrumentation package or to skip the
instrumentation of the corresponding package:

```terminal
~packages/opentelemetry.autoinstrumentation.buildtasks/1.0.0-rc.1/build/OpenTelemetry.AutoInstrumentation.BuildTasks.targets(29,5): error : OpenTelemetry.AutoInstrumentation: add a reference to the instrumentation package 'MongoDB.Driver.Core.Extensions.DiagnosticSources' version 1.3.0 or add 'MongoDB.Driver.Core' to the property 'SkippedInstrumentations' to suppress this error.
~packages/opentelemetry.autoinstrumentation.buildtasks/1.4.0/build/OpenTelemetry.AutoInstrumentation.BuildTasks.targets(29,5): error : OpenTelemetry.AutoInstrumentation: add a reference to the instrumentation package 'MongoDB.Driver.Core.Extensions.DiagnosticSources' version 1.3.0 or add 'MongoDB.Driver.Core' to the property 'SkippedInstrumentations' to suppress this error.
```

To resolve the error either add the recommended instrumentation package or skip
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/python/automatic/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ instrumentor.instrument_app(app, excluded_urls="/server_request")
```

After running the example again, no instrumentation should appear on the server
side. This is because or the `excluded_urls` option passed to `instrument_app`
side. This is because of the `excluded_urls` option passed to `instrument_app`
that effectively stops the `server_request` function from being instrumented as
its URL matches the regular expression passed to `excluded_urls`.

Expand Down
5 changes: 5 additions & 0 deletions data/ecosystem/integrations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,8 @@
docsUrl: https://clickhouse.com/docs/en/operations/opentelemetry
components: [C++]
oss: true
- name: FluentCI Engine
url: https://github.com/fluentci-io/fluentci-engine
docsUrl: https://github.com/fluentci-io/fluentci-engine#-opentelemetry-tracing
components: [Rust]
oss: true
Loading

0 comments on commit 9e1ebe7

Please sign in to comment.