Adds a Honeycomb example to the Service section (census-instrumentati…

…on#697) * Add Honeycomb to the website * copy adjustments * Gofmt code block * Add sampling example, add Honeycomb to the feature-matrix (census-instrumentation#3) Add sampling example to the Honeycomb page, add Honeycomb to the exporter matrix * add service honeycomb example (census-instrumentation#4) Adds an example to the Honeycomb section of the OpenCensus website * update aliases to change agent-> service (census-instrumentation#5) * undo the change from agent-> service (census-instrumentation#6)
bzwj · Jun 11, 2019 · 2353be4 · 2353be4
1 parent a259671
commit 2353be4
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 46 deletions.
diff --git a/content/service/exporters/honeycomb/_index.md b/content/service/exporters/honeycomb/_index.md
@@ -1,42 +1,11 @@
 ---
 title: "Honeycomb"
-date: 2019-02-17T22:57:58-08:00
+date: 2019-06-10T18:25:17-08:00
 aliases: [/agent/exporters/honeycomb]
 logo: /img/honeycomb-logo.jpg
 ---
 
-- [Introduction](#introduction)
-- [Configuration](#configuration)
-    - [Format](#format)
-    - [Example](#example)
-- [References](#references)
+The OpenCensus Service allows observability signals to be exported to Honeycomb.
 
-### Introduction
-
-The OpenCensus Service allows one to export traces to Honeycomb.
-
-### Configuration
-
-In the Service's YAML configuration file, under section "exporters" and sub-section "honeycomb", please configure these fields:
-
-#### Format
-```yaml
-exporters:
-  honeycomb:
-    write_key: "<WRITE_KEY>"
-    dataset_name: "<DATASET_NAME>"
-```
-
-#### Example
-```yaml
-# Saved in oca.yaml
-exporters:
-  honeycomb:
-    write_key: "31a73983-3bf9-4d85-8dd0-2e87296abafa"
-    dataset_name: "aero9_p95"
-```
-
-### References
-Resource|URL
----|---
-Honeycomb homepage|https://www.honeycomb.io/
+It exports out the following observability signals:
+{{% children %}}
diff --git a/content/service/exporters/honeycomb/tracing.md b/content/service/exporters/honeycomb/tracing.md
@@ -0,0 +1,91 @@
+---
+title: "Traces"
+date: 2019-06-10T18:25:17-08:00
+aliases: [/agent/exporters/honeycomb/traces]
+logo: /img/honeycomb-logo.jpg
+---
+
+- [Introduction](#introduction)
+- [Configuration](#configuration)
+  - [Format](#format)
+  - [Example](#example)
+- [References](#references)
+
+### Introduction
+
+The OpenCensus Service allows one to export traces to Honeycomb.
+
+### Configuration
+
+In the Service's YAML configuration file, under section "exporters" and sub-section "honeycomb", please configure these fields:
+
+#### Format
+
+```yaml
+exporters:
+  honeycomb:
+    write_key: "<WRITE_KEY>"
+    dataset_name: "<DATASET_NAME>"
+```
+
+#### Example
+
+```yaml
+# Saved in oca.yaml
+exporters:
+  honeycomb:
+    write_key: "31a73983-3bf9-4d85-8dd0-2e87296abafa"
+    dataset_name: "aero9_p95"
+```
+
+#### End to End example
+
+In this end-to-end example, we'll have the OpenCensus Service running and a Go application that uses the Go ocagent-exporter to send traces to the OpenCensus Service and then to Honeycomb
+
+##### Add Honeycomb to the config.yaml file
+
+In `ocagent/config.yaml`
+
+```yaml
+exporters:
+  honeycomb:
+    write_key: "<WRITE_KEY>"
+    dataset_name: "<DATASET_NAME>"
+```
+
+##### Run the OpenCensus Service Agent
+
+In `opencensus-service/cmd/ocagent`, run start the agent
+
+```
+GO111MODULE=on go run github.com/census-instrumentation/opencensus-service/cmd/ocagent
+```
+
+##### Run the OpenCensus Service example application
+
+In `opencensus-service`, start the example app
+
+```
+$ GO111MODULE=on go run example/main.go
+#0: LineLength: 469By
+#1: LineLength: 794By
+Latency: 132.649ms
+#0: LineLength: 448By
+#1: LineLength: 420By
+#2: LineLength: 486By
+#3: LineLength: 473By
+Latency: 1066.808ms
+```
+
+##### Results
+
+On navigating to [Honeycomb](ui.honeycomb.io), you should see your trace data.
+
+![Honeycomb UI with OpenCensus Agent Traces](/img/Honeycomb_OCAgent_Data.png "Honeycomb OCAgent Traces")
+
+### References
+
+| Resource              | URL                                                |
+| --------------------- | -------------------------------------------------- |
+| Honeycomb homepage    | https://www.honeycomb.io/                          |
+| Honeycomb Go exporter | https://github.com/honeycombio/opencensus-exporter |
diff --git a/layouts/shortcodes/feature-matrix.html b/layouts/shortcodes/feature-matrix.html
@@ -67,17 +67,17 @@
 		<td data-label="ruby">–</td>
 	</tr>
 
-        <tr>
-	        <td>Honeycomb</td>
-	        <td data-label="csharp">–</td>
-	        <td data-label="cpp">–</td>
-	        <td data-label="erlang">–</td>
-	        <td data-label="golang"><abbr title="Trace Exporter" class="trace-exporter blue white-text">T</abbr></td>
-	        <td data-label="java">–</td>
-	        <td data-label="nodejs">–</td>
-	        <td data-label="php">–</td>
-	        <td data-label="python">–</td>
-	        <td data-label="ruby">–</td>
+	<tr>
+		<td>Honeycomb</td>
+		<td data-label="csharp">–</td>
+		<td data-label="cpp">–</td>
+		<td data-label="erlang">–</td>
+		<td data-label="golang"><abbr title="Trace Exporter" class="trace-exporter blue white-text">T</abbr></td>
+		<td data-label="java">–</td>
+		<td data-label="nodejs">–</td>
+		<td data-label="php">–</td>
+		<td data-label="python">–</td>
+		<td data-label="ruby">–</td>
 	</tr>
 
 	<tr>

diff --git a/static/img/Honeycomb_OCAgent_Data.png b/static/img/Honeycomb_OCAgent_Data.png