Skip to content

Commit

Permalink
Merge branch 'main' into cartermp-patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
svrnm authored Apr 15, 2024
2 parents 1499bd5 + 878d4be commit 716cf21
Show file tree
Hide file tree
Showing 342 changed files with 2,098 additions and 783 deletions.
2 changes: 2 additions & 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 Expand Up @@ -170,3 +171,4 @@ words:
- WSGI
- zend
- zipkin
- Chronosphere
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
13 changes: 7 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/cncf/docsy.git
docsy-pin = v0.9.1
docsy-reminder = "Ensure that all tags from google/docsy are also present in cncf/docsy, otherwise add (push) them."
url = https://github.com/google/docsy.git
docsy-pin = v0.9.1-17-gb077a74
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
spec-pin = v1.30.0
spec-pin = v1.32.0
[submodule "content-modules/community"]
path = content-modules/community
url = https://github.com/open-telemetry/community
community-pin = f16a58e
[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/opentelemetry-specification
Submodule opentelemetry-specification updated 38 files
+13 −0 .github/ISSUE_TEMPLATE/profiling.md
+0 −51 .github/ISSUE_TEMPLATE/project.md
+0 −12 .github/workflows/auto-assign-issue.yml
+135 −0 CHANGELOG.md
+1 −1 package.json
+47 −53 spec-compliance-matrix.md
+26 −0 specification/baggage/api.md
+34 −2 specification/common/README.md
+2 −2 specification/common/mapping-to-non-otlp.md
+87 −50 specification/compatibility/prometheus_and_openmetrics.md
+20 −6 specification/configuration/file-configuration.md
+76 −28 specification/configuration/sdk-environment-variables.md
+4 −4 specification/glossary.md
+1 −1 specification/logs/README.md
+5 −4 specification/logs/bridge-api.md
+10 −12 specification/logs/data-model.md
+58 −56 specification/logs/event-api.md
+82 −0 specification/logs/event-sdk.md
+80 −14 specification/logs/sdk.md
+8 −0 specification/logs/sdk_exporters/README.md
+2 −2 specification/logs/sdk_exporters/stdout.md
+1 −1 specification/logs/supplementary-guidelines.md
+11 −14 specification/metrics/api.md
+7 −2 specification/metrics/data-model.md
+7 −38 specification/metrics/metric-requirement-level.md
+108 −40 specification/metrics/sdk.md
+1 −1 specification/metrics/sdk_exporters/in-memory.md
+1 −1 specification/metrics/sdk_exporters/otlp.md
+35 −18 specification/metrics/sdk_exporters/prometheus.md
+1 −1 specification/metrics/sdk_exporters/stdout.md
+46 −52 specification/overview.md
+4 −4 specification/protocol/file-exporter.md
+3 −5 specification/trace/api.md
+68 −5 specification/trace/sdk.md
+0 −166 specification/trace/sdk_exporters/jaeger.md
+1 −1 specification/trace/sdk_exporters/stdout.md
+2 −2 specification/trace/tracestate-probability-sampling.md
+12 −4 specification/versioning-and-stability.md
2 changes: 1 addition & 1 deletion content-modules/semantic-conventions
2 changes: 1 addition & 1 deletion content/en/blog/2023/kubecon-na.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Join us for OpenTelemetry Talks and Activities at KubeCon NA 2023
linkTitle: KubeCon NA '23
date: 2023-10-02
# prettier-ignore
cSpell:ignore: Anusha Aronoff Benedikt Bongartz Broadbridge Chronosphere Contribfest Coralogix Danielson Endo Flamegraphs Hrabovcak Itiel Itoh Jaglowski Kanal Komodor Kota Masanori Matej Mirabella Narapureddy observ Ohly Pivotto Purvi Reddy Sharone Shishi Shivanshu Shrivastava Shwartz Zitzman
cSpell:ignore: Anusha Aronoff Benedikt Bongartz Broadbridge Contribfest Coralogix Danielson Endo Flamegraphs Hrabovcak Itiel Itoh Jaglowski Kanal Komodor Kota Masanori Matej Mirabella Narapureddy observ Ohly Pivotto Purvi Reddy Sharone Shishi Shivanshu Shrivastava Shwartz Zitzman
author: '[Severin Neumann](https://github.com/svrnm) (Cisco)'
---

Expand Down
4 changes: 3 additions & 1 deletion content/en/blog/2024/kubecon-eu.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,10 @@ Time (CET).
[End User Feedback Session - Semantic Conventions](https://calendly.com/euwg-user-feedback-session/end-user-feedback-session-semantic-conventions?month=2024-03)
- **March 21st, 14:30-15:30:**
[End User Feedback Session - Comms (website, docs)](https://calendly.com/euwg-user-feedback-session/end-user-feedback-session-comms?month=2024-03)
- **March 21th, 15:00-16:00:**
- **March 21st, 15:00-16:00:**
[End User Feedback Session - Profiling](https://calendly.com/euwg-user-feedback-session/end-user-feedback-session-profiling?month=2024-03)
- **March 21st, 15:30-16:30:**
[End User Feedback Session - Client-side](https://calendly.com/euwg-user-feedback-session/end-user-feedback-session-client-side)

A maximum of 5 participants will join one SIG maintainer to provide feedback for
that SIG. Sessions will be recorded and posted on the
Expand Down
126 changes: 126 additions & 0 deletions content/en/blog/2024/profiling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
title: OpenTelemetry announces support for profiling
linkTitle: Profiling support
date: 2024-03-19
author: '[Austin Parker](https://github.com/austinlparker) (Honeycomb)'
aliases: [opentelemetry-announced-support-for-profiling]
cSpell:ignore: Alexandrov Alexey Dmitry Filimonov Geisendörfer Halliday
---

In 2023, OpenTelemetry announced that it achieved stability for
[logs, metrics, and traces](https://www.cncf.io/blog/2023/11/07/opentelemetry-at-kubecon-cloudnativecon-north-america-2023-update/).
While this was our initial goal at the formation of the project, fulfilling our
vision of enabling built-in observability for cloud native applications requires
us to continue evolving with the community. This year, we’re proud to announce
that exactly two years after the Profiling SIG was created at KubeCon +
CloudNativeCon Europe 2022 in Valencia, we’re taking a big step towards this
goal by merging a profiling data model OTEP and working towards a stable spec
and implementation this year!

This milestone for the OpenTelemetry profiling signal reflects a collaborative
effort within the profiling SIG, where dedicated input from a diverse range of
profiling vendors and end users has been pivotal. This includes substantial
contributions from community members such as:

- Felix Geisendörfer (Datadog)
- Alexey Alexandrov (Google)
- Dmitry Filimonov (Grafana Labs)
- Ryan Perry (Grafana Labs)
- Jonathan Halliday (Red Hat)

The SIG's collective endeavor has been focused on aligning on the most suitable
data format for profiling, evidenced by the active discussions and proposals
within the community.

Some previous milestones reached before this point have been:

- Establishing
[profiling vision alignment](https://github.com/open-telemetry/oteps/pull/212)
(August 2022)
- Proposing
[v1 profiling data model](https://github.com/open-telemetry/oteps/pull/237)
(September 2023)
- Proposing
[v2 profiling data model](https://github.com/open-telemetry/oteps/pull/239)
(November 2023)

These all have played a crucial role in shaping the direction and evolution of
OpenTelemetry's profiling capabilities. These community-led discussions and
contributions underscore the project's commitment to being inclusive and
collaboration, ensuring that a broad spectrum of insights and expertise is
leveraged to drive the development of OpenTelemetry.

## What is profiling?

Profiling is a method to dynamically inspect the behavior and performance of
application code at run-time. Continuous profiling gives insights into resource
utilization at a code-level and allows for this profiling data to be stored,
queried, and analyzed over time and across different attributes. It’s an
important technique for developers and performance engineers to understand
exactly what’s happening in their code. OpenTelemetry’s
[profiling signal](https://github.com/open-telemetry/oteps/blob/main/text/profiles/0239-profiles-data-model.md)
expands upon the work that has been done in this space and, as a first for the
industry, connects profiles with other telemetry signals from applications and
infrastructure. This allows developers and operators to correlate resource
exhaustion or poor user experience across their services with not just the
specific service or pod being impacted, but the function or line of code most
responsible for it.

We’re thrilled to see the embrace of this vision by the industry, with many
organizations coming together to help define the profiling signal. More
specifically, the following two donations are in play:

- Elastic has
[pledged to donate](https://github.com/open-telemetry/community/issues/1918)
their proprietary eBPF-based profiling agent [^1]
- Splunk has begun the process of
[donating their .NET based profiler](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/pull/3196)

These are being donated to the project in order to accelerate the delivery and
implementation of OpenTelemetry profiling.

## What does this mean for users?

Profiles will support bi-directional links between themselves and other signals,
such as logs, metrics, and traces. You’ll be able to easily jump from resource
telemetry to a corresponding profile. For example:

- Metrics to profiles: You will be able to go from a spike in CPU usage or
memory usage to the specific pieces of the code which are consuming that
resource
- Traces to profiles: You will be able to understand not just the location of
latency across your services, but when that latency is caused by pieces of the
code it will be reflected in a profile attached to a trace or span
- Logs to profiles: Logs often give the context that something is wrong, but
profiling will allow you to go from just tracking something (Out Of Memory
errors, for example) to seeing exactly which parts of the code are using up
memory resources

These are just a few and these links work the opposite direction as well, but
more generally profiling helps deliver on the promise of observability by making
it easier for users to query and understand an entire new dimension about their
applications with minimal additional code/effort.

## A community in motion

This work would not be possible without the dedicated contributors who work on
OpenTelemetry each day. We’ve recently passed a new milestone, with over 1000
unique developers contributing to the project each month, representing over 180
companies. Across our most popular repositories, OpenTelemetry sees over 30
million downloads a month[^2], and new open source projects are adopting our
standards at a regular pace, including
[Apache Kafka](https://cwiki.apache.org/confluence/display/KAFKA/KIP-714%3A+Client+metrics+and+observability),
and [dozens more](/ecosystem/integrations). We’re also deepening our
integrations with other open source projects in CNCF and out, such as
[OpenFeature](https://openfeature.dev) and
[OpenSearch](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/23611),
in addition to our existing integrations with Kubernetes, Thanos, Knative, and
many more.

2024 promises to be another big year for OpenTelemetry as we continue to
implement and stabilize our existing tracing, metrics, and log signals while
adding support for profiling, client-side RUM, and more. It’s a great time to
get involved – check out our [website](https://opentelemetry.io) to learn more!

[^1]: Pending due diligence and review by the OpenTelemetry maintainers.
[^2]: According to public download statistics of our .NET, Java, and Python APIs
Loading

0 comments on commit 716cf21

Please sign in to comment.