zipkin-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From abe...@apache.org
Subject [incubator-zipkin-website] 04/16: Renames "Existing" pages (#121)
Date Sun, 21 Apr 2019 21:02:28 GMT
This is an automated email from the ASF dual-hosted git repository.

abesto pushed a commit to branch sync-from-githubio
in repository https://gitbox.apache.org/repos/asf/incubator-zipkin-website.git

commit d12cabd17c1184723303500b043766a2c0fd4589
Author: Adrian Cole <adriancole@users.noreply.github.com>
AuthorDate: Tue Jan 1 14:49:04 2019 +0800

    Renames "Existing" pages (#121)
    
    The word existing is a bit redundant. This clarifies content according to what they contain.
    
    * Existing instrumentations -> Tracers and Instrumentation
    * Existing integrations -> Server Extensions and Choices
---
 Gemfile.lock                                       | 38 ++++++++--------
 README.md                                          |  4 +-
 ...t_integrations.yml => community_extensions.yml} |  0
 ...s.yml => community_tracers_instrumentation.yml} |  0
 ..._integrations.yml => openzipkin_extensions.yml} |  0
 ....yml => openzipkin_tracers_instrumentation.yml} |  0
 index.md                                           |  4 +-
 pages/architecture.md                              |  4 +-
 pages/community.md                                 |  4 +-
 pages/existing_transport_integrations.md           | 39 ----------------
 pages/extensions_choices.md                        | 53 ++++++++++++++++++++++
 pages/instrumenting.md                             |  2 +-
 ...trumentations.md => tracers_instrumentation.md} | 14 +++---
 13 files changed, 88 insertions(+), 74 deletions(-)

diff --git a/Gemfile.lock b/Gemfile.lock
index 683e484..f31c717 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -13,9 +13,9 @@ GEM
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
-    commonmarker (0.17.12)
+    commonmarker (0.17.13)
       ruby-enum (~> 0.5)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.4)
     dnsruby (1.61.2)
       addressable (~> 2.5)
     em-websocket (0.5.1)
@@ -25,12 +25,12 @@ GEM
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    faraday (0.15.2)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.25)
     forwardable-extended (2.6.0)
     gemoji (3.0.0)
-    github-pages (192)
+    github-pages (193)
       activesupport (= 4.2.10)
       github-pages-health-check (= 1.8.1)
       jekyll (= 3.7.4)
@@ -38,7 +38,7 @@ GEM
       jekyll-coffeescript (= 1.1.1)
       jekyll-commonmark-ghpages (= 0.1.5)
       jekyll-default-layout (= 0.1.4)
-      jekyll-feed (= 0.10.0)
+      jekyll-feed (= 0.11.0)
       jekyll-gist (= 1.5.0)
       jekyll-github-metadata (= 2.9.4)
       jekyll-mentions (= 1.4.1)
@@ -81,7 +81,7 @@ GEM
       octokit (~> 4.0)
       public_suffix (~> 2.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.8.4)
+    html-pipeline (2.9.1)
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.6.0)
@@ -114,7 +114,7 @@ GEM
       rouge (~> 2)
     jekyll-default-layout (0.1.4)
       jekyll (~> 3.0)
-    jekyll-feed (0.10.0)
+    jekyll-feed (0.11.0)
       jekyll (~> 3.3)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
@@ -185,7 +185,7 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.1)
       jekyll (~> 3.3)
-    jekyll-watch (2.0.0)
+    jekyll-watch (2.1.2)
       listen (~> 3.0)
     jemoji (0.10.1)
       gemoji (~> 3.0)
@@ -198,30 +198,30 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     mercenary (0.3.6)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minima (2.5.0)
       jekyll (~> 3.5)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.11.3)
     multipart-post (2.0.0)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
-    octokit (4.11.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pathutil (0.16.1)
+    pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (2.0.5)
     rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rouge (2.2.1)
     ruby-enum (0.7.2)
       i18n
     ruby_dep (1.5.0)
     rubyzip (1.2.2)
     safe_yaml (1.0.4)
-    sass (3.5.7)
+    sass (3.7.2)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -232,18 +232,18 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    typhoeus (1.3.0)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
     yaml-lint (0.0.10)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages (= 192)
+  github-pages (= 193)
   yaml-lint (~> 0.0.9)
 
 BUNDLED WITH
diff --git a/README.md b/README.md
index 4fde567..c69eb1b 100644
--- a/README.md
+++ b/README.md
@@ -89,8 +89,8 @@ The rest of the repository contains scaffolding; here's a list to give you
a
 basic idea of what's what:
 
  * [`_data`](_data) contains lists of things that are rendered into various
-   parts of the page. For instance the list of existing tracers is defined here
-   in a structured way.
+   parts of the page. For instance the list of tracers and instrumentation
+   is defined here in a structured way.
  * [`_includes`](_includes) contains HTML snippets that are shared by some or
    all pages.
  * [`_layouts`](_layouts) contains the basic HTML shared by all pages - and
diff --git a/_data/community_transport_integrations.yml b/_data/community_extensions.yml
similarity index 100%
rename from _data/community_transport_integrations.yml
rename to _data/community_extensions.yml
diff --git a/_data/community_instrumentations.yml b/_data/community_tracers_instrumentation.yml
similarity index 100%
rename from _data/community_instrumentations.yml
rename to _data/community_tracers_instrumentation.yml
diff --git a/_data/openzipkin_transport_integrations.yml b/_data/openzipkin_extensions.yml
similarity index 100%
rename from _data/openzipkin_transport_integrations.yml
rename to _data/openzipkin_extensions.yml
diff --git a/_data/openzipkin_instrumentations.yml b/_data/openzipkin_tracers_instrumentation.yml
similarity index 100%
rename from _data/openzipkin_instrumentations.yml
rename to _data/openzipkin_tracers_instrumentation.yml
diff --git a/index.md b/index.md
index 2541962..7237a43 100644
--- a/index.md
+++ b/index.md
@@ -16,8 +16,8 @@ Applications are instrumented to report timing data to Zipkin. The Zipkin
UI als
 ## Where to go next?
 
  * To try out Zipkin, check out our [Quickstart guide]({{ site.github.url }}/pages/quickstart)
- * See if your platform has an [existing instrumentation library]({{ site.github.url
-}}/pages/existing_instrumentations)
+ * See if your platform has a [tracer or instrumentation library]({{ site.github.url }}/pages/tracers_instrumentation)
+ * See if a [server extension or alternative]({{ site.github.url }}/pages/extensions_choices)
is relevant to your site.
  * Join the [Zipkin Gitter chat channel](https://gitter.im/openzipkin/zipkin)
  * The source code is on GitHub as [openzipkin/zipkin](https://github.com/openzipkin/zipkin/)
  * Issues are also tracked on [GitHub](https://github.com/openzipkin/zipkin/issues)
diff --git a/pages/architecture.md b/pages/architecture.md
index a591649..490a3c2 100644
--- a/pages/architecture.md
+++ b/pages/architecture.md
@@ -30,8 +30,8 @@ Here's a diagram describing this flow:
 
 ![Zipkin architecture]({{ site.github.url }}/public/img/architecture-1.png)
 
-To see if an instrumentation library already exists for your platform, see the
-list of [existing instrumentations]({{ site.github.url}}/pages/existing_instrumentations).
+To see if a tracer or instrumentation library already exists for your platform, see
+[our list]({{ site.github.url}}/pages/tracers_instrumentation).
 
 Example flow
 -----------------------
diff --git a/pages/community.md b/pages/community.md
index efc6a1f..2ec6ac6 100644
--- a/pages/community.md
+++ b/pages/community.md
@@ -14,7 +14,7 @@ Zipkin code, docs, specs and support. It includes github projects, this
web site
 ### Keeping up to date
 Follow [@zipkinproject](https://twitter.com/zipkinproject) on Twitter for news
 including release announcements and community events. You can also ask on [gitter](https://gitter.im/openzipkin/zipkin)
about something specific. If you are working on code, you can also
-follow projects like the [server](https://github.com/openzipkin/zipkin) or an [instrumentation](https://zipkin.io/pages/existing_instrumentations.html)
you use.
+follow projects like the [server](https://github.com/openzipkin/zipkin) or an [instrumentation](https://zipkin.io/pages/tracers_instrumentation.html)
you use.
 
 ### Being an active part of the community
 OpenZipkin is primarily volunteers, and there are a lot of ways to help. Once you
@@ -50,4 +50,4 @@ Smaller sizes might break the delicate design of the logo.
 
 Use the logo with a cut-line for printing kiss-cut stickers.
 A minimum size for kiss-cut stickers would be 7.5 cm x 4.62 cm. 
-Smaller sizes might give you problems with the inner corners when you want to peel-off the
sticker.
\ No newline at end of file
+Smaller sizes might give you problems with the inner corners when you want to peel-off the
sticker.
diff --git a/pages/existing_transport_integrations.md b/pages/existing_transport_integrations.md
deleted file mode 100644
index 638b101..0000000
--- a/pages/existing_transport_integrations.md
+++ /dev/null
@@ -1,39 +0,0 @@
----
-title: Existing server integrations
-weight: 4
----
-
-### OpenZipkin server integrations
-Zipkin server bundles integration for span collection and storage. By default spans can be
collected over http, Kafka or RabbitMQ transports and stored in-memory or in MySQL, Cassandra
or Elasticsearch. Zipkin is extensible with external modules which allow alternate transport
or storage options. Here is a list of ones maintained by the core team.
-
-| Type | Module | Related product | Other notes |
-|:-----|:--------|:----------------|:------------|{% for integration in site.data.openzipkin_transport_integrations
%}
-| {{ integration.type }} | {{ integration.module }} | {{integration.product}} | {{ integration.notes
}} |{% endfor %}
-{: .wide-table}
-
-
-### Community server integrations
-   
-| Type | Module | Related product | Other notes |
-|:-----|:--------|:----------------|:------------|{% for integration in site.data.community_transport_integrations
%}
-| {{ integration.type }} | {{ integration.module }} | {{integration.product}} | {{ integration.notes
}} |{% endfor %}
-{: .wide-table}
-
-
-### Community server Alternatives
-Listed below are alternative servers that accept Zipkin format. Some use the same code as
Zipkin on the same endpoints while others are on alternative endpoints or partially support
features. In any case, these integrations aim to allow existing zipkin clients to use alternative
backends the OpenZipkin team does not support. Hence, direct questions to their respective
communities.
-    
- - [Apache SkyWalking](https://github.com/apache/incubator-skywalking)
-   - When [zipkin-receiver](https://github.com/apache/incubator-skywalking/blob/master/docs/en/setup/backend/backend-receivers.md)
is enabled, Skywalking exposes the same HTTP POST endpoints Zipkin does
-     - http port 9411 accepts `/api/v1/spans` (thrift, json) and /api/v2/spans (json, proto)
POST requests.
-     - this integration uses the same encoding library and same endpoints as zipkin does.
- - [jaeger](https://github.com/jaegertracing/jaeger)
-   - When `COLLECTOR_ZIPKIN_HTTP_PORT=9411` is set, Jaeger exposes a partial implementation
of Zipkin's HTTP POST endpoints
-     - http port 9411 accepts `/api/v1/spans` (thrift, json) and /api/v2/spans (json, but
not proto) POST requests.
-   - When `SPAN_STORAGE_TYPE=kafka` and `zipkin-thrift`, Jaeger reads zipkin v1 thrift encoded
span messages from a Kafka topic.
-     - Note: The above is a [deprecated practice](https://github.com/openzipkin/zipkin/tree/master/zipkin-collector/kafka#legacy-encoding)
in Zipkin. Most instrumentation bundle multiple spans per message in v2 format.
-
-
-Did we miss an integration? Please open a pull-request to
-[openzipkin.github.io](https://github.com/openzipkin/openzipkin.github.io).
-
diff --git a/pages/extensions_choices.md b/pages/extensions_choices.md
new file mode 100644
index 0000000..a90a02a
--- /dev/null
+++ b/pages/extensions_choices.md
@@ -0,0 +1,53 @@
+---
+title: Server extensions and choices
+weight: 4
+---
+
+## Server extensions
+Zipkin server bundles extension for span collection and storage. By default spans can be
collected over http, Kafka or RabbitMQ transports and stored in-memory or in MySQL, Cassandra
or Elasticsearch.
+
+The following modules add storage or transport extensions to the default server build.
+Please refer to their individual documentation for setup and configuration guides.
+
+### OpenZipkin supported
+
+The following extensions are supported by the OpenZipkin team and are hosted at
+the [OpenZipkin GitHub](https://github.com/openzipkin/) group. You can reach out to
+the team on [Zipkin Gitter](https://gitter.im/openzipkin/zipkin/) chat.
+
+| Type | Module | Related product | Other notes |
+|:-----|:--------|:----------------|:------------|{% for extension in site.data.openzipkin_extensions
%}
+| {{ extension.type }} | {{ extension.module }} | {{extension.product}} | {{ extension.notes
}} |{% endfor %}
+{: .wide-table}
+
+### Community supported
+
+| Type | Module | Related product | Other notes |
+|:-----|:--------|:----------------|:------------|{% for extension in site.data.community_extensions
%}
+| {{ extension.type }} | {{ extension.module }} | {{extension.product}} | {{ extension.notes
}} |{% endfor %}
+{: .wide-table}
+
+
+## Alternative servers
+
+The OpenZipkin team publish apis, data formats, and shared libraries that allow alternate
backends to process the
+same data sent to the default Zipkin server.
+
+### Community supported
+
+Listed below are alternative backends that accept Zipkin format. Some use the same code as
Zipkin on the same endpoints while others are on alternative endpoints or partially support
features. In any case, the following aim to allow existing zipkin clients to use backends
the OpenZipkin team does not support. Hence, direct questions to their respective communities.
+    
+ - [Apache SkyWalking](https://github.com/apache/incubator-skywalking)
+   - When [zipkin-receiver](https://github.com/apache/incubator-skywalking/blob/master/docs/en/setup/backend/backend-receivers.md)
is enabled, Skywalking exposes the same HTTP POST endpoints Zipkin does
+     - http port 9411 accepts `/api/v1/spans` (thrift, json) and /api/v2/spans (json, proto)
POST requests.
+     - this extension uses the same encoding library and same endpoints as zipkin does.
+ - [jaeger](https://github.com/jaegertracing/jaeger)
+   - When `COLLECTOR_ZIPKIN_HTTP_PORT=9411` is set, Jaeger exposes a partial implementation
of Zipkin's HTTP POST endpoints
+     - http port 9411 accepts `/api/v1/spans` (thrift, json) and /api/v2/spans (json, but
not proto) POST requests.
+   - When `SPAN_STORAGE_TYPE=kafka` and `zipkin-thrift`, Jaeger reads zipkin v1 thrift encoded
span messages from a Kafka topic.
+     - Note: The above is a [deprecated practice](https://github.com/openzipkin/zipkin/tree/master/zipkin-collector/kafka#legacy-encoding)
in Zipkin. Most instrumentation bundle multiple spans per message in v2 format.
+
+
+Did we miss a server extension or alternative? Please open a pull-request to
+[openzipkin.github.io](https://github.com/openzipkin/openzipkin.github.io).
+
diff --git a/pages/instrumenting.md b/pages/instrumenting.md
index ab4a916..4ea6d6b 100644
--- a/pages/instrumenting.md
+++ b/pages/instrumenting.md
@@ -4,7 +4,7 @@ title: Instrumenting a library
 
 This is an advanced topic. Before reading further, you may want to check whether
 an instrumentation library for your platform [already exists]({{ site.github.url
-}}/pages/existing_instrumentations). If not and if you want to take on creating an instrumentation
library, first things first; jump on
+}}/pages/tracers_instrumentation). If not and if you want to take on creating an instrumentation
library, first things first; jump on
 [Zipkin Gitter chat channel](https://gitter.im/openzipkin/zipkin) and let us know. We'll
be extremely
 happy to help you along the way.
 {: .message}
diff --git a/pages/existing_instrumentations.md b/pages/tracers_instrumentation.md
similarity index 83%
rename from pages/existing_instrumentations.md
rename to pages/tracers_instrumentation.md
index 64f4cae..a073a56 100644
--- a/pages/existing_instrumentations.md
+++ b/pages/tracers_instrumentation.md
@@ -1,5 +1,5 @@
 ---
-title: Existing instrumentations
+title: Tracers and Instrumentation
 weight: 3
 ---
 
@@ -12,22 +12,22 @@ The following libraries exist to provide instrumentation on various platforms.
 Please refer to their individual documentation for setup and configuration
 guides.
 
-### OpenZipkin libraries
+### OpenZipkin supported
 
-The following libraries are supported by the OpenZipkin authors and are hosted at
+The following libraries are supported by the OpenZipkin team and are hosted at
 the [OpenZipkin GitHub](https://github.com/openzipkin/) group. You can reach out to
-the authors at the [Zipkin Gitter](https://gitter.im/openzipkin/zipkin/) chat.
+the team on [Zipkin Gitter](https://gitter.im/openzipkin/zipkin/) chat.
 
 | Language | Library | Framework | Propagation Supported | Transports Supported | Sampling
Supported? | Other notes |
-|:---------|:--------|:----------|:----------------------|:---------------------|:--------------------|:------------|{%
for lib in site.data.openzipkin_instrumentations %}
+|:---------|:--------|:----------|:----------------------|:---------------------|:--------------------|:------------|{%
for lib in site.data.openzipkin_tracers_instrumentation %}
 | {{ lib.language }} | {{ lib.library }} | {{lib.framework}} | {{ lib.propagation }} | {{
lib.transports }} | {{ lib.sampling }} | {{ lib.notes }} |{% endfor %}
 {: .wide-table}
 
 
-### Community libraries
+### Community supported
 
 | Language | Library | Framework | Propagation Supported | Transports Supported | Sampling
Supported? | Other notes |
-|:---------|:--------|:----------|:----------------------|:---------------------|:--------------------|:------------|{%
for lib in site.data.community_instrumentations %}
+|:---------|:--------|:----------|:----------------------|:---------------------|:--------------------|:------------|{%
for lib in site.data.community_tracers_instrumentation %}
 | {{ lib.language }} | {{ lib.library }} | {{lib.framework}} | {{ lib.propagation }} | {{
lib.transports }} | {{ lib.sampling }} | {{ lib.notes }} |{% endfor %}
 {: .wide-table}
 


Mime
View raw message