Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ release.

### Traces

- Deprecate Zipkin exporter document and make exporter implementation optional
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Deprecate Zipkin exporter document and make exporter implementation optional
- Deprecate Zipkin exporter document and make exporter implementation optional.

([#4715](https://github.com/open-telemetry/opentelemetry-specification/pull/4715/))

### Metrics

- `AlignedHistogramBucketExemplarReservoir` SHOULD use a time-weighted algorithm.
Expand Down
4 changes: 2 additions & 2 deletions spec-compliance-matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,8 +334,8 @@ Disclaimer: Declarative configuration is currently in Development status - work
| **[Zipkin](specification/trace/sdk_exporters/zipkin.md)** | Optional | Go | Java | JS | Python | Ruby | Erlang | PHP | Rust | C++ | .NET | Swift |
| Zipkin V1 JSON | X | - | + | | + | - | - | - | - | - | - | - |
| Zipkin V1 Thrift | X | - | + | | [-][py1174] | - | - | - | - | - | - | - |
| Zipkin V2 JSON | * | + | + | | + | + | - | + | + | + | + | + |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* is no longer used.

Should we remove the following?

feature is required, and columns marked with `*` mean that for each type of
exporter (OTLP and Zipkin), implementing at least one of the supported
formats is required. Implementing more than one format is optional.

| Zipkin V2 Protobuf | * | - | + | | + | - | + | - | - | - | - | - |
| Zipkin V2 JSON | X | + | + | | + | + | - | + | + | + | + | + |
| Zipkin V2 Protobuf | X | - | + | | + | - | + | - | - | - | - | - |
| Service name mapping | | + | + | + | + | + | + | + | + | + | + | + |
| SpanKind mapping | | + | + | + | + | + | + | + | + | + | + | + |
| InstrumentationLibrary mapping | | + | + | - | + | + | - | + | + | + | + | + |
Expand Down
4 changes: 2 additions & 2 deletions spec-compliance-matrix/template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -375,9 +375,9 @@ sections:
- name: Zipkin V1 Thrift
optional: true
- name: Zipkin V2 JSON
optional_one_of_group_is_required: true
optional: true
- name: Zipkin V2 Protobuf
optional_one_of_group_is_required: true
optional: true
- name: Service name mapping
- name: SpanKind mapping
- name: InstrumentationLibrary mapping
Expand Down
2 changes: 2 additions & 0 deletions specification/configuration/sdk-environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ See [OpenTelemetry Protocol Exporter Configuration Options](../protocol/exporter

## Zipkin Exporter

**Status**: [Deprecated](../../document-status.md)

| Name | Description | Default | Type |
|-------------------------------|------------------------------------------------------------------------------------|--------------------------------------|-------------|
| OTEL_EXPORTER_ZIPKIN_ENDPOINT | Endpoint for Zipkin traces | `http://localhost:9411/api/v2/spans` | [String][] |
Expand Down
11 changes: 9 additions & 2 deletions specification/trace/sdk_exporters/zipkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,14 @@ linkTitle: Zipkin

# OpenTelemetry to Zipkin Transformation

**Status**: [Stable](../../document-status.md)
**Status**: [Deprecated](../../document-status.md)

_Note: This document remains here for backwards compatibility and
will be removed in a future version. SDKs MAY include Zipkin exporters,
but Zipkin exporter is not required.

Users may export to Zipkin using [zipkin exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/zipkinexporter) collector component or [zipkin-otel](https://github.com/openzipkin-contrib/zipkin-otel)
Zipkin server module_
Comment on lines +9 to +14
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not properly formatted.

Maybe

Suggested change
_Note: This document remains here for backwards compatibility and
will be removed in a future version. SDKs MAY include Zipkin exporters,
but Zipkin exporter is not required.
Users may export to Zipkin using [zipkin exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/zipkinexporter) collector component or [zipkin-otel](https://github.com/openzipkin-contrib/zipkin-otel)
Zipkin server module_
> Note: This document remains here for backwards compatibility and
> will be removed in a future version. SDKs MAY include Zipkin exporters,
> but Zipkin exporter is not required.
>
> Users may export to Zipkin using [zipkin exporter](https://github.com/open-telemetry/opentelemetry-collector->contrib/tree/main/exporter/zipkinexporter) collector component or [zipkin-otel](https://github.com/openzipkin-contrib/zipkin-otel)
>Zipkin server module.

or

Suggested change
_Note: This document remains here for backwards compatibility and
will be removed in a future version. SDKs MAY include Zipkin exporters,
but Zipkin exporter is not required.
Users may export to Zipkin using [zipkin exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/zipkinexporter) collector component or [zipkin-otel](https://github.com/openzipkin-contrib/zipkin-otel)
Zipkin server module_
_Note: This document remains here for backwards compatibility and
will be removed in a future version. SDKs MAY include Zipkin exporters,
but Zipkin exporter is not required.
Users may export to Zipkin using [zipkin exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/zipkinexporter) collector component or [zipkin-otel](https://github.com/openzipkin-contrib/zipkin-otel)
Zipkin server module._


This document defines the transformation between OpenTelemetry and Zipkin Spans.
The generic transformation [rules specified here](../../common/mapping-to-non-otlp.md) also apply. If a
Expand Down Expand Up @@ -69,7 +76,7 @@ not work properly. OpenTelemetry doesn't provide this consistency guarantee.
Exporter may chose to override the value for service name based on a local root
span to improve Zipkin user experience.

*Note*, the attribute `service.namespace` MUST NOT be used for the Zipkin
_Note_, the attribute `service.namespace` MUST NOT be used for the Zipkin
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not seen such way of adding notes anywhere else. Maybe just (or revert)

Suggested change
_Note_, the attribute `service.namespace` MUST NOT be used for the Zipkin
Note that the attribute `service.namespace` MUST NOT be used for the Zipkin

service name and should be sent as a Zipkin tag.

### SpanKind
Expand Down
Loading