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/05 09:25:38 UTC
[incubator-zipkin-website] branch asf-site updated: Automatic site
generation from 762a943
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 d842e92 Automatic site generation from 762a943
d842e92 is described below
commit d842e92e70188fc7fa3b2817db6d5c0312177d26
Author: jenkins <bu...@apache.org>
AuthorDate: Wed Jun 5 09:25:31 2019 +0000
Automatic site generation from 762a943
---
CNAME | 1 -
Gemfile.lock | 6 +-
Jenkinsfile | 12 +-
README.md | 29 +-
generate_thrift_v1_docs/generate.sh | 13 +-
index.html | 12 +-
pages/architecture.html | 8 +-
pages/community.html | 25 +-
pages/data_model.html | 8 +-
pages/extensions_choices.html | 30 +--
pages/instrumenting.html | 18 +-
pages/quickstart.html | 12 +-
pages/tracers_instrumentation.html | 18 +-
public/thrift/v1/index.html | 36 +--
zipkin-api/DISCLAIMER | 5 -
zipkin-api/Jenkinsfile | 78 ------
zipkin-api/LICENSE | 201 --------------
zipkin-api/NOTICE | 5 -
zipkin-api/zipkin-api.yaml | 441 ------------------------------
zipkin-api/zipkin.proto | 237 ----------------
zipkin-api/zipkin2-api.yaml | 521 ------------------------------------
21 files changed, 95 insertions(+), 1621 deletions(-)
diff --git a/CNAME b/CNAME
deleted file mode 100644
index 0629d70..0000000
--- a/CNAME
+++ /dev/null
@@ -1 +0,0 @@
-zipkin.io
\ No newline at end of file
diff --git a/Gemfile.lock b/Gemfile.lock
index e869b4c..e3a13bc 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -212,7 +212,7 @@ GEM
sawyer (~> 0.8.0, >= 0.5.3)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
- public_suffix (3.0.3)
+ public_suffix (3.1.0)
rb-fsevent (0.10.3)
rb-inotify (0.10.0)
ffi (~> 1.0)
@@ -220,7 +220,7 @@ GEM
ruby-enum (0.7.2)
i18n
ruby_dep (1.5.0)
- rubyzip (1.2.2)
+ rubyzip (1.2.3)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
@@ -237,7 +237,7 @@ GEM
ethon (>= 0.9.0)
tzinfo (1.2.5)
thread_safe (~> 0.1)
- unicode-display_width (1.4.1)
+ unicode-display_width (1.6.0)
yaml-lint (0.0.10)
PLATFORMS
diff --git a/Jenkinsfile b/Jenkinsfile
index e4b024a..9b49bb9 100644
--- a/Jenkinsfile
+++ b/Jenkinsfile
@@ -37,7 +37,7 @@ pipeline {
steps {
sh 'env'
sh 'pwd'
- sh 'ls -lR'
+ sh 'ls'
sh 'alias'
sh 'git config --list --local'
sh 'git config --list --global'
@@ -80,9 +80,9 @@ pipeline {
}
stage('Publish') {
-// when {
-// branch 'master'
-// }
+ when {
+ branch 'master'
+ }
environment {
// GH Personal access token @abesto
GITUSER = credentials('2d27b827-20c2-4173-ac84-f3abc308fc88')
@@ -96,15 +96,13 @@ pipeline {
builddir="$(mktemp -d)"
mv _site "${builddir}/"
- ls "${builddir}/_site/"
+ ls -lR "${builddir}/_site/"
git fetch origin asf-site:asf-site
git reset --hard
git checkout asf-site
git log -3
git status
- git add ./zipkin-api/*.yaml ./zipkin-api/*.proto
- git commit -m "force adds zipkin-api" || true
rsync -avrh --delete --exclude=".git" "${builddir}/_site/" ./
git status
diff --git a/README.md b/README.md
index 8c8870b..932ad6a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,8 @@
-# openzipkin.github.io
+# zipkin-website
-This repository contains the source code for the Zipkin documentation site
-https://zipkin.apache.org/. It's the
+This repository contains the source code for the Zipkin web site https://zipkin.apache.org/. It's the
[organization page](https://help.github.com/articles/user-organization-and-project-pages/)
-for [`openzipkin`](https://github.com/openzipkin/), hosted using
+for [Apache Zipkin (incubating) projects](https://github.com/apache?utf8=%E2%9C%93&q=incubator-zipkin&type=&language=), hosted using
[GitHub pages and Jekyll](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/).
This means that everything on the `master` branch is immediately and
automatically published.
@@ -47,7 +46,7 @@ Windows.
1. **Clone the repository**
- git clone https://github.com/openzipkin/openzipkin.github.io.git
+ git clone https://github.com/apache/incubator-zipkin-website.git
1. **Install Jekyll and friends**
@@ -59,7 +58,7 @@ Windows.
[`Gemfile.lock`](Gemfile.lock) makes sure we all have the same versions
locally). To install these packages:
- cd openzipkin.github.io
+ cd incubator-zipkin-website
bundle
1. **Run the site**
@@ -102,12 +101,6 @@ basic idea of what's what:
[EditorConfig](http://editorconfig.org/) configuration that makes sure
editors supporting EditorConfig format files in this repository in the same
way (think spaces vs tabs)
- * [`CNAME`](CNAME) tells GitHub pages that this site should be served at
- [http://zipkin.io](http://zipkin.io) instead of
- [http://openzipkin.zipkin.io](http://openzipkin.zipkin.io). For details on
- how, see
- [https://help.github.com/articles/using-a-custom-domain-with-github-pages/](Using
- a custom domain with GitHub Pages)
* [`Gemfile`](Gemfile) and [`Gemfile.lock`](Gemfile.lock) describe the Ruby
packages used for building and serving this site; see the documentation of
[Bundler](http://bundler.io/) for more details.
@@ -140,25 +133,25 @@ There are a few things to keep an eye out for while making changes to the site.
Once you've made your changes, you'll want to create a pull-request, so that the
changes can be merged into the `master` branch of
-`openzipkin/openzipkin.github.io`, and so published for the betterment of all.
+`apache/incubator-zipkin-website`, and so published for the betterment of all.
This section describes the steps for getting there, assuming you've followed the
instructions so far.
1. **Fork this repository**
Go to
- [openzipkin/openzipkin.github.io](https://github.com/openzipkin/openzipkin.github.io),
+ [apache/incubator-zipkin-website](https://github.com/apache/incubator-zipkin-website),
and click the "Fork" button. Or just
- [click here](https://github.com/openzipkin/openzipkin.github.io/fork).
+ [click here](https://github.com/apache/incubator-zipkin-website/fork).
1. **Tell git about your fork**
- We're going to call your fork `origin`, and the original `openzipkin`
+ We're going to call your fork `origin`, and the original `apache`
repository `upstream`. The following commands tell `git` to make the
appropriate changes:
git remote rename origin upstream
- git remote add origin git@github.com:$USER/openzipkin.github.io
+ git remote add origin git@github.com:$USER/incubator-zipkin-website
git fetch upstream
1. **Create a branch, commit and push your changes**
@@ -169,7 +162,7 @@ instructions so far.
1. **Open a pull-request**
- Open https://github.com/openzipkin/openzipkin.github.io. You should see a bar
+ Open https://github.com/apache/incubator-zipkin-website. You should see a bar
above the list of files that says you've recently pushed to your branch, with
a green button on the right to open a pull request. Click it; add text to
text fields and click buttons as appropriate. See
diff --git a/generate_thrift_v1_docs/generate.sh b/generate_thrift_v1_docs/generate.sh
index b44463f..7e3af01 100755
--- a/generate_thrift_v1_docs/generate.sh
+++ b/generate_thrift_v1_docs/generate.sh
@@ -6,7 +6,7 @@ set -x
# Where's Waldo?
[ ! -d ./generate_thrift_v1_docs ] && cd ..
if [ ! -d ./generate_thrift_v1_docs ]; then
- echo "Please run this script either from the root of the openzipkin.github.io repository"
+ echo "Please run this script either from the root of the incubator-zipkin-website repository"
echo "or from the generate_thrift_v1_docs folder in that repository."
exit 1
fi
@@ -19,9 +19,10 @@ target_dir="${target_root}/thrift/v1"
rm -rfv "$target_dir"
# Prepare clean workspace
-cd "$(mktemp -d)"
-git clone https://github.com/openzipkin/zipkin-api.git
-cd zipkin-api/thrift
+# base temp dir to /tmp to avoid having to custom configure OS/x Docker
+cd "$(mktemp -d /tmp/XXXXXXXXXX)"
+git clone https://github.com/apache/incubator-zipkin-api.git
+cd incubator-zipkin-api/thrift
# Generate HTML docs with Thrift
rm -fv wrapper.thrift
@@ -43,7 +44,9 @@ set -e
# Apply some transforms to the generated HTML
cp "$rootdir/generate_thrift_v1_docs/transform.xslt" ./
-docker run --rm -v "$PWD:/workspace" -u "$(id -u)" klakegg/saxon \
+# Currently, this image doesn't work with a user override https://github.com/klakegg/docker-saxon/issues/2
+# docker run --rm -v "$PWD:/workspace" -u "$(id -u)" klakegg/saxon xslt \
+docker run --rm -v "$PWD:/workspace" klakegg/saxon xslt \
-s:/workspace/html/index.tidy.html \
-xsl:/workspace/transform.xslt \
-o:/workspace/html/index.baked.html
diff --git a/index.html b/index.html
index f86d29f..30a73f6 100644
--- a/index.html
+++ b/index.html
@@ -11,7 +11,7 @@
<title>
- OpenZipkin · A distributed tracing system
+ Apache Zipkin (incubating) · A distributed tracing system
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -142,8 +142,8 @@ Zipkin’s design is based on the
<li>See if your platform has a <a href="/pages/tracers_instrumentation">tracer or instrumentation library</a></li>
<li>See if a <a href="/pages/extensions_choices">server extension or alternative</a> is relevant to your site.</li>
<li>Join the <a href="https://gitter.im/openzipkin/zipkin">Zipkin Gitter chat channel</a></li>
- <li>The source code is on GitHub as <a href="https://github.com/openzipkin/zipkin/">openzipkin/zipkin</a></li>
- <li>Issues are also tracked on <a href="https://github.com/openzipkin/zipkin/issues">GitHub</a></li>
+ <li>The source code is on GitHub as <a href="https://github.com/apache/incubator-zipkin/">openzipkin/zipkin</a></li>
+ <li>Issues are also tracked on <a href="https://github.com/apache/incubator-zipkin/issues">GitHub</a></li>
</ul>
</div>
diff --git a/pages/architecture.html b/pages/architecture.html
index 960864b..b3832ad 100644
--- a/pages/architecture.html
+++ b/pages/architecture.html
@@ -11,7 +11,7 @@
<title>
- Architecture · OpenZipkin
+ Architecture · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
diff --git a/pages/community.html b/pages/community.html
index d79d621..e8df533 100644
--- a/pages/community.html
+++ b/pages/community.html
@@ -11,7 +11,7 @@
<title>
- Zipkin Community · OpenZipkin
+ Zipkin Community · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -125,22 +125,19 @@
Zipkin Community
</h1>
- <p>Zipkin is a tracing system originally created by Twitter and is currently run by
-the OpenZipkin volunteer organization.</p>
+ <p>Zipkin is a tracing system originally created by Twitter in 2012. In 2015, the community took over under the name OpenZipkin. Since late 2018, the Zipkin project entered the Apache Software Foundation (ASF) Incubator.</p>
-<h3 id="what-is-openzipkin">What is OpenZipkin?</h3>
-<p><a href="https://github.com/openzipkin/">OpenZipkin</a> is the OSS organization that stewards
-Zipkin code, docs, specs and support. It includes github projects, this web site,
-<a href="https://groups.google.com/forum/#!forum/zipkin-user">google groups - mailing list</a>,
+<h3 id="who-are-we">Who are we?</h3>
+<p>The Apache Zipkin (incubating) project team stewards code, docs, specs and support. It includes github projects, this web site, the <a href="https://lists.apache.org/list.html?dev@zipkin.apache.org">dev list</a>,
<a href="https://twitter.com/zipkinproject">Twitter</a> and <a href="https://gitter.im/openzipkin/zipkin">gitter</a>.</p>
<h3 id="keeping-up-to-date">Keeping up to date</h3>
<p>Follow <a href="https://twitter.com/zipkinproject">@zipkinproject</a> on Twitter for news
including release announcements and community events. You can also ask on <a href="https://gitter.im/openzipkin/zipkin">gitter</a> about something specific. If you are working on code, you can also
-follow projects like the <a href="https://github.com/openzipkin/zipkin">server</a> or an <a href="https://zipkin.io/pages/tracers_instrumentation.html">instrumentation</a> you use.</p>
+follow projects like the <a href="https://github.com/apache/incubator-zipkin">server</a> or an <a href="https://zipkin.apache.org/pages/tracers_instrumentation.html">instrumentation</a> you use.</p>
<h3 id="being-an-active-part-of-the-community">Being an active part of the community</h3>
-<p>OpenZipkin is primarily volunteers, and there are a lot of ways to help. Once you
+<p>Zipkin is primarily a volunteer community, and there are a lot of ways to help. Once you
are on <a href="https://gitter.im/openzipkin/zipkin">gitter</a>, you might notice others asking
questions you once asked. A great way to give-back is to help others who are just
starting. We are at a number of events, and these are a great way to meet others
@@ -150,13 +147,13 @@ interesting on Twitter, tag it with #zipkin so that others can see it. Last, but
least, you can get involved with the code, docs and project maintenance.</p>
<h3 id="how-change-works-in-zipkin">How change works in Zipkin</h3>
-<p>Most OpenZipkin efforts start as localized experiments, then progressively build
+<p>Most Zipkin efforts start as localized experiments, then progressively build
traction before becoming a feature. Before you start a large effort, be it docs or
a test framework or a feature, check with one of the above channels. Someone may
already have worked on this in the past and might join your effort. Sometimes,
features are intentionally absent, usually with rationale documented in an issue.
Regardless, the best advice is to join the community before proposing change, and
-read one of our <a href="https://github.com/openzipkin/brave/blob/master/HACKING.md">HACKING</a> files
+read one of our <a href="https://github.com/apache/incubator-zipkin-brave/blob/master/HACKING.md">HACKING</a> files
which explains important aspects of change culture.</p>
<h3 id="logos">Logos</h3>
diff --git a/pages/data_model.html b/pages/data_model.html
index ddcd8dc..c395284 100644
--- a/pages/data_model.html
+++ b/pages/data_model.html
@@ -11,7 +11,7 @@
<title>
- Data Model · OpenZipkin
+ Data Model · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
diff --git a/pages/extensions_choices.html b/pages/extensions_choices.html
index ef04930..69e20ed 100644
--- a/pages/extensions_choices.html
+++ b/pages/extensions_choices.html
@@ -11,7 +11,7 @@
<title>
- Server extensions and choices · OpenZipkin
+ Server extensions and choices · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -131,11 +131,9 @@
<p>The following modules add storage or transport extensions to the default server build.
Please refer to their individual documentation for setup and configuration guides.</p>
-<h3 id="openzipkin-supported">OpenZipkin supported</h3>
+<h3 id="supported">Supported</h3>
-<p>The following extensions are supported by the OpenZipkin team and are hosted at
-the <a href="https://github.com/openzipkin/">OpenZipkin GitHub</a> group. You can reach out to
-the team on <a href="https://gitter.im/openzipkin/zipkin/">Zipkin Gitter</a> chat.</p>
+<p>The following extensions are supported by the Zipkin team. You can reach out to the team on <a href="https://gitter.im/openzipkin/zipkin/">Gitter</a> chat.</p>
<table class="wide-table">
<thead>
@@ -177,18 +175,6 @@ the team on <a href="https://gitter.im/openzipkin/zipkin/">Zipkin Gitter</a> cha
<td style="text-align: left"><a href="https://cloud.google.com/stackdriver/">GCP Stackdriver</a></td>
<td style="text-align: left">only supports sending to an Stackdriver</td>
</tr>
- <tr>
- <td style="text-align: left">Collector</td>
- <td style="text-align: left"><a href="https://github.com/openzipkin/zipkin/tree/master/zipkin-autoconfigure/collector-kafka08">zipkin-collector kafka08</a></td>
- <td style="text-align: left"><a href="https://kafka.apache.org/">Apache kafka</a></td>
- <td style="text-align: left">Only use this for Legacy Kafka 0.8-0.9 The default server includes support for Kafka 0.10+</td>
- </tr>
- <tr>
- <td style="text-align: left">Collector</td>
- <td style="text-align: left"><a href="https://github.com/openzipkin/zipkin/tree/master/zipkin-autoconfigure/collector-scribe">zipkin-collector scribe</a></td>
- <td style="text-align: left"><a href="https://github.com/facebookarchive/scribe">Scribe</a></td>
- <td style="text-align: left"> </td>
- </tr>
</tbody>
</table>
@@ -254,7 +240,7 @@ same data sent to the default Zipkin server.</p>
</li>
<li>When <code class="highlighter-rouge">SPAN_STORAGE_TYPE=kafka</code> and <code class="highlighter-rouge">zipkin-thrift</code>, Jaeger reads Zipkin v1 thrift encoded span messages from a Kafka topic.
<ul>
- <li>Note: The above is a <a href="https://github.com/openzipkin/zipkin/tree/master/zipkin-collector/kafka#legacy-encoding">deprecated practice</a> in Zipkin. Most instrumentation bundle multiple spans per message in v2 format.</li>
+ <li>Note: The above is a <a href="https://github.com/apache/incubator-zipkin/tree/master/zipkin-collector/kafka#legacy-encoding">deprecated practice</a> in Zipkin. Most instrumentation bundle multiple spans per message in v2 format.</li>
</ul>
</li>
</ul>
@@ -271,7 +257,7 @@ same data sent to the default Zipkin server.</p>
</ul>
<p>Did we miss a server extension or alternative? Please open a pull-request to
-<a href="https://github.com/openzipkin/openzipkin.github.io">openzipkin.github.io</a>.</p>
+<a href="https://github.com/apache/incubator-zipkin-website">zipkin-website</a>.</p>
</div>
diff --git a/pages/instrumenting.html b/pages/instrumenting.html
index 64f6961..3b19cf3 100644
--- a/pages/instrumenting.html
+++ b/pages/instrumenting.html
@@ -11,7 +11,7 @@
<title>
- Instrumenting a library · OpenZipkin
+ Instrumenting a library · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -149,7 +149,7 @@ happy to help you along the way.</p>
<h1 id="core-data-structures">Core data structures</h1>
-<p>Core data structures are documented in detail in <a href="https://github.com/openzipkin/zipkin-api/blob/master/thrift/zipkinCore.thrift">Thrift</a> comments. Here’s a high-level description to get you started:</p>
+<p>Core data structures are documented in detail in <a href="https://github.com/apache/incubator-zipkin-api/blob/master/thrift/zipkinCore.thrift">Thrift</a> comments. Here’s a high-level description to get you started:</p>
<p><strong>Annotation</strong></p>
@@ -279,7 +279,7 @@ information for the request.</li>
we can tell downstream services that this is a “debug” request.</li>
</ul>
-<p>Check <a href="https://github.com/openzipkin/b3-propagation">here</a> for the format.</p>
+<p>Check <a href="https://github.com/apache/incubator-zipkin-b3-propagation">here</a> for the format.</p>
<p><a href="https://twitter.github.io/finagle/">Finagle</a> provides mechanisms for passing this information with HTTP and Thrift
requests. Other protocols will need to be augmented with the information for
@@ -316,7 +316,7 @@ BigBrotherBird.</p>
<li>X-B3-Flags: “1” means debug (can be absent)</li>
</ul>
-<p>For more information on B3, please see its <a href="https://github.com/openzipkin/b3-propagation">specification</a>.</p>
+<p>For more information on B3, please see its <a href="https://github.com/apache/incubator-zipkin-b3-propagation">specification</a>.</p>
<p><strong>Thrift Tracing</strong></p>
@@ -435,7 +435,7 @@ span(context).annotate("cs") \/
span(context).annotate("sr")
</code></pre></div></div>
-<p>Here’s an example of this process using the <a href="https://github.com/openzipkin/brave/blob/master/brave/src/test/java/brave/features/async/OneWaySpanTest.java">Brave Tracer</a>:</p>
+<p>Here’s an example of this process using the <a href="https://github.com/apache/incubator-zipkin-brave/blob/master/brave/src/test/java/brave/features/async/OneWaySpanTest.java">Brave Tracer</a>:</p>
<p>Client side:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Add trace identifiers to the outbound span</span>
@@ -503,7 +503,7 @@ span(context).annotate("ms") \/
.address("ma", broker)
</code></pre></div></div>
-<p>Here’s an example of this process using the <a href="https://github.com/openzipkin/brave">Brave Tracer</a>:</p>
+<p>Here’s an example of this process using the <a href="https://github.com/apache/incubator-zipkin-brave">Brave Tracer</a>:</p>
<p>Producer side:</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c1">// Add trace identifiers to the outbound span</span>
diff --git a/pages/quickstart.html b/pages/quickstart.html
index 144c62b..743d83b 100644
--- a/pages/quickstart.html
+++ b/pages/quickstart.html
@@ -11,7 +11,7 @@
<title>
- Quickstart · OpenZipkin
+ Quickstart · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -125,8 +125,8 @@
Quickstart
</h1>
- <p>In this section we’ll walk through building and starting an instance of Zipkin
-for checking out Zipkin locally. There are three options: using Java, Docker or running from source.</p>
+ <p>In this section we’ll walk through building and starting an instance of Zipkin for local testing.
+There are three options: using Java, Docker or running from source.</p>
<p>If you are familiar with Docker, this is the preferred method to start. If you are unfamiliar with Docker, try running via Java or from source.</p>
diff --git a/pages/tracers_instrumentation.html b/pages/tracers_instrumentation.html
index 0ade8d5..1eafb40 100644
--- a/pages/tracers_instrumentation.html
+++ b/pages/tracers_instrumentation.html
@@ -11,7 +11,7 @@
<title>
- Tracers and Instrumentation · OpenZipkin
+ Tracers and Instrumentation · Apache Zipkin (incubating)
</title>
@@ -33,12 +33,12 @@
<div class="container sidebar-sticky">
<div class="sidebar-about">
<a href="">
- <img alt="OpenZipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
+ <img alt="Zipkin logo" src="/public/img/zipkin-logo-200x119.jpg"
class="sidebar-logo">
</a>
- <a href="https://github.com/openzipkin/zipkin" target="_blank" title="openzipkin/zipkin">
- <img class="sidebar-social-icon" alt="openzipkin/zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
+ <a href="https://github.com/apache/incubator-zipkin" target="_blank" title="apache/incubator-zipkin">
+ <img class="sidebar-social-icon" alt="apache/incubator-zipkin" src="/public/img/GitHub-Mark-Light-32px.png">
</a>
<a href="https://twitter.com/zipkinproject" target="_blank" title="@zipkinproject">
@@ -134,11 +134,9 @@ together into spans.</p>
Please refer to their individual documentation for setup and configuration
guides.</p>
-<h3 id="openzipkin-supported">OpenZipkin supported</h3>
+<h3 id="supported">Supported</h3>
-<p>The following libraries are supported by the OpenZipkin team and are hosted at
-the <a href="https://github.com/openzipkin/">OpenZipkin GitHub</a> group. You can reach out to
-the team on <a href="https://gitter.im/openzipkin/zipkin/">Zipkin Gitter</a> chat.</p>
+<p>The following libraries are supported by the Zipkin team. You can reach out to the team on <a href="https://gitter.im/openzipkin/zipkin/">Gitter</a> chat.</p>
<table class="wide-table">
<thead>
@@ -173,7 +171,7 @@ the team on <a href="https://gitter.im/openzipkin/zipkin/">Zipkin Gitter</a> cha
</tr>
<tr>
<td style="text-align: left">Java</td>
- <td style="text-align: left"><a href="https://github.com/openzipkin/brave">brave</a></td>
+ <td style="text-align: left"><a href="https://github.com/apache/incubator-zipkin-brave">brave</a></td>
<td style="text-align: left">Jersey, RestEASY, JAXRS2, Apache HttpClient, Mysql</td>
<td style="text-align: left">Http (B3), gRPC (B3)</td>
<td style="text-align: left">Http, Kafka, Scribe</td>
@@ -535,7 +533,7 @@ the team on <a href="https://gitter.im/openzipkin/zipkin/">Zipkin Gitter</a> cha
</table>
<p>Did we miss a library? Please open a pull-request to
-<a href="https://github.com/openzipkin/openzipkin.github.io">openzipkin.github.io</a>.</p>
+<a href="https://github.com/apache/incubator-zipkin-website">zipkin.apache.org</a>.</p>
<p>Want to create instrumentation for another framework or platform? We have documentation on <a href="/pages/instrumenting">instrumenting a library</a>.</p>
diff --git a/public/thrift/v1/index.html b/public/thrift/v1/index.html
index ac87c20..21a497e 100644
--- a/public/thrift/v1/index.html
+++ b/public/thrift/v1/index.html
@@ -8,8 +8,7 @@
<link href="style.css" rel="stylesheet" type="text/css" />
<title xmlns="">Zipkin V1 Thrift models</title>
-
- </head>
+ </head>
<body>
@@ -30,10 +29,8 @@
<th>Data types</th>
<th>Constants</th>
-
- </tr>
-
- </thead>
+ </tr>
+ </thead>
<tr>
@@ -50,8 +47,7 @@
<a href="zipkinCore.html#Struct_Endpoint">Endpoint</a><br />
<a href="zipkinCore.html#Struct_Span">Span</a><br />
-
- </td>
+ </td>
<td><code><a href="zipkinCore.html#Const_CLIENT_ADDR">CLIENT_ADDR</a></code><br />
@@ -100,10 +96,8 @@
<code><a href="zipkinCore.html#Const_WIRE_RECV">WIRE_RECV</a></code><br />
<code><a href="zipkinCore.html#Const_WIRE_SEND">WIRE_SEND</a></code><br />
-
- </td>
-
- </tr>
+ </td>
+ </tr>
<tr>
@@ -115,17 +109,11 @@
<a href="zipkinDependencies.html#Struct_Dependencies">Dependencies</a><br />
<a href="zipkinDependencies.html#Struct_DependencyLink">DependencyLink</a><br />
-
- </td>
+ </td>
<td></td>
-
- </tr>
-
- </table>
-
- </div>
-
- </body>
-
-</html>
\ No newline at end of file
+ </tr>
+ </table>
+ </div>
+ </body>
+ </html>
\ No newline at end of file
diff --git a/zipkin-api/DISCLAIMER b/zipkin-api/DISCLAIMER
deleted file mode 100644
index f73ab06..0000000
--- a/zipkin-api/DISCLAIMER
+++ /dev/null
@@ -1,5 +0,0 @@
-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
deleted file mode 100644
index 9a05384..0000000
--- a/zipkin-api/Jenkinsfile
+++ /dev/null
@@ -1,78 +0,0 @@
-/*
- * 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
deleted file mode 100644
index 8dada3e..0000000
--- a/zipkin-api/LICENSE
+++ /dev/null
@@ -1,201 +0,0 @@
- 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
deleted file mode 100644
index d2f1493..0000000
--- a/zipkin-api/NOTICE
+++ /dev/null
@@ -1,5 +0,0 @@
-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-api.yaml b/zipkin-api/zipkin-api.yaml
deleted file mode 100644
index 2f4a190..0000000
--- a/zipkin-api/zipkin-api.yaml
+++ /dev/null
@@ -1,441 +0,0 @@
-#
-# 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.
-#
-
-swagger: "2.0"
-info:
- version: "1.0.0"
- title: Zipkin API
- description: |
- Zipkin's Query api is rooted at `api/v1`, on a host that by default listens
- on port 9411. It primarily serves the zipkin-ui, although it includes a POST
- endpoint that can receive spans.
-host: localhost:9411
-basePath: /api/v1
-schemes:
- - http
- - https
-consumes:
- - application/json
-produces:
- - application/json
-paths:
- /services:
- get:
- description: |
- Returns a list of all service names associated with annotations.
- responses:
- '200':
- description: Succes
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
- /spans:
- get:
- description: Get all the span names logged by a particular service
- parameters:
- - name: serviceName
- in: query
- required: true
- description: |
- Ex zipkin-server (required) - service that logged an annotation in a
- trace. The /services endpoint enumerates possible input values.
- type: string
- responses:
- '200':
- description: OK
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
- post:
- description: |
- Uploads a list of spans encoded per content-type, for example json
- or thrift (TBinaryProtocol big-endian).
- consumes:
- - application/json
- - application/x-thrift
- produces: []
- parameters:
- - name: span
- in: body
- description: A list of spans that belong to any trace.
- required: true
- schema:
- $ref: "#/definitions/ListOfSpans"
- responses:
- '202':
- description: Accepted
- /traces:
- get:
- description: |
- Invoking this request retrieves traces matching the below filters.
-
- Results should be filtered against endTs, subject to limit and
- lookback. For example, if endTs is 10:20 today, limit is 10, and
- lookback is 7 days, traces returned should be those nearest to 10:20
- today, not 10:20 a week ago.
-
- Time units of endTs and lookback are milliseconds as opposed to
- microseconds, the grain of Span.timestamp. Milliseconds is a more
- familiar and supported granularity for query, index and windowing
- functions
- parameters:
- - name: serviceName
- in: query
- required: false
- description: |
- Ex zipkin-server - service that logged an annotation in a trace.
- Required when constraining on parameters except time and duration.
- The /services endpoint enumerates possible input values.
- type: string
- - name: spanName
- in: query
- required: false
- description: |
- Ex my_span_name - name of a span in a trace.
- Only return traces that contains spans with this name.
- type: string
- - name: annotationQuery
- in: query
- type: string
- required: false
- description: |
- Ex. `http.uri=/foo and retried` - If key/value (has an `=`),
- constrains against Span.binaryAnnotations of time string. If just
- a word, constrains against Span.annotations. Any values are AND
- against eachother. This means a span in the trace must match all of
- these.
- - name: minDuration
- in: query
- type: integer
- description: |
- Ex. 100000 (for 100ms). Only return traces whose `Span.duration` is
- greater than or equal to minDuration microseconds.
- - name: maxDuration
- in: query
- type: integer
- description: |
- Only return traces whose Span.duration is less than or equal to
- `maxDuration` microseconds. Only valid with minDuration.
- - name: endTs
- in: query
- type: integer
- format: int64
- description: |
- Only return traces where all Span.timestamp are at or before this
- time in epoch milliseconds. Defaults to current time.
- - name: lookback
- type: integer
- format: int64
- in: query
- description: |
- Only return traces where all Span.timestamp are at or after
- (`endTs - * lookback`) in milliseconds. Defaults to `endTs`, limited
- to a system parameter `QUERY_LOOKBACK`.
- - name: limit
- in: query
- default: 10
- type: integer
- description: |
- Maximum number of traces to return. Defaults to 10
- responses:
- '200':
- description: OK
- schema:
- $ref: "#/definitions/ListOfTraces"
- /trace/{traceId}:
- get:
- parameters:
- - name: traceId
- in: path
- required: true
- description: the 64 or 128-bit big endian, hex-encoded id of the trace as a path parameter.
- type: string
- - name: raw
- in: query
- required: false
- description: |
- Note this flag has no value. Ex. /trace/{traceId}?raw
-
- Normally, the trace endpoint cleans trace data. For example, it merges
- spans by id, adds missing timestamp or duration, corrects clock skew..
-
- Specifying this flag is a debug case, when you are debugging zipkin
- logic or zipkin instrumentation, and want to see the input to these
- adjusters. For example, this might explain or rule out clock skew.
- type: boolean
- responses:
- '200':
- description: OK
- schema:
- $ref: "#/definitions/Trace"
- '404':
- description: "`traceId` not found"
- /dependencies:
- get:
- description: |
- Returns dependency links derived from spans.
-
- Span names are in lowercase, rpc method for example. Conventionally,
- when the span name isn't known, name = "unknown".
- parameters:
- - name: endTs
- in: query
- description: |
- Only return links from spans where `Span.timestamp` are at or before
- this time in epoch milliseconds.
- required: true
- type: integer
- format: int64
- - name: lookback
- in: query
- description: |
- Only return links from spans where all Span.timestamp are at or after
- (`endTs - * lookback`) in milliseconds. Defaults to `endTs`, limited
- to a system parameter `QUERY_LOOKBACK`.
- type: integer
- format: int64
- responses:
- '200':
- description: OK
- schema:
- type: array
- title: ListOfDependencyLinks
- items:
- $ref: "#/definitions/DependencyLink"
-definitions:
- Endpoint:
- type: object
- title: Endpoint
- description: The network context of a node in the service graph
- required:
- - serviceName
- properties:
- serviceName:
- type: string
- description: |
- Lower-case label of this node in the service graph, such as "favstar". Set
- to empty string 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.
- ipv4:
- type: string
- format: ipv4
- description: |
- The text representation of the primary IPv4 address associated with this
- connection. Ex. 192.168.99.100 Absent if unknown.
- ipv6:
- type: string
- format: ipv6
- description: |
- The text representation of the primary IPv6 address associated with a
- connection. Ex. 2001:db8::c001 Absent if unknown.
-
- Prefer using the ipv4 field for mapped addresses.
- port:
- type: integer
- description: |
- Depending on context, this could be a listen port or the client-side of a
- socket. Absent if unknown. Please don't set to zero.
- Annotation:
- title: Annotation
- type: object
- required:
- - timestamp
- - value
- description: |
- Associates an event that explains latency with a timestamp.
- Unlike log statements, annotations are often codes. Ex. "sr" for ServerReceive
- properties:
- timestamp:
- type: integer
- description: |
- 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.
- value:
- type: string
- description: |
- Usually a short tag indicating an event, like "sr"
-
- 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.
- endpoint:
- $ref: "#/definitions/Endpoint"
- description: |
- 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.
- BinaryAnnotation:
- title: BinaryAnnotation
- type: object
- required:
- - key
- - value
- description: |
- Adds context to a span, 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.
- properties:
- key:
- type: string
- value:
- type: string
- endpoint:
- $ref: "#/definitions/Endpoint"
- description: |
- The host that recorded this span, primarily for query by service name.
-
- There is an exception, when the key is "sa", "ca" or "ma" this is an
- address annotation. In such case, the endpoint is not what recorded the
- span, rather the remote address. The value field is set to boolean true
- in this case. This feature was refactored in v2 format as "remoteEndpoint"
- ListOfSpans:
- title: ListOfSpans
- description: 'A list of spans with possibly different trace ids, in no particular order'
- type: array
- items:
- $ref: "#/definitions/Span"
- Trace:
- title: Trace
- type: array
- description: 'List of spans who have the same trace id. Spans in the trace, and annotations in a span are sorted ascending by timestamp. ie first event should be first in the spans list.'
- items:
- $ref: "#/definitions/Span"
- ListOfTraces:
- title: ListOfTraces
- type: array
- items:
- $ref: "#/definitions/Trace"
- Span:
- title: Span
- type: object
- required:
- - traceId
- - id
- - name
- properties:
- traceId:
- type: string
- maxLength: 32
- minLength: 16
- pattern: "[a-z0-9]{16,32}"
- description: |
- Randomly generated, unique identifier for a trace, set on all spans within it.
-
- Encoded as 16 or 32 lowercase hex characters in big endian byte order,
- corresponding to 64 or 128 bits,
- For example, a 128bit trace ID looks like 4e441824ec2b6a44ffdc9bb9a6453df3
- name:
- type: string
- description: |
- The logical operation this span represents in lowercase (e.g. rpc method).
- Set to empty string if unknown.
-
- As these are lookup labels, take care to ensure names are low cardinality.
- For example, do not embed variables into the name.
- parentId:
- type: string
- pattern: "[a-z0-9]{16}"
- maxLength: 16
- minLength: 16
- description: 'The parent span ID or absent if this the root span in a trace.'
- id:
- type: string
- maxLength: 16
- minLength: 16
- pattern: "[a-z0-9]{16}"
- description: |
- Unique 64bit identifier for this operation within the trace.
-
- Encoded as 16 lowercase hex characters. For example ffdc9bb9a6453df3
- timestamp:
- type: integer
- format: int64
- description: |
- 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
- duration:
- type: integer
- format: int64
- minimum: 1
- description: |
- 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.
- debug:
- type: boolean
- description: |
- 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.
- annotations:
- title: ListOfAnnotations
- type: array
- description: 'Associates events that explain latency with the time they happened.'
- items:
- $ref: '#/definitions/Annotation'
- binaryAnnotations:
- title: ListOfBinaryAnnotations
- type: array
- description: 'Binary Annotations are tags that give your span context for search, viewing and analysis.'
- items:
- $ref: '#/definitions/BinaryAnnotation'
- DependencyLink:
- title: DependencyLink
- type: object
- required:
- - parent
- - child
- - callCount
- properties:
- parent:
- type: string
- child:
- type: string
- callCount:
- type: integer
- errorCount:
- type: integer
diff --git a/zipkin-api/zipkin.proto b/zipkin-api/zipkin.proto
deleted file mode 100644
index 9e65112..0000000
--- a/zipkin-api/zipkin.proto
+++ /dev/null
@@ -1,237 +0,0 @@
-//
-// 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) {}
-}
diff --git a/zipkin-api/zipkin2-api.yaml b/zipkin-api/zipkin2-api.yaml
deleted file mode 100644
index 9d25da7..0000000
--- a/zipkin-api/zipkin2-api.yaml
+++ /dev/null
@@ -1,521 +0,0 @@
-#
-# 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.
-#
-
-swagger: "2.0"
-info:
- version: "1.0.0"
- title: Zipkin API
- description: |
- Zipkin's v2 api currently includes a POST endpoint that can receive spans.
-host: localhost:9411
-basePath: /api/v2
-schemes:
- - http
- - https
-consumes:
- - application/json
-paths:
- /services:
- get:
- description: |
- Returns a list of all service names associated with span endpoints.
- responses:
- '200':
- description: Succes
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
- /spans:
- get:
- description: Get all the span names recorded by a particular service
- parameters:
- - name: serviceName
- in: query
- required: true
- description: |
- Ex favstar (required) - Lower-case label of a node in the service
- graph. The /services endpoint enumerates possible input values.
- type: string
- responses:
- '200':
- description: OK
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
- post:
- description: |
- Uploads a list of spans encoded per content-type, for example json.
- consumes:
- - application/json
- - application/x-protobuf
- produces: []
- parameters:
- - name: spans
- in: body
- description: A list of spans that belong to any trace.
- required: true
- schema:
- $ref: "#/definitions/ListOfSpans"
- responses:
- '202':
- description: Accepted
- /traces:
- get:
- description: |
- Invoking this request retrieves traces matching the below filters.
-
- Results should be filtered against endTs, subject to limit and
- lookback. For example, if endTs is 10:20 today, limit is 10, and
- lookback is 7 days, traces returned should be those nearest to 10:20
- today, not 10:20 a week ago.
-
- Time units of endTs and lookback are milliseconds as opposed to
- microseconds, the grain of Span.timestamp. Milliseconds is a more
- familiar and supported granularity for query, index and windowing
- functions
- parameters:
- - name: serviceName
- in: query
- required: false
- description: |
- Ex favstar (required) - Lower-case label of a node in the service
- graph. The /services endpoint enumerates possible input values.
- type: string
- - name: spanName
- in: query
- required: false
- description: |
- Ex get - name of a span in a trace.
- Only return traces that contains spans with this name.
- type: string
- - name: annotationQuery
- in: query
- type: string
- required: false
- description: |
- Ex. `http.uri=/foo and retried` - If key/value (has an `=`),
- constrains against Span.tags entres. If just a word, constrains
- against Span.annotations[].value or Span.tags[].key. Any values are
- AND against eachother. This means a span in the trace must match
- all of these.
- - name: minDuration
- in: query
- type: integer
- description: |
- Ex. 100000 (for 100ms). Only return traces whose `Span.duration` is
- greater than or equal to minDuration microseconds.
- - name: maxDuration
- in: query
- type: integer
- description: |
- Only return traces whose Span.duration is less than or equal to
- `maxDuration` microseconds. Only valid with minDuration.
- - name: endTs
- in: query
- type: integer
- format: int64
- description: |
- Only return traces where all Span.timestamp are at or before this
- time in epoch milliseconds. Defaults to current time.
- - name: lookback
- type: integer
- format: int64
- in: query
- description: |
- Only return traces where all Span.timestamp are at or after (endTs
- - * lookback) in milliseconds. Defaults to endTs, limited to a
- system parameter QUERY_LOOKBACK
- - name: limit
- in: query
- default: 10
- type: integer
- description: |
- Maximum number of traces to return. Defaults to 10
- responses:
- '200':
- description: OK
- schema:
- $ref: "#/definitions/ListOfTraces"
- /trace/{traceId}:
- get:
- parameters:
- - name: traceId
- in: path
- required: true
- type: string
- maxLength: 32
- minLength: 16
- pattern: "[a-z0-9]{16,32}"
- description: |
- Trace identifier, set on all spans within it.
-
- Encoded as 16 or 32 lowercase hex characters corresponding to 64 or 128 bits.
- For example, a 128bit trace ID looks like 4e441824ec2b6a44ffdc9bb9a6453df3
- responses:
- '200':
- description: OK
- schema:
- $ref: "#/definitions/Trace"
- '404':
- description: "`traceId` not found"
- /dependencies:
- get:
- description: |
- Returns service links derived from spans.
- parameters:
- - name: endTs
- in: query
- description: |
- only return links from spans where `Span.timestamp` are at or before
- this time in epoch milliseconds.
- required: true
- type: integer
- format: int64
- - name: lookback
- in: query
- description: |
- only return links where all Span.timestamp are at or after
- (`endTs - * lookback`) in milliseconds. Defaults to `endTs`, limited
- to a system parameter `QUERY_LOOKBACK`
- type: integer
- format: int64
- responses:
- '200':
- description: OK
- schema:
- type: array
- title: ListOfDependencyLinks
- items:
- $ref: "#/definitions/DependencyLink"
- /autocompleteKeys:
- get:
- description: |
- Returns a subset of keys from Span.tags configured for value autocompletion.
- This helps sites populate common keys into the annotationQuery parameter of the
- /traces endpoint. For example, a UI can allow users to select site-specific
- keys from a drop-down as opposed to typing them in manually. This helps guide
- users towards the more correct keys and avoids typos or formatting problems.
- responses:
- '200':
- description: Success is a list of site-specific keys, such as environment.
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
- /autocompleteValues:
- get:
- description: |
- Returns all known values of Span.tags for the given autocomplete key. Refer
- to the description of /autocompleteKeys for the use case.
- parameters:
- - name: key
- in: query
- required: true
- description: Name of the autocomplete key from the /autocompleteKeys endpoint.
- type: string
- responses:
- '200':
- description: |
- Success result is empty when there are no values or the key was not
- configured.
- schema:
- type: array
- items:
- type: string
- '400':
- description: Bad Request Error
-
-definitions:
- Endpoint:
- type: object
- title: Endpoint
- description: The network context of a node in the service graph
- properties:
- serviceName:
- type: string
- description: |
- 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.
- ipv4:
- type: string
- format: ipv4
- description: |
- The text representation of the primary IPv4 address associated with this
- connection. Ex. 192.168.99.100 Absent if unknown.
- ipv6:
- type: string
- format: ipv6
- description: |
- The text representation of the primary IPv6 address associated with a
- connection. Ex. 2001:db8::c001 Absent if unknown.
-
- Prefer using the ipv4 field for mapped addresses.
- port:
- type: integer
- description: |
- Depending on context, this could be a listen port or the client-side of a
- socket. Absent if unknown. Please don't set to zero.
- Annotation:
- title: Annotation
- type: object
- description: |
- Associates an event that explains latency with a timestamp.
- Unlike log statements, annotations are often codes. Ex. "ws" for WireSend
-
- Zipkin v1 core annotations such as "cs" and "sr" have been replaced with
- Span.Kind, which interprets timestamp and duration.
- required:
- - timestamp
- - value
- properties:
- timestamp:
- type: integer
- description: |
- 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.
- value:
- type: string
- description: |
- 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.
- Tags:
- type: object
- title: Tags
- description: |
- Adds context to a span, 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.
- additionalProperties:
- type: string
- ListOfSpans:
- title: ListOfSpans
- description: 'A list of spans with possibly different trace ids, in no particular order'
- type: array
- items:
- $ref: "#/definitions/Span"
- Trace:
- title: Trace
- type: array
- description: 'List of spans who have the same trace ID.'
- items:
- $ref: "#/definitions/Span"
- ListOfTraces:
- title: ListOfTraces
- type: array
- items:
- $ref: "#/definitions/Trace"
- Span:
- title: Span
- description: |
- 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.
- type: object
- required:
- - traceId
- - id
- properties:
- traceId:
- type: string
- maxLength: 32
- minLength: 16
- pattern: "[a-z0-9]{16,32}"
- description: |
- Randomly generated, unique identifier for a trace, set on all spans within it.
-
- Encoded as 16 or 32 lowercase hex characters corresponding to 64 or 128 bits.
- For example, a 128bit trace ID looks like 4e441824ec2b6a44ffdc9bb9a6453df3
- name:
- type: string
- description: |
- 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.
- parentId:
- type: string
- pattern: "[a-z0-9]{16}"
- maxLength: 16
- minLength: 16
- description: 'The parent span ID or absent if this the root span in a trace.'
- id:
- type: string
- pattern: "[a-z0-9]{16}"
- maxLength: 16
- minLength: 16
- description: |
- Unique 64bit identifier for this operation within the trace.
-
- Encoded as 16 lowercase hex characters. For example ffdc9bb9a6453df3
- kind:
- type: string
- enum:
- - CLIENT
- - SERVER
- - PRODUCER
- - CONSUMER
- description: |
- When present, kind clarifies timestamp, duration and remoteEndpoint. 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.
-
- * `CLIENT`
- * timestamp is the moment a request was sent to the server. (in v1 "cs")
- * duration is the delay until a response or an error was received. (in v1 "cr"-"cs")
- * remoteEndpoint is the server. (in v1 "sa")
- * `SERVER`
- * timestamp is the moment a client request was received. (in v1 "sr")
- * duration is the delay until a response was sent or an error. (in v1 "ss"-"sr")
- * remote_endpoint is the client. (in v1 "ca")
- * `PRODUCER`
- * timestamp is the moment a message was sent to a destination. (in v1 "ms")
- * duration is the delay sending the message, such as batching.
- * remoteEndpoint is the broker.
- * `CONSUMER`
- * timestamp is the moment a message was received from an origin. (in v1 "mr")
- * duration is the delay consuming the message, such as from backlog.
- * remoteEndpoint - Represents the broker. Leave serviceName absent if unknown.
- timestamp:
- type: integer
- format: int64
- description: |
- 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
- duration:
- type: integer
- format: int64
- minimum: 1
- description: |
- 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.
- debug:
- type: boolean
- description: |
- 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.
- shared:
- type: boolean
- description: 'True if we are contributing to a span started by another tracer (ex on a different host).'
- localEndpoint:
- $ref: "#/definitions/Endpoint"
- description: |
- 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.
- remoteEndpoint:
- $ref: "#/definitions/Endpoint"
- description: |
- 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.
- annotations:
- type: array
- uniqueItems: true
- items:
- $ref: '#/definitions/Annotation'
- description: 'Associates events that explain latency with the time they happened.'
- tags:
- $ref: '#/definitions/Tags'
- description: 'Tags give your span context for search, viewing and analysis.'
- DependencyLink:
- title: DependencyLink
- description: |
- The count of traced calls between services, or between a service and a broker.
-
- The direction of the link is parent to child, and can be one of:
- * client to server
- * producer to broker
- * broker to consumer
-
- Note: This is related to span ID count between a sender and receiver, but there
- is nuance that makes it more difficult than counting unique span IDs. Ex. the
- parent or child might be uninstrumented: detected via the remote endpoint. There
- can also be scenarios where both sides are instrumented. Please use existing tools
- such as zipkin-dependencies to derive links as they avoid under or over counting.
- type: object
- required:
- - parent
- - child
- - callCount
- properties:
- parent:
- type: string
- description: 'The service name of the caller: client or message producer or broker.'
- child:
- type: string
- description: 'The service name of the callee: server or message consumer or broker.'
- callCount:
- type: integer
- description: 'Total traced calls made from the parent to the child.'
- errorCount:
- type: integer
- description: 'Total traced calls made from the parent to the child known to be in error.'