Skip to content

Commit

Permalink
Merge branch 'main' into refine-sdk-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosalberto authored Jul 6, 2023
2 parents 4f6a39b + d47affa commit 426481e
Show file tree
Hide file tree
Showing 12 changed files with 261 additions and 228 deletions.
10 changes: 6 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ Fixes #

Please provide a brief description of the changes here.

For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change) and link to the related issue(s) and/or [OTEP(s)](https://github.com/open-telemetry/oteps), update the [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md), and also be sure to update [`spec-compliance-matrix.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md) if necessary.
For non-trivial changes, follow the [change proposal process](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CONTRIBUTING.md#proposing-a-change).

Related issues #

Related [OTEP(s)](https://github.com/open-telemetry/oteps) #
* [ ] Related issues #
* [ ] Related [OTEP(s)](https://github.com/open-telemetry/oteps) #
* [ ] Links to the prototypes (when adding or changing features)
* [ ] [`CHANGELOG.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/CHANGELOG.md) file updated for non-trivial changes
* [ ] [`spec-compliance-matrix.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md) updated if necessary
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,26 @@ release.

- Refine SDK TracerProvider configuration section.
([#3559](https://github.com/open-telemetry/opentelemetry-specification/pull/3559))
- Make SDK Tracer Creation more normative.
([#3529](https://github.com/open-telemetry/opentelemetry-specification/pull/3529))

### Metrics

- Refine SDK MeterProvider configuration section.
([#3522](https://github.com/open-telemetry/opentelemetry-specification/pull/3522))
- Clarify metric view requirements and recommendations.
([#3524](https://github.com/open-telemetry/opentelemetry-specification/pull/3524))
- Change the view name to be the view's stream configuration name.
([#3524](https://github.com/open-telemetry/opentelemetry-specification/pull/3524))
- Make SDK Meter Creation more normative.
([#3529](https://github.com/open-telemetry/opentelemetry-specification/pull/3529))

### Logs

- Refine SDK LoggerProvider configuration section.
([#3559](https://github.com/open-telemetry/opentelemetry-specification/pull/3559))
- Make SDK Logger Creation more normative.
([#3529](https://github.com/open-telemetry/opentelemetry-specification/pull/3529))

### Resource

Expand All @@ -35,6 +45,9 @@ release.
- Extract Examplar section and mark it as Experimental.
([#3533](https://github.com/open-telemetry/opentelemetry-specification/pull/3533))

- BREAKING: Remove the Jaeger Exporter
([#3567](https://github.com/open-telemetry/opentelemetry-specification/pull/3567))

### Telemetry Schemas

### Common
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ Smaller changes can follow a shorter process:
may be opened and linked to the issue even before the proposed idea is accepted there.
- Once the issue is accepted the assignee can work on it and create a PR that implements
the change described in the issue.
- In the PR description, provide links to the prototypes. Depending on the scope
of the change, prototyping in multiple programming languages might be required
by the [specification
approvers](https://github.com/open-telemetry/community/blob/main/community-members.md#specifications-and-proto).

Trivial changes, such as clarifications, wording changes, spelling/grammar
corrections, etc. can be made directly via pull requests and do not require an associated
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# All documents to be used in spell check.
ALL_DOCS := $(shell find . -type f -name '*.md' -not -path './.github/*' -not -path './node_modules/*' | sort)
ALL_DOCS := $(shell find . -type f -name '*.md' -not -path './.github/*' -not -path './node_modules/*' -not -path '*semantic_conventions*' | sort)
PWD := $(shell pwd)

TOOLS_DIR := ./internal/tools
Expand Down
2 changes: 1 addition & 1 deletion experimental/trace/zpages.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

zPages are an in-process alternative to external exporters. When included, they collect and aggregate tracing and metrics information in the background; this data is served on web pages when requested.

The idea of "zPages" originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about zPages from the OpenCensus docs [here](https://opencensus.io/zpages) or the OTEP [here](https://github.com/open-telemetry/oteps/blob/main/text/0110-z-pages.md). OpenCensus has different zPage implementations in [Java](https://opencensus.io/zpages/java/), [Go](https://opencensus.io/zpages/go/), and [Node](https://opencensus.io/zpages/node/) and there has been similar internal solutions developed at companies like Uber. Within OpenTelemetry, zPages are also either developed or being developed in [C#](https://github.com/open-telemetry/opentelemetry-dotnet/tree/master/src/OpenTelemetry.Exporter.ZPages), Java, and C++. The OTel Collector also has [an implementation](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/zpagesextension) of zPages.
The idea of "zPages" originates from one of OpenTelemetry's predecessors, [OpenCensus](https://opencensus.io/). You can read more about zPages from the OpenCensus docs [here](https://opencensus.io/zpages) or the OTEP [here](https://github.com/open-telemetry/oteps/blob/main/text/0110-z-pages.md). OpenCensus has different zPage implementations in [Java](https://opencensus.io/zpages/java/), [Go](https://opencensus.io/zpages/go/), and [Node](https://opencensus.io/zpages/node/) and there has been similar internal solutions developed at companies like Uber. Within OpenTelemetry, zPages are being developed in C++. The OTel Collector also has [an implementation](https://github.com/open-telemetry/opentelemetry-collector/tree/master/extension/zpagesextension) of zPages.

zPages are uniquely useful in a couple of different ways. One is that they're more lightweight and quicker compared to installing external tracing systems like Jaeger and Zipkin, yet they still share useful ways to debug and gain insight into instrumented applications; these uses depend on the type of zPage, which is detailed below. For high throughput applications, zPages can also analyze more telemetry with the limited set of supported scenarios than external exporters; this is because zPages are in-memory while external exporters are typically configured to send a subset of telemetry for reach analysis to save costs.

Expand Down
Loading

0 comments on commit 426481e

Please sign in to comment.