Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix protobuf extension packaging and docs #9320

Merged
merged 4 commits into from
Feb 7, 2020
Merged

fix protobuf extension packaging and docs #9320

merged 4 commits into from
Feb 7, 2020

Conversation

clintropolis
Copy link
Member

Fixes #8051.

Description

This PR fixes druid-protobuf-extensions by tweaking how shading is done to not included the jars that are shaded in the packaging.

before:

$ ls -1 apache-druid-0.18.0-SNAPSHOT/extensions/druid-protobuf-extensions/
druid-protobuf-extensions-0.18.0-SNAPSHOT.jar
error_prone_annotations-2.3.2.jar
gson-2.8.6.jar
protobuf-dynamic-0.9.3.jar
protobuf-java-3.11.0.jar
protobuf-java-util-3.11.0.jar

after:

$ ls -1 apache-druid-0.18.0-SNAPSHOT/extensions/druid-protobuf-extensions/
druid-protobuf-extensions-0.18.0-SNAPSHOT.jar

I also updated the extension quickstart website docs a bit to make it a bit easier to follow.

This PR has:

  • been self-reviewed.
  • added documentation for new or modified features or behaviors.
  • been tested in a test Druid cluster.

ccaominh
ccaominh reviewed Feb 6, 2020
View reviewed changes
docs/development/extensions-core/protobuf.md
### `pb_publisher.py`
After `metrics_pb2.py` is generated, another script can be constructed to parse JSON data, convert it to Protobuf, and produce to a Kafka topic

```python
Copy link
Contributor

Choose a reason for hiding this comment

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

Keeping the shebang line that was present before is convenient if this code snippet is copy/pasted into its own script file.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops, accidentally left that off when i moved stuff around 👍

sthetland
sthetland approved these changes Feb 6, 2020
View reviewed changes
Copy link

@sthetland sthetland left a comment

Choose a reason for hiding this comment

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

Doc updates look good. This page doesn't seem to be linked from the left side TOC... is that on purpose? Anyway, question aside, +1

@clintropolis
Copy link
Member Author

Doc updates look good. This page doesn't seem to be linked from the left side TOC... is that on purpose?

I believe this is intentional, all of the extensions available are described and linked from http://druid.apache.org/docs/latest/development/extensions.html which is in the 'Configuration' part of the left side TOC.

@sthetland
Copy link

Doc updates look good. This page doesn't seem to be linked from the left side TOC... is that on purpose?

I believe this is intentional, all of the extensions available are described and linked from http://druid.apache.org/docs/latest/development/extensions.html which is in the 'Configuration' part of the left side TOC.

Got it... that makes sense.

@fjy fjy merged commit b55657c into apache:master Feb 7, 2020
@clintropolis clintropolis deleted the protobuf-ext-jars branch February 7, 2020 18:48
clintropolis added a commit to implydata/druid-public that referenced this pull request Feb 8, 2020
@clintropolis
fix protobuf extension packaging and docs (apache#9320)
e72bc4b 
* fix protobuf extension packaging and docs

* fix paths

* Update protobuf.md

* Update protobuf.md
@clintropolis clintropolis mentioned this pull request Feb 8, 2020
Merged
maytasm pushed a commit to implydata/druid-public that referenced this pull request Feb 19, 2020
@clintropolis @maytasm
fix protobuf extension packaging and docs (apache#9320)
03e3c40 
* fix protobuf extension packaging and docs

* fix paths

* Update protobuf.md

* Update protobuf.md
@jihoonson jihoonson added this to the 0.18.0 milestone Mar 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sthetland sthetland sthetland approved these changes

@ccaominh ccaominh ccaominh approved these changes

Assignees
No one assigned
Labels
Area - Documentation Area - Extension Bug
Projects
None yet
Milestone
0.18.0
Development

Successfully merging this pull request may close these issues.

Protobuf Extension task failed
5 participants
@clintropolis @sthetland @ccaominh @fjy @jihoonson