Update README and k8s.yaml example (#531)

* Update README and k8s.yaml example * Address #451 * Fix collector CLI documentation * Update k8s example to latest standard
census-instrumentation · Apr 24, 2019 · ddbbf72 · ddbbf72
1 parent 2b64001
commit ddbbf72
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -212,12 +212,12 @@ zpages:
 
 ### <a name="agent-usage"></a>Usage
 
+> It is recommended that you use the latest [release](https://github.com/census-instrumentation/opencensus-service/releases).
+
 The ocagent can be run directly from sources, binary, or a Docker image. If you are planning to run from sources or build
 on your machine start by cloning the repo using `go get -d github.com/census-instrumentation/opencensus-service`.
 
-It is recommended that you use the latest [release](https://github.com/census-instrumentation/opencensus-service/releases).
-
-The minimum Go version required for this project is Go 1.11.4.
+The minimum Go version required for this project is Go 1.11.4. In addition, you must manually install [Bazaar](https://github.com/census-instrumentation/opencensus-service/blob/master/CONTRIBUTING.md#required-tools)
 
 1. Run from sources:
 
@@ -366,11 +366,11 @@ Usage:
 
 Flags:
       --config string                 Path to the config file
-      --debug-processor               Flag to add a debug processor (combine with log level DEBUG to log incoming spans)
       --health-check-http-port uint   Port on which to run the healthcheck http server. (default 13133)
   -h, --help                          help for occollector
       --http-pprof-port uint          Port to be used by golang net/http/pprof (Performance Profiler), the profiler is disabled if no port or 0 is specified.
-      --log-level string              Output level of logs (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
+      --log-level string              Output level of logs (DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
+      --logging-exporter              Flag to add a logging exporter (combine with log level DEBUG to log incoming spans)
       --metrics-level string          Output level of telemetry metrics (NONE, BASIC, NORMAL, DETAILED) (default "BASIC")
       --metrics-port uint             Port exposing collector telemetry. (default 8888)
       --receive-jaeger                Flag to run the Jaeger receiver (i.e.: Jaeger Collector), default settings: {ThriftTChannelPort:14267 ThriftHTTPPort:14268}

diff --git a/example/k8s.yaml b/example/k8s.yaml
@@ -14,7 +14,7 @@ data:
 #      zipkin: {}
     exporters:
       opencensus:
-        endpoint: "oc-collector.default.svc.cluster.local:55678" # TODO: Update me
+        endpoint: "oc-collector.default:55678" # TODO: Update me
 ---
 apiVersion: extensions/v1beta1
 kind: DaemonSet
@@ -31,15 +31,18 @@ spec:
         component: oc-agent
     spec:
       containers:
-      - image: omnition/opencensus-agent:0.1.0
+      - command:
+          - "/ocagent_linux"
+          - "--config=/conf/oc-agent-config.yaml"
+        image: omnition/opencensus-agent:0.1.6
         name: oc-agent
         resources:
           limits:
-            cpu: 0.5
+            cpu: 500m
             memory: 500Mi
-        command:
-          - "/ocagent_linux"
-          - "--config=/conf/oc-agent-config.yaml"
+          requests:
+            cpu: 100m
+            memory: 100Mi
         ports:
         - containerPort: 55678
         - containerPort: 55679
@@ -73,18 +76,24 @@ data:
 # Can only use one exporter
 #    exporters:
 #      jaeger:
-#        collector_endpoint: "http://jaeger.default.svc.cluster.local:14268/api/traces"
+#        collector_endpoint: "http://jaeger.default:14268/api/traces"
 #      zipkin: {}
     queued-exporters:
       omnition:
-        num-workers: 20
+        batching:
+          enable: true
+          timeout: 5s
+          send-batch-size: 1024
+        num-workers: 16
         queue-size: 10000
         retry-on-failure: true
-        sender-type: jaeger-thrift-http
-        jaeger-thrift-http:
-          collector_endpoint: https://ingest.omnition.io/api/traces
+        opencensus:
+          compression: "gzip"
+          endpoint: "ingest.omnition.io:443"
           headers: { "x-omnition-api-key":"00000000-0000-0000-0000-000000000001" } # TODO: Update me
-          timeout: 5s
+          num-workers: 8
+          reconnection-delay: 2s
+          secure: true
 ---
 apiVersion: v1
 kind: Service
@@ -130,7 +139,13 @@ spec:
         component: oc-collector
     spec:
       containers:
-      - image: omnition/opencensus-collector:0.1.0
+      - command:
+          - "/occollector_linux"
+          - "--config=/conf/oc-collector-config.yaml"
+        env:
+        - name: GOGC
+          value: "80"
+        image: omnition/opencensus-collector:0.1.6
         name: oc-collector
         resources:
           limits:
@@ -139,9 +154,6 @@ spec:
           requests:
             cpu: 200m
             memory: 400Mi
-        command:
-          - "/occollector_linux"
-          - "--config=/conf/oc-collector-config.yaml"
         ports:
         - containerPort: 55678
 #        - containerPort: 14267
@@ -150,6 +162,8 @@ spec:
         volumeMounts:
         - name: oc-collector-config-vol
           mountPath: /conf
+#        - name: oc-collector-secrets
+#          mountPath: /secrets
         livenessProbe:
           httpGet:
             path: /
@@ -165,3 +179,10 @@ spec:
               - key: oc-collector-config
                 path: oc-collector-config.yaml
           name: oc-collector-config-vol
+#        - secret:
+#            name: oc-collector-secrets
+#            items:
+#              - key: cert.pem
+#                path: cert.pem
+#              - key: key.pem
+#                path: key.pem