Skip to content

Zipkin exporter v2 api support for protobuf format#1318

Merged
lzchen merged 23 commits intoopen-telemetry:masterfrom
robwknox:1175_zipkin_exporter_v2_protobuf_support
Nov 23, 2020
Merged

Zipkin exporter v2 api support for protobuf format#1318
lzchen merged 23 commits intoopen-telemetry:masterfrom
robwknox:1175_zipkin_exporter_v2_protobuf_support

Conversation

@robwknox
Copy link
Copy Markdown
Contributor

@robwknox robwknox commented Nov 2, 2020

Description

Adds support for the Zipkin Exporter v2 API's protobuf format.

Includes 2 auto-generated files related to the protobuf format:

  • exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/zipkin_pb2.py the core buffer code
  • exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/zipkin_pb2.pyi derived mypy stub file to aid development

File gen command (based on google docs):

./protoc -I=exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/ \
  --python_out=exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/ \
  --mypy_out=exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/ \
  zipkin.proto

Fixes #1175

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Breaking change is minor - the dict opentelemetry.exporter.zipkin.SPAN_KIND_MAP structure has changed but I suspect this is only being internally used by the module.

How Has This Been Tested?

Manual testing with local zipkin server doing comparisons between JSON & protobuf data exports to ensure they identically matched. Plus full tox run against envs:

  • 3.5.10
  • 3.6.12
  • 3.7.9
  • 3.8.6
  • 3.9.0
  • pypy3.6-7.3.1

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@robwknox robwknox requested review from a team, codeboten and owais and removed request for a team November 2, 2020 06:08
@robwknox robwknox changed the title [WIP] Zipkin exporter v2 api support for protobuf format Zipkin exporter v2 api support for protobuf format Nov 3, 2020
@robwknox robwknox requested a review from owais November 3, 2020 03:02
@codeboten codeboten added the release:required-for-ga To be resolved before GA release label Nov 5, 2020
@codeboten codeboten added the 1.0.0rc2 release candidate 2 for tracing GA label Nov 9, 2020
Copy link
Copy Markdown
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@lzchen lzchen merged commit 8ca9e46 into open-telemetry:master Nov 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1.0.0rc2 release candidate 2 for tracing GA release:required-for-ga To be resolved before GA release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Zipkin exporter must support Zipkin v2 Protobuf format

5 participants