Skip to content

Commit

Permalink
Merge branch 'main' into jamie.node-disable-instrumentations
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieDanielson authored Jul 23, 2024
2 parents 0e4df3a + bf49f3a commit f80316b
Show file tree
Hide file tree
Showing 252 changed files with 2,138 additions and 963 deletions.
37 changes: 0 additions & 37 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -14,40 +14,3 @@

# Global owners, will be the owners for everything in the repo.
* @open-telemetry/docs-approvers

# content owners
content-modules/ @open-telemetry/docs-maintainers
content-modules/opamp-spec @open-telemetry/docs-maintainers @open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/opentelemetry-specification @open-telemetry/docs-maintainers @open-telemetry/specs-approvers
content-modules/semantic-conventions @open-telemetry/docs-maintainers @open-telemetry/specs-semconv-approvers
content/en/blog/ @open-telemetry/docs-maintainers
content/en/community/end-user/ @open-telemetry/docs-approvers @open-telemetry/sig-end-user-approvers
content/en/docs/collector @open-telemetry/docs-approvers @open-telemetry/collector-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
content/en/docs/demo @open-telemetry/docs-approvers @open-telemetry/demo-approvers
content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-telemetry/helm-approvers
content/en/docs/kubernetes/operator/ @open-telemetry/docs-approvers @open-telemetry/operator-approvers
content/en/docs/languages/cpp/ @open-telemetry/docs-approvers @open-telemetry/cpp-approvers
content/en/docs/languages/erlang/ @open-telemetry/docs-approvers @open-telemetry/erlang-approvers
content/en/docs/languages/go/ @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/languages/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/docs/languages/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/languages/ruby/ @open-telemetry/docs-approvers @open-telemetry/ruby-approvers @open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust/ @open-telemetry/docs-approvers @open-telemetry/rust-approvers
content/en/docs/languages/swift/ @open-telemetry/docs-approvers @open-telemetry/swift-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/zero-code/go @open-telemetry/docs-approvers @open-telemetry/go-approvers @open-telemetry/go-instrumentation-approvers
content/en/docs/zero-code/java/ @open-telemetry/docs-approvers @open-telemetry/java-approvers @open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js/ @open-telemetry/docs-approvers @open-telemetry/javascript-approvers
content/en/docs/zero-code/net/ @open-telemetry/docs-approvers @open-telemetry/dotnet-approvers @open-telemetry/dotnet-instrumentation-approvers
content/en/docs/zero-code/python/ @open-telemetry/docs-approvers @open-telemetry/python-approvers
content/en/docs/zero-code/php/ @open-telemetry/docs-approvers @open-telemetry/php-approvers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/zh/ @open-telemetry/docs-maintainers @open-telemetry/docs-zh-approvers
content/ja/ @open-telemetry/docs-maintainers @open-telemetry/docs-ja-approvers

4 changes: 4 additions & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ lang:ja:
- changed-files:
- any-glob-to-any-file:
- content/ja/**
lang:pt:
- changed-files:
- any-glob-to-any-file:
- content/pt/**
sig:cpp:
- changed-files:
- any-glob-to-any-file:
Expand Down
79 changes: 79 additions & 0 deletions .github/component-owners.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# This file is used to define the owners of the content modules in the OpenTelemetry repository.
components:
content-modules:
- open-telemetry/docs-maintainers
content-modules/opamp-spec:
- open-telemetry/docs-maintainers
- open-telemetry/opamp-spec-approvers
content-modules/opentelemetry-proto:
- open-telemetry/docs-maintainers
- open-telemetry/specs-approvers
content-modules/opentelemetry-specification:
- open-telemetry/docs-maintainers
- open-telemetry/specs-approvers
content-modules/semantic-conventions:
- open-telemetry/docs-maintainers
- open-telemetry/specs-semconv-approvers
content/en/blog:
- open-telemetry/docs-maintainers
content/en/community/end-user:
- open-telemetry/sig-end-user-approvers
content/en/docs/collector:
- open-telemetry/collector-approvers
content/en/docs/contributing:
- open-telemetry/docs-maintainers
content/en/docs/demo:
- open-telemetry/demo-approvers
content/en/docs/kubernetes/helm:
- open-telemetry/helm-approvers
content/en/docs/kubernetes/operator:
- open-telemetry/operator-approvers
content/en/docs/languages/cpp:
- open-telemetry/cpp-approvers
content/en/docs/languages/erlang:
- open-telemetry/erlang-approvers
content/en/docs/languages/go:
- open-telemetry/go-approvers
- open-telemetry/go-instrumentation-approvers
content/en/docs/languages/java:
- open-telemetry/java-approvers
- open-telemetry/java-instrumentation-approvers
content/en/docs/languages/js:
- open-telemetry/javascript-approvers
content/en/docs/languages/net:
- open-telemetry/dotnet-approvers
- open-telemetry/dotnet-instrumentation-approvers
content/en/docs/languages/php:
- open-telemetry/php-approvers
content/en/docs/languages/python:
- open-telemetry/python-approvers
content/en/docs/languages/ruby:
- open-telemetry/ruby-approvers
- open-telemetry/ruby-contrib-approvers
content/en/docs/languages/rust:
- open-telemetry/rust-approvers
content/en/docs/languages/swift:
- open-telemetry/swift-approvers
content/en/docs/security:
- open-telemetry/sig-security-maintainers
content/en/docs/specs:
- open-telemetry/specs-approvers
content/en/docs/zero-code/java:
- open-telemetry/java-approvers
- open-telemetry/java-instrumentation-approvers
content/en/docs/zero-code/js:
- open-telemetry/javascript-approvers
content/en/docs/zero-code/net:
- open-telemetry/dotnet-approvers
- open-telemetry/dotnet-instrumentation-approvers
content/en/ecosystem/demo:
- open-telemetry/demo-approvers
content/zh:
- open-telemetry/docs-maintainers
- open-telemetry/docs-zh-approvers
content/ja:
- open-telemetry/docs-maintainers
- open-telemetry/docs-ja-approvers
content/pt:
- open-telemetry/docs-maintainers
- open-telemetry/docs-pt-approvers
15 changes: 15 additions & 0 deletions .github/workflows/component-owners.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Component owners
on:
pull_request_target:

jobs:
run_self:
runs-on: ubuntu-latest
name: Assign component owners
permissions:
contents: read
pull-requests: write
steps:
- uses: dyladan/[email protected]
with:
config-file: .github/component-owners.yml
2 changes: 1 addition & 1 deletion content/en/blog/2022/debug-otel-with-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,5 +260,5 @@ COPY opentelemetry_module.conf /etc/nginx/conf.d
[v1.0.1 release of the otel-webserver-module]:
https://github.com/open-telemetry/opentelemetry-cpp-contrib/releases/tag/webserver%2Fv1.0.1
[java]:
/docs/zero-code/java/agent/configuration/#capturing-http-request-and-response-headers
/docs/zero-code/java/agent/instrumentation/http/#capturing-http-request-and-response-headers
[python]: /docs/zero-code/python/
4 changes: 0 additions & 4 deletions content/en/blog/2024/otel-errors/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,6 @@ message embedded within a span. Span events help enhance spans by providing
descriptive information about a span.
[Span events can also have attributes of their own](/docs/languages/ruby/instrumentation/#add-span-events).

When a span status is set to `Error`, a span event is created automatically,
capturing the span’s resulting error message and stack trace as an event on that
span. You can further enhance this span error by adding attributes to it.

Earlier, we mentioned a method called `RecordException`. Per
[the spec](/docs/specs/otel/trace/api/#record-exception) (emphasis our own), “To
facilitate recording an exception languages SHOULD provide a RecordException
Expand Down
43 changes: 43 additions & 0 deletions content/en/blog/2024/security-audit-results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: OpenTelemetry Security Audit Published
linkTitle: Security Audit Results
date: 2024-07-22
author: '[Austin Parker](https://github.com/austinlparker)'
issue:
sig: GC
---

Thousands of organizations and millions of users around the world rely on
[OpenTelemetry](/) as part of their observability toolkit. To this end, it is
our responsibility as a project to ensure our code is safe, secure, and
performant. In conjunction with [OSTIF](https://ostif.org/) and
[7ASecurity](https://7asecurity.com/), and the support of the
[Cloud Native Computing Foundation](https://www.cncf.io/), we recently engaged
upon a security audit of the OpenTelemetry Collector and four SDKs – Go, Java,
C#, and Python.

We are pleased to announce the publication of this audit, as well as its
results. One CVE was identified and remediated prior to the publication of this
audit (see [CVE-2024-36129](https://nvd.nist.gov/vuln/detail/CVE-2024-36129) for
information) in the OpenTelemetry Collector, and five hardening recommendations
were made. Overall, the results of the audit are very positive, with the
auditors noting the high quality of source code and the security best practices
that the project is following.

The conclusion of this audit marks an important milestone on our journey towards
the next stage of maturity in the CNCF, graduation. We’ll have more to share on
that in the coming months. The OpenTelemetry Governance Committee and Security
SIG would also like to personally commend the contributors and maintainers of
OpenTelemetry for their high-quality work over the years.

Finally, we would like to thank the following individuals and groups:

- SIG Security
- SIG Collector
- 7ASecurity
- OSTIF

You can read more about the audit on the
[OSTIF](https://www.ostif.org/otel-audit-complete/) and 7A Security blogs, or
read the
[full report](https://7asecurity.com/reports/pentest-report-opentelemetry.pdf).
2 changes: 1 addition & 1 deletion content/en/docs/collector/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Collector
description: Vendor-agnostic way to receive, process and export telemetry data.
aliases: [collector/about]
cascade:
vers: 0.104.0
vers: 0.105.0
weight: 270
---

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/collector/internal-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ categorized by instrumentation type.

| Metric name | Description | Type |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------- | --------- |
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of spans that exporter(s) failed to enqueue. | Counter |
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter |
| `otelcol_exporter_enqueue_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter |
| `otelcol_exporter_enqueue_failed_`<br>`spans` | Number of spans that exporter(s) failed to enqueue. | Counter |
| `otelcol_exporter_queue_capacity` | Fixed capacity of the retry queue, in batches. | Gauge |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/faas/lambda-auto-instrument.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ variables:
instrumentations, see [Suppressing specific agent instrumentation][1].

[1]:
/docs/zero-code/java/agent/configuration/#suppressing-specific-agent-instrumentation
/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation

For example, to only enable auto-instrumentation for Lambda and the AWS SDK, you
would set the following environment variables:
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/kubernetes/operator/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Therefore, the example uses `http://demo-collector:4318`, which connects to the
#### Excluding auto-instrumentation {#java-excluding-auto-instrumentation}

By default, the Java auto-instrumentation ships with
[many instrumentation libraries](/docs/zero-code/java/agent/#supported-libraries-frameworks-application-services-and-jvms).
[many instrumentation libraries](/docs/zero-code/java/agent/getting-started/#supported-libraries-frameworks-application-services-and-jvms).
This makes instrumentation easy, but could result in too much or unwanted data.
If there are any libraries you do not want to use you can set the
`OTEL_INSTRUMENTATION_[NAME]_ENABLED=false` where `[NAME]` is the name of the
Expand All @@ -221,7 +221,7 @@ the default libraries by setting
`OTEL_INSTRUMENTATION_COMMON_DEFAULT_ENABLED=false` and then use
`OTEL_INSTRUMENTATION_[NAME]_ENABLED=true` where `[NAME]` is the name of the
library. For more details, see
[Suppressing specific instrumentation](/docs/zero-code/java/agent/configuration/#suppressing-specific-instrumentation).
[Suppressing specific instrumentation](/docs/zero-code/java/agent/disable/).

```yaml
apiVersion: opentelemetry.io/v1alpha1
Expand Down
11 changes: 4 additions & 7 deletions content/en/docs/languages/go/instrumentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -1063,13 +1063,12 @@ Now that a `LoggerProvider` is configured, you can use it to set up a

A log bridge is a component that bridges logs from an existing log package into
the OpenTelemetry [Log SDK](#logs-sdk) using the [Logs Bridge
API][logs bridge API]. Log bridges are available for various popular Go log
packages:
API][logs bridge API].

- [logrus bridge][otellogrus]
- [slog bridge][otelslog]
A full list of log bridges available can be found in the
[OpenTelemetry registry](/ecosystem/registry/?language=go&component=log-bridge).

The links above contain full usage and installation documentation.
Each log bridge package documentation should have a usage example.

### Via file or stdout

Expand Down Expand Up @@ -1097,8 +1096,6 @@ telemetry backends.
https://github.com/open-telemetry/opentelemetry-collector
[logs bridge API]: /docs/specs/otel/logs/bridge-api
[log data model]: /docs/specs/otel/logs/data-model
[otellogrus]: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otellogrus
[otelslog]: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otelslog
[`go.opentelemetry.io/otel`]: https://pkg.go.dev/go.opentelemetry.io/otel
[`go.opentelemetry.io/otel/exporters/stdout/stdoutmetric`]:
https://pkg.go.dev/go.opentelemetry.io/otel/exporters/stdout/stdoutmetric
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 @@ -6,7 +6,7 @@ description: >-
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.5.0
instrumentation: 2.6.0
otel: 1.40.0
semconv: 1.26.0
weight: 18
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ For more:
[metrics]: /docs/concepts/signals/metrics/
[logs]: /docs/concepts/signals/logs/
[annotations]: /docs/zero-code/java/agent/annotations/
[configure the java agent]: /docs/zero-code/java/agent/#configuring-the-agent
[configure the java agent]: /docs/zero-code/java/agent/configuration/
[console exporter]:
https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#logging-exporter
[exporter]:
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/languages/java/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ in order to generate telemetry data for a library or framework.
The Java agent for automatic instrumentation includes instrumentation libraries
for many common Java frameworks. Most are turned on by default. If you need to
turn off certain instrumentation libraries, you can
[suppress them](/docs/zero-code/java/agent/configuration/#suppressing-specific-instrumentation).
[suppress them](/docs/zero-code/java/agent/disable/).

If you use [code-based instrumentation](../instrumentation), you can leverage
some instrumentation libraries for your dependencies standalone. To find out
Expand Down
Loading

0 comments on commit f80316b

Please sign in to comment.