You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zipkin.apache.org by ab...@apache.org on 2019/06/06 08:52:43 UTC
[incubator-zipkin-website] branch asf-site updated: Automatic site
generation from 7f83148
This is an automated email from the ASF dual-hosted git repository.
abesto pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-zipkin-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new b633d32 Automatic site generation from 7f83148
b633d32 is described below
commit b633d32e56d5f909e3baa2ee4a7a0c4babbd2427
Author: jenkins <bu...@apache.org>
AuthorDate: Thu Jun 6 08:52:35 2019 +0000
Automatic site generation from 7f83148
---
Jenkinsfile | 3 +-
pages/downloads.html | 28 +++---
zipkin-api/DISCLAIMER | 5 +
zipkin-api/Jenkinsfile | 78 ++++++++++++++++
zipkin-api/LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++
zipkin-api/NOTICE | 5 +
zipkin-api/zipkin.proto | 237 ++++++++++++++++++++++++++++++++++++++++++++++++
7 files changed, 542 insertions(+), 15 deletions(-)
diff --git a/Jenkinsfile b/Jenkinsfile
index 1f7097e..0b7452d 100644
--- a/Jenkinsfile
+++ b/Jenkinsfile
@@ -99,6 +99,7 @@ pipeline {
ls "${builddir}/_site/"
git fetch origin asf-site:asf-site
+ git rm -rf ./zipkin-api
git reset --hard
git checkout asf-site
git log -3
@@ -106,7 +107,7 @@ pipeline {
git status
cp ./zipkin-api-source/*.yaml ./zipkin-api/
git add ./zipkin-api/*.yaml
- git commit -am"Zipkin OpenApi definitions"
+ git commit -am "Zipkin OpenApi definitions" || true
rsync -avrh --delete --exclude=".git" --exclude=".gitmodules" --exclude="zipkin-api-source" --exclude='zipkin-api/*.yaml' "${builddir}/_site/" ./
git status
diff --git a/pages/downloads.html b/pages/downloads.html
index b656de7..8bd2c1e 100644
--- a/pages/downloads.html
+++ b/pages/downloads.html
@@ -151,43 +151,43 @@
<td style="text-align: left">Zipkin Api</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-api/releases/tag/v0.2.1">0.2.1</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-api/0.2.1/apache-zipkin-api-incubating-0.2.1-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-api/0.2.1/apache-zipkin-api-incubating-0.2.1-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-api/0.2.1/apache-zipkin-api-incubating-0.2.1-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-api/0.2.1/apache-zipkin-api-incubating-0.2.1-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-api/0.2.1/apache-zipkin-api-incubating-0.2.1-source-release.zip.sha512">sha512</a></td>
</tr>
<tr>
<td style="text-align: left">Zipkin Brave for Apache Cassandra</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-brave-cassandra/releases/tag/v0.10.2">0.10.2</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-cassandra/0.10.2/apache-zipkin-brave-cassandra-incubating-0.10.2-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-cassandra/0.10.2/apache-zipkin-brave-cassandra-incubating-0.10.2-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-cassandra/0.10.2/apache-zipkin-brave-cassandra-incubating-0.10.2-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/brave-cassandra/0.10.2/apache-zipkin-brave-cassandra-incubating-0.10.2-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/brave-cassandra/0.10.2/apache-zipkin-brave-cassandra-incubating-0.10.2-source-release.zip.sha512">sha512</a></td>
</tr>
<tr>
<td style="text-align: left">Zipkin Brave for Apache Karaf</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-brave-karaf/releases/tag/v0.1.2">0.1.2</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-karaf/0.1.2/apache-zipkin-brave-karaf-incubating-0.1.2-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-karaf/0.1.2/apache-zipkin-brave-karaf-incubating-0.1.2-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/brave-karaf/0.1.2/apache-zipkin-brave-karaf-incubating-0.1.2-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/brave-karaf/0.1.2/apache-zipkin-brave-karaf-incubating-0.1.2-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/brave-karaf/0.1.2/apache-zipkin-brave-karaf-incubating-0.1.2-source-release.zip.sha512">sha512</a></td>
</tr>
<tr>
<td style="text-align: left">Zipkin Dependencies</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-dependencies/releases/tag/v2.2.0">2.2.0</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-dependencies/2.2.0/apache-zipkin-dependencies-incubating-2.2.0-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-dependencies/2.2.0/apache-zipkin-dependencies-incubating-2.2.0-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-dependencies/2.2.0/apache-zipkin-dependencies-incubating-2.2.0-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-dependencies/2.2.0/apache-zipkin-dependencies-incubating-2.2.0-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-dependencies/2.2.0/apache-zipkin-dependencies-incubating-2.2.0-source-release.zip.sha512">sha512</a></td>
</tr>
<tr>
<td style="text-align: left">Zipkin Reporter Java</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-reporter-java/releases/tag/v2.8.3">2.8.3</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-reporter-java/2.8.3/apache-zipkin-reporter-java-incubating-2.8.3-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-reporter-java/2.8.3/apache-zipkin-reporter-java-incubating-2.8.3-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-reporter-java/2.8.3/apache-zipkin-reporter-java-incubating-2.8.3-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-reporter-java/2.8.3/apache-zipkin-reporter-java-incubating-2.8.3-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-reporter-java/2.8.3/apache-zipkin-reporter-java-incubating-2.8.3-source-release.zip.sha512">sha512</a></td>
</tr>
<tr>
<td style="text-align: left">Zipkin Server and Core Library</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin/releases/tag/v2.14.0">2.14.0</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin/2.14.0/apache-zipkin-incubating-2.14.0-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin/2.14.0/apache-zipkin-incubating-2.14.0-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin/2.14.0/apache-zipkin-incubating-2.14.0-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin/2.14.0/apache-zipkin-incubating-2.14.0-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin/2.14.0/apache-zipkin-incubating-2.14.0-source-release.zip.sha512">sha512</a></td>
</tr>
</tbody>
</table>
@@ -210,8 +210,8 @@
<td style="text-align: left">Zipkin Layout Factory</td>
<td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-layout-factory/releases/tag/v0.0.5">0.0.5</a></td>
<td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-layout-factory/0.0.5/apache-zipkin-layout-factory-incubating-0.0.5-source-release.zip">zip</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-layout-factory/0.0.5/apache-zipkin-layout-factory-incubating-0.0.5-source-release.zip.asc">asc</a></td>
- <td style="text-align: left"><a href="https://www.apache.org/dyn/closer.cgi?path=incubator/zipkin/zipkin-layout-factory/0.0.5/apache-zipkin-layout-factory-incubating-0.0.5-source-release.zip.sha512">sha512</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-layout-factory/0.0.5/apache-zipkin-layout-factory-incubating-0.0.5-source-release.zip.asc">asc</a></td>
+ <td style="text-align: left"><a href="https://www.apache.org/dist/incubator/zipkin/zipkin-layout-factory/0.0.5/apache-zipkin-layout-factory-incubating-0.0.5-source-release.zip.sha512">sha512</a></td>
</tr>
</tbody>
</table>
diff --git a/zipkin-api/DISCLAIMER b/zipkin-api/DISCLAIMER
new file mode 100644
index 0000000..f73ab06
--- /dev/null
+++ b/zipkin-api/DISCLAIMER
@@ -0,0 +1,5 @@
+Apache Zipkin (incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC.
+Incubation is required of all newly accepted projects until a further review indicates
+that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects.
+While incubation status is not necessarily a reflection of the completeness or stability of the code,
+it does indicate that the project has yet to be fully endorsed by the ASF.
diff --git a/zipkin-api/Jenkinsfile b/zipkin-api/Jenkinsfile
new file mode 100644
index 0000000..9a05384
--- /dev/null
+++ b/zipkin-api/Jenkinsfile
@@ -0,0 +1,78 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+pipeline {
+ agent {
+ label 'ubuntu'
+ }
+
+ tools {
+ jdk 'JDK 1.8 (latest)'
+ }
+
+ options {
+ buildDiscarder(logRotator(
+ numToKeepStr: '30',
+ ))
+ timestamps()
+ skipStagesAfterUnstable()
+ timeout time: 30, unit: 'MINUTES'
+ }
+
+ stages {
+ stage('SCM Checkout') {
+ steps {
+ deleteDir()
+ checkout scm
+ }
+ }
+
+ stage('Check environment') {
+ steps {
+ sh 'env'
+ sh 'pwd'
+ sh 'ls'
+ sh 'git status'
+ }
+ }
+
+ stage('Publish snapshot') {
+ when {
+ branch 'master'
+ }
+ steps {
+ sh './mvnw deploy -Papache-release -Dgpg.skip=true -DskipTests --batch-mode -nsu'
+ }
+ }
+ }
+
+ post {
+ changed {
+ script {
+ if (env.BRANCH_NAME == 'master') {
+ emailext(
+ subject: "[${currentBuild.projectName}] master is ${currentBuild.currentResult} (#${currentBuild.number})",
+ to: 'commits@zipkin.apache.org',
+ replyTo: 'dev@zipkin.apache.org',
+ body: "See <${currentBuild.absoluteUrl}>"
+ )
+ }
+ }
+
+ }
+ }
+}
diff --git a/zipkin-api/LICENSE b/zipkin-api/LICENSE
new file mode 100644
index 0000000..8dada3e
--- /dev/null
+++ b/zipkin-api/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "{}"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/zipkin-api/NOTICE b/zipkin-api/NOTICE
new file mode 100644
index 0000000..d2f1493
--- /dev/null
+++ b/zipkin-api/NOTICE
@@ -0,0 +1,5 @@
+Language independent interchange formats for Apache Zipkin (incubating)
+Copyright 2019 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/zipkin-api/zipkin.proto b/zipkin-api/zipkin.proto
new file mode 100644
index 0000000..9e65112
--- /dev/null
+++ b/zipkin-api/zipkin.proto
@@ -0,0 +1,237 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+syntax = "proto3";
+
+package zipkin.proto3;
+
+// In Java, the closest model type to this proto is in the "zipkin2" package
+option java_package = "zipkin2.proto3";
+option java_multiple_files = true;
+
+// A span is a single-host view of an operation. A trace is a series of spans
+// (often RPC calls) which nest to form a latency tree. Spans are in the same
+// trace when they share the same trace ID. The parent_id field establishes the
+// position of one span in the tree.
+//
+// The root span is where parent_id is Absent and usually has the longest
+// duration in the trace. However, nested asynchronous work can materialize as
+// child spans whose duration exceed the root span.
+//
+// Spans usually represent remote activity such as RPC calls, or messaging
+// producers and consumers. However, they can also represent in-process
+// activity in any position of the trace. For example, a root span could
+// represent a server receiving an initial client request. A root span could
+// also represent a scheduled job that has no remote context.
+//
+// Encoding notes:
+//
+// Epoch timestamp are encoded fixed64 as varint would also be 8 bytes, and more
+// expensive to encode and size. Duration is stored uint64, as often the numbers
+// are quite small.
+//
+// Default values are ok, as only natural numbers are used. For example, zero is
+// an invalid timestamp and an invalid duration, false values for debug or shared
+// are ignorable, and zero-length strings also coerce to null.
+//
+// The next id is 14.
+//
+// Note fields up to 15 take 1 byte to encode. Take care when adding new fields
+// https://developers.google.com/protocol-buffers/docs/proto3#assigning-tags
+message Span {
+ // Randomly generated, unique identifier for a trace, set on all spans within
+ // it.
+ //
+ // This field is required and encoded as 8 or 16 bytes, in big endian byte
+ // order.
+ bytes trace_id = 1;
+ // The parent span ID or absent if this the root span in a trace.
+ bytes parent_id = 2;
+ // Unique identifier for this operation within the trace.
+ //
+ // This field is required and encoded as 8 opaque bytes.
+ bytes id = 3;
+ // When present, kind clarifies timestamp, duration and remote_endpoint. When
+ // absent, the span is local or incomplete. Unlike client and server, there
+ // is no direct critical path latency relationship between producer and
+ // consumer spans.
+ enum Kind {
+ // Default value interpreted as absent.
+ SPAN_KIND_UNSPECIFIED = 0;
+ // The span represents the client side of an RPC operation, implying the
+ // following:
+ //
+ // timestamp is the moment a request was sent to the server.
+ // duration is the delay until a response or an error was received.
+ // remote_endpoint is the server.
+ CLIENT = 1;
+ // The span represents the server side of an RPC operation, implying the
+ // following:
+ //
+ // timestamp is the moment a client request was received.
+ // duration is the delay until a response was sent or an error.
+ // remote_endpoint is the client.
+ SERVER = 2;
+ // The span represents production of a message to a remote broker, implying
+ // the following:
+ //
+ // timestamp is the moment a message was sent to a destination.
+ // duration is the delay sending the message, such as batching.
+ // remote_endpoint is the broker.
+ PRODUCER = 3;
+ // The span represents consumption of a message from a remote broker, not
+ // time spent servicing it. For example, a message processor would be an
+ // in-process child span of a consumer. Consumer spans imply the following:
+ //
+ // timestamp is the moment a message was received from an origin.
+ // duration is the delay consuming the message, such as from backlog.
+ // remote_endpoint is the broker.
+ CONSUMER = 4;
+ }
+ // When present, used to interpret remote_endpoint
+ Kind kind = 4;
+ // The logical operation this span represents in lowercase (e.g. rpc method).
+ // Leave absent if unknown.
+ //
+ // As these are lookup labels, take care to ensure names are low cardinality.
+ // For example, do not embed variables into the name.
+ string name = 5;
+ // Epoch microseconds of the start of this span, possibly absent if
+ // incomplete.
+ //
+ // For example, 1502787600000000 corresponds to 2017-08-15 09:00 UTC
+ //
+ // This value should be set directly by instrumentation, using the most
+ // precise value possible. For example, gettimeofday or multiplying epoch
+ // millis by 1000.
+ //
+ // There are three known edge-cases where this could be reported absent.
+ // - A span was allocated but never started (ex not yet received a timestamp)
+ // - The span's start event was lost
+ // - Data about a completed span (ex tags) were sent after the fact
+ fixed64 timestamp = 6;
+ // Duration in microseconds of the critical path, if known. Durations of less
+ // than one are rounded up. Duration of children can be longer than their
+ // parents due to asynchronous operations.
+ //
+ // For example 150 milliseconds is 150000 microseconds.
+ uint64 duration = 7;
+ // The host that recorded this span, primarily for query by service name.
+ //
+ // Instrumentation should always record this. Usually, absent implies late
+ // data. The IP address corresponding to this is usually the site local or
+ // advertised service address. When present, the port indicates the listen
+ // port.
+ Endpoint local_endpoint = 8;
+ // When an RPC (or messaging) span, indicates the other side of the
+ // connection.
+ //
+ // By recording the remote endpoint, your trace will contain network context
+ // even if the peer is not tracing. For example, you can record the IP from
+ // the "X-Forwarded-For" header or the service name and socket of a remote
+ // peer.
+ Endpoint remote_endpoint = 9;
+ // Associates events that explain latency with the time they happened.
+ repeated Annotation annotations = 10;
+ // Tags give your span context for search, viewing and analysis.
+ //
+ // For example, a key "your_app.version" would let you lookup traces by
+ // version. A tag "sql.query" isn't searchable, but it can help in debugging
+ // when viewing a trace.
+ map<string, string> tags = 11;
+ // True is a request to store this span even if it overrides sampling policy.
+ //
+ // This is true when the "X-B3-Flags" header has a value of 1.
+ bool debug = 12;
+ // True if we are contributing to a span started by another tracer (ex on a
+ // different host).
+ bool shared = 13;
+}
+
+// The network context of a node in the service graph.
+//
+// The next id is 5.
+message Endpoint {
+ // Lower-case label of this node in the service graph, such as "favstar".
+ // Leave absent if unknown.
+ //
+ // This is a primary label for trace lookup and aggregation, so it should be
+ // intuitive and consistent. Many use a name from service discovery.
+ string service_name = 1;
+ // 4 byte representation of the primary IPv4 address associated with this
+ // connection. Absent if unknown.
+ bytes ipv4 = 2;
+ // 16 byte representation of the primary IPv6 address associated with this
+ // connection. Absent if unknown.
+ //
+ // Prefer using the ipv4 field for mapped addresses.
+ bytes ipv6 = 3;
+ // Depending on context, this could be a listen port or the client-side of a
+ // socket. Absent if unknown.
+ int32 port = 4;
+}
+
+// Associates an event that explains latency with a timestamp.
+// Unlike log statements, annotations are often codes. Ex. "ws" for WireSend
+//
+// The next id is 3.
+message Annotation {
+ // Epoch microseconds of this event.
+ //
+ // For example, 1502787600000000 corresponds to 2017-08-15 09:00 UTC
+ //
+ // This value should be set directly by instrumentation, using the most
+ // precise value possible. For example, gettimeofday or multiplying epoch
+ // millis by 1000.
+ fixed64 timestamp = 1;
+ // Usually a short tag indicating an event, like "error"
+ //
+ // While possible to add larger data, such as garbage collection details, low
+ // cardinality event names both keep the size of spans down and also are easy
+ // to search against.
+ string value = 2;
+}
+
+// A list of spans with possibly different trace ids, in no particular order.
+//
+// This is used for all transports: POST, Kafka messages etc. No other fields
+// are expected, This message facilitates the mechanics of encoding a list, as
+// a field number is required. The name of this type is the same in the OpenApi
+// aka Swagger specification. https://zipkin.io/zipkin-api/#/default/post_spans
+message ListOfSpans {
+ repeated Span spans = 1;
+}
+
+// Response for SpanService/Report RPC. This response currently does not return
+// any information beyond indicating that the request has finished. That said,
+// it may be extended in the future.
+message ReportResponse {
+}
+
+// SpanService allows reporting spans using gRPC, as opposed to HTTP POST
+// reporting. Implementations are asynchronous and may drop spans for reasons
+// of sampling or storage availability. While this is primarily used to store
+// spans, other operations may take place such as aggregation of service
+// dependencies or data cleaning.
+service SpanService {
+
+ // Report the provided spans to the collector. Analogous to the HTTP POST
+ // /api/v2/spans endpoint. Spans are not required to be complete or belonging
+ // to the same trace.
+ rpc Report(ListOfSpans) returns (ReportResponse) {}
+}