Skip to content

Commit

Permalink
Merge branch 'main' into add-matlab-to-registry
Browse files Browse the repository at this point in the history
  • Loading branch information
duncanpo authored May 14, 2024
2 parents 3560c62 + b405c8e commit 4cf1b29
Show file tree
Hide file tree
Showing 434 changed files with 3,826 additions and 1,083 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ content-modules/opentelemetry-proto @open-telemetry/docs-maintainers @open-
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/end-user-wg
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/demo @open-telemetry/docs-approvers @open-telemetry/demo-approvers
content/en/docs/languages/cpp/ @open-telemetry/docs-approvers @open-telemetry/cpp-approvers
Expand All @@ -41,4 +41,4 @@ content/en/docs/kubernetes/helm/ @open-telemetry/docs-approvers @open-te
content/en/docs/specs/ @open-telemetry/docs-approvers @open-telemetry/specs-approvers
content/en/docs/security/ @open-telemetry/docs-approvers @open-telemetry/sig-security-maintainers
content/en/ecosystem/demo/ @open-telemetry/demo-approvers @open-telemetry/demo-approvers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
content/en/docs/contributing/ @open-telemetry/docs-approvers @open-telemetry/docs-maintainers
76 changes: 76 additions & 0 deletions .github/component-label-map.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
blog:
- changed-files:
- any-glob-to-any-file:
- content/en/blog/**
sig:cpp:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/cpp/**
sig:erlang:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/erlang/**
sig:go:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/go/**
sig:java:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/java/**
sig:js:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/js/**
sig:dotnet:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/net/**
sig:php:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/php/**
sig:python:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/python/**
sig:ruby:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/ruby/**
sig:rust:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/rust/**
sig:swift:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/languages/swift/**
sig:operator:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/kubernetes/operator/**
sig:helm:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/kubernetes/helm/**
sig:security:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/security/**
sig:demo:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/demo/**
sig:collector:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/collector/**
sig:enduser:
- changed-files:
- any-glob-to-any-file:
- content/en/community/end-user/**
sig:spec:
- changed-files:
- any-glob-to-any-file:
- content/en/docs/specs/**
16 changes: 16 additions & 0 deletions .github/workflows/label-prs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: 'Label PR'
on:
- pull_request_target

jobs:
labeler:
name: 'Add component labels'
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/labeler@v5
with:
configuration-path: '.github/component-label-map.yml'
6 changes: 3 additions & 3 deletions .github/workflows/pr-actions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ jobs:
run: |
gh pr comment $PR_NUM -b "You triggered fix:${PR_ACTION} action run at $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID"
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

- run: gh pr checkout $PR_NUM -b "pr-action-${RANDOM}"
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}

- name: Create NPM cache-hash input file
run: |
Expand Down Expand Up @@ -106,4 +106,4 @@ jobs:
run: |
gh pr comment $PR_NUM -b "fix:${PR_ACTION} run failed, please check $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID for details"
env:
GH_TOKEN: ${{ github.token }}
GH_TOKEN: ${{ secrets.OPENTELEMETRYBOT_GITHUB_TOKEN }}
8 changes: 4 additions & 4 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
[submodule "themes/docsy"]
path = themes/docsy
url = https://github.com/google/docsy.git
docsy-pin = v0.9.1-17-gb077a74
docsy-pin = v0.10.0-2-g6f7e81d
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.31.0
spec-pin = v1.33.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.2.0
otlp-pin = v1.3.1
[submodule "content-modules/semantic-conventions"]
path = content-modules/semantic-conventions
url = https://github.com/open-telemetry/semantic-conventions
semconv-pin = v1.25.0
[submodule "content-modules/opamp-spec"]
path = content-modules/opamp-spec
url = https://github.com/open-telemetry/opamp-spec
opamp-pin = v0.8.0-5-g0360da8
opamp-pin = v0.9.0-2-g950df29
[submodule "content-modules/opentelemetry-go"]
path = content-modules/opentelemetry-go
url = https://github.com/open-telemetry/opentelemetry-go
Expand Down
3 changes: 3 additions & 0 deletions .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ DirectoryPath: public
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreCanonicalBrokenLinks: false
IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.com/google/docsy/issues/1995
CheckMailto: false
TestFilesConcurrently: true
IgnoreDirs:
Expand Down Expand Up @@ -35,6 +36,8 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^https://x.com
# OTel Google calendar - curl returns 200, but the link checker gets a 401:
- ^https://calendar.google.com/calendar/embed\?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com
# YouTube playlists sometimes give a 404, although they give a 200 when accessed via browser:
- ^https://www.youtube.com/playlist\?list=

# Ignore Docsy-generated GitHub links for now
- ^https?://github\.com/.*?/.*?/(new|edit)/ # view-page, edit-source etc
Expand Down
5 changes: 5 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@
/layouts/shortcodes/*
!/layouts/shortcodes/docs

# Ignore all languages other than en for now

/content/*
!/content/en

# Ignore content-modules except for published Community pages

/content-modules/*
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Check out the [OpenTelemetry community calendar][] for the Zoom link and any
updates to this schedule.

Meeting notes are available as a public [Google doc][]. If you have trouble
accessing the doc, get in touch on [Slack][].
accessing the doc, get in touch in the `#otel-comms` channel on [Slack][].

Here is a list of community roles with current and previous members:

Expand Down Expand Up @@ -94,4 +94,4 @@ already contributed][contributors]!
https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[google doc]:
https://docs.google.com/document/d/1wW0jLldwXN8Nptq2xmgETGbGn9eWP8fitvD5njM-xZY/edit?usp=sharing
[slack]: https://cloud-native.slack.com/archives/C02UN96HZH6
[slack]: https://slack.cncf.io/
28 changes: 0 additions & 28 deletions assets/scss/_registry.scss
Original file line number Diff line number Diff line change
Expand Up @@ -39,31 +39,3 @@
.registry-entry {
@extend .shadow;
}

// fix me: the registry seems not to load the main.min.css with the extended
// styles, so we need to define the styles here again.
.highlight {
margin: 1rem 0;
padding: 0;
position: relative;
max-width: 95%;
border: var(--bs-card-border-width) solid var(--bs-card-border-color);
border-radius: var(--bs-card-border-radius);
& pre {
padding: 1rem;
margin: 0;
display: block;
text-align: right;
overflow-y: auto;
& button.td-click-to-copy {
position: absolute;
color: #ced4da;
border-radius: 3px;
border-width: 0;
background-color: inherit;
box-shadow: 1px 1px #ced4da;
right: 4px;
top: 2px;
}
}
}
6 changes: 4 additions & 2 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
@import 'registry';
@import 'tabs';
@import 'external_link';
@import 'td/code-dark';

.td-home {
.otel-logo {
Expand Down Expand Up @@ -135,11 +136,12 @@
width: 100%;
position: fixed;
margin-left: -15px;
z-index: 32;
z-index: 31;
top: 4rem;
}

background: $gray-100;
background: var(--td-pre-bg);
color: var(--bs-body-color);
text-align: center;

& p {
Expand Down
2 changes: 1 addition & 1 deletion content-modules/opamp-spec
2 changes: 1 addition & 1 deletion content-modules/opentelemetry-specification
Submodule opentelemetry-specification updated 37 files
+13 −0 .github/ISSUE_TEMPLATE/profiling.md
+0 −51 .github/ISSUE_TEMPLATE/project.md
+0 −12 .github/workflows/auto-assign-issue.yml
+0 −14 .github/workflows/checks.yaml
+122 −0 CHANGELOG.md
+0 −7 docfx.json
+37 −43 spec-compliance-matrix.md
+2 −3 specification/README.md
+4 −3 specification/common/README.md
+2 −2 specification/common/mapping-to-non-otlp.md
+87 −50 specification/compatibility/prometheus_and_openmetrics.md
+138 −22 specification/configuration/file-configuration.md
+76 −28 specification/configuration/sdk-environment-variables.md
+4 −4 specification/glossary.md
+6 −0 specification/logs/README.md
+10 −1 specification/logs/bridge-api.md
+5 −0 specification/logs/data-model-appendix.md
+13 −10 specification/logs/data-model.md
+5 −0 specification/logs/event-api.md
+82 −14 specification/logs/sdk.md
+1 −1 specification/logs/sdk_exporters/stdout.md
+2 −0 specification/logs/supplementary-guidelines.md
+17 −2 specification/metrics/api.md
+7 −0 specification/metrics/data-model.md
+7 −38 specification/metrics/metric-requirement-level.md
+5 −0 specification/metrics/noop.md
+89 −16 specification/metrics/sdk.md
+1 −1 specification/metrics/sdk_exporters/in-memory.md
+5 −1 specification/metrics/sdk_exporters/otlp.md
+35 −18 specification/metrics/sdk_exporters/prometheus.md
+1 −1 specification/metrics/sdk_exporters/stdout.md
+2 −2 specification/protocol/file-exporter.md
+3 −2 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
3 changes: 3 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: >-
High-quality, ubiquitous, and portable telemetry to enable effective
observability
show_banner: true
outputs:
- HTML
- REDIRECTS # Include this `content/en` ONLY
developer_note:
The blocks/cover shortcode (used below) will use as a background image any
image file containing "background" in its name.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
97 changes: 97 additions & 0 deletions content/en/blog/2024/collector-roadmap/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: The roadmap to v1 for the OpenTelemetry Collector
linkTitle: Collector Roadmap
date: 2024-05-06
# prettier-ignore
cSpell:ignore: Antipatterns Boten Broadbridge Helmuth Hrabovcak Ishan Jaglowski OTTL Pantuza pushback Shishi Vijay
author: '[Alex Boten](https://github.com/codeboten) (Honeycomb)'
---

The [OpenTelemetry Collector](/docs/collector/) is a very popular component in
OpenTelemetry that has been under heavy development for quite some time. It is a
binary that allows many formats of telemetry to be sent to it, transformed, and
emitted to a destination. Much has been said about the Collector over the past
few years in various blog posts and talks. Here's a small list of talks about
the Collector if you haven't had the chance to learn about it:

- [Connected Observability Pipelines in the OpenTelemetry Collector - Dan Jaglowski](https://www.youtube.com/watch?v=uPpZ23iu6kI)
- [OpenTelemetry Collector Antipatterns - Adriana Villela](/blog/2024/otel-collector-anti-patterns/)
- [Telemetry Showdown: Fluent Bit Vs. OpenTelemetry Collector - Henrik Rexed](https://www.youtube.com/watch?v=ykq1F_3PmJw)
- [OpenTelemetry Collector Deployment Patterns - Juraci Kröhling](https://www.youtube.com/watch?v=WhRrwSHDBFs)
- [OTTL Me Why Transforming Telemetry in the OpenTelemetry Collector Just Got Better - Tyler Helmuth & Evan Bradley](https://www.youtube.com/watch?v=uVs0oUV72CE)
- [Manage OpenTelemetry Collectors at scale with Ansible - Ishan Jain](/blog/2024/scaling-collectors/)

The Collector has been a core component for organizations looking to adopt
OpenTelemetry as part of their strategy to improve the telemetry emitted by
their systems. Organizations around the world have already adopted it and
successfully process large amounts of data through pipelines as documented by
these various talks:

- [Adopting OpenTelemetry Collector @ eBay - Swapping Engines Mid Flight - Vijay Samuel](https://www.youtube.com/watch?v=tZJd6W-CIcU)
- [Ingesting 6.5 Tb of Telemetry Data Daily Through OpenTelemetry Protocol and Collectors - Gustavo Pantuza](https://www.youtube.com/watch?v=aDysORX1zIs)
- [Today, Not Tomorrow: Scalable Strategies for Migrating to OpenTelemetry - Jason Anderson & Kevin Broadbridge](https://www.youtube.com/watch?v=iPGd9_aYu-A)
- [How and Why You Should Adopt and Expose OSS Interfaces Like OTel & Prometheus - Daniel Hrabovcak & Shishi Chen](https://www.youtube.com/watch?v=D71fK2MFreI)
- [Why, How to, and Issues: Tail-Based Sampling in the OpenTelemetry Collector - Reese Lee](https://www.youtube.com/watch?v=l4PeclHKl7I)

A few months ago, there was an
[ask from the community](https://github.com/open-telemetry/community/issues/1971)
to declare the OpenTelemetry Collector stable.

![Can haz Collector v1?](can-haz-collector.png)

Now you might be asking yourself "Why would anyone want the Collector to be
declared stable? You just told me it's already used in production!" It's true,
the Collector and its configuration have been fairly stable for core components
for some time. However, being "unofficially stable" is not good enough for a
wide variety of organizations who wish to adopt the Collector:

- An official v1 will signal that the OpenTelemetry community is ready to
provide long term support and not introduce backwards incompatible changes
without bumping the major version.
- Organizations with policies not to use pre-release software will be able to
start adopting the Collector.
- Stability in the Collector helps the community move OpenTelemetry to become a
CNCF Graduated project.

The request to stabilize was met with pushback from maintainers since calling
anything 1.0 has a way of setting expectations indefinitely. This led to a
series of discussions and meetings that brought together the maintainers of the
Collector to decide on what a 1.0 really means for the Collector.

And after a lot of back and forth, we decided on a limited scope of what we
wanted to focus on:

1. A distribution of the Collector that only includes an OTLP receiver and an
OTLP exporter.
2. Individual Go modules that the Collector components rely upon must also be
marked as stable as per the project's
[versioning guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md#public-api-expectations).

Aside from this, there were a few areas the contributors wanted to improve based
on user feedback:

- The telemetry generated by the Collector about itself:
- Traces, metrics, and logs must be available via OTLP.
- The configuration for the telemetry must follow the configuration schema.
- The scalability of the Collector:
- Handling for queueing, back pressure, and errors must be improved.
- Clear benchmarks and performance expectations for end users.
- Overall documentation befitting of a stable piece of critical infrastructure.

The
[roadmap](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/ga-roadmap.md)
was published in the Collector's repository and milestones were created to track
the work underway. To ensure the effort can be successful, the scope of the
deliverable was limited to provide:

- a clear and achievable goal
- the focus needed to not get distracted
- a signal to new contributors of where the project is focusing

There is much to do as you can see on the
[project board](https://github.com/orgs/open-telemetry/projects/83), but there
is a lot of excitement around this effort. If you're keen on helping, reach out
either by commenting on any of the open issues in GitHub, or attending the
Collector SIG call that happens weekly on Wednesdays. For a quick overview of
the 1.0 progress you can checkout the tracking
[issue](https://github.com/open-telemetry/opentelemetry-collector/issues/9375).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4cf1b29

Please sign in to comment.