aboutsummaryrefslogtreecommitdiffstats
path: root/contrib
diff options
context:
space:
mode:
authorYang Song <songy23@users.noreply.github.com>2018-03-16 15:04:50 -0700
committerGitHub <noreply@github.com>2018-03-16 15:04:50 -0700
commitafd18e36232e74823c867f0a13b3d39ac313221d (patch)
treedc051a712b0fa78e774b160a46ae20cc34c9de18 /contrib
parent9b6eb8cb000e9262736135f57975dd623a33fdb0 (diff)
downloadplatform_external_opencensus-java-afd18e36232e74823c867f0a13b3d39ac313221d.tar.gz
platform_external_opencensus-java-afd18e36232e74823c867f0a13b3d39ac313221d.tar.bz2
platform_external_opencensus-java-afd18e36232e74823c867f0a13b3d39ac313221d.zip
Add screenshots examples for zpages in the readme.md. (#1065)
Diffstat (limited to 'contrib')
-rw-r--r--contrib/zpages/README.md32
-rw-r--r--contrib/zpages/screenshots/rpcz-example.pngbin0 -> 167950 bytes
-rw-r--r--contrib/zpages/screenshots/statsz-example-1.pngbin0 -> 271727 bytes
-rw-r--r--contrib/zpages/screenshots/statsz-example-2.pngbin0 -> 185155 bytes
-rw-r--r--contrib/zpages/screenshots/traceconfigz-example.pngbin0 -> 118924 bytes
-rw-r--r--contrib/zpages/screenshots/tracez-example.pngbin0 -> 223133 bytes
6 files changed, 32 insertions, 0 deletions
diff --git a/contrib/zpages/README.md b/contrib/zpages/README.md
index 6545e1b6..d6b20a71 100644
--- a/contrib/zpages/README.md
+++ b/contrib/zpages/README.md
@@ -50,6 +50,38 @@ public class MyMainClass {
}
```
+### View stats and spans on Z-Pages
+
+#### View RPC stats on /rpcz page
+
+The /rpcz page displays the canonical gRPC cumulative and interval stats broken down by RPC methods.
+Example:
+
+![rpcz-example](screenshots/rpcz-example.png)
+
+#### View measures and stats for all exported views on /statsz page
+
+The /statsz page displays measures and stats for all exported views. Views are grouped into directories
+according to their namespace. Example:
+
+![statsz-example-1](screenshots/statsz-example-1.png)
+![statsz-example-2](screenshots/statsz-example-2.png)
+
+#### View trace spans on /tracez page
+
+The /tracez page displays information about all active spans and all sampled spans based on latency
+and errors. Example:
+
+![tracez-example](screenshots/tracez-example.png)
+
+#### View and update tracing configuration on /traceconfigz page
+
+The /traceconfigz page displays information about the current active tracing configuration and
+allows users to change it. Example:
+
+![traceconfigz-example](screenshots/traceconfigz-example.png)
+
+
### FAQ
#### Why do I not see sampled spans based on latency and error codes for a given span name?
diff --git a/contrib/zpages/screenshots/rpcz-example.png b/contrib/zpages/screenshots/rpcz-example.png
new file mode 100644
index 00000000..89122926
--- /dev/null
+++ b/contrib/zpages/screenshots/rpcz-example.png
Binary files differ
diff --git a/contrib/zpages/screenshots/statsz-example-1.png b/contrib/zpages/screenshots/statsz-example-1.png
new file mode 100644
index 00000000..c45dd217
--- /dev/null
+++ b/contrib/zpages/screenshots/statsz-example-1.png
Binary files differ
diff --git a/contrib/zpages/screenshots/statsz-example-2.png b/contrib/zpages/screenshots/statsz-example-2.png
new file mode 100644
index 00000000..811b9db5
--- /dev/null
+++ b/contrib/zpages/screenshots/statsz-example-2.png
Binary files differ
diff --git a/contrib/zpages/screenshots/traceconfigz-example.png b/contrib/zpages/screenshots/traceconfigz-example.png
new file mode 100644
index 00000000..666cf548
--- /dev/null
+++ b/contrib/zpages/screenshots/traceconfigz-example.png
Binary files differ
diff --git a/contrib/zpages/screenshots/tracez-example.png b/contrib/zpages/screenshots/tracez-example.png
new file mode 100644
index 00000000..4abfdbbe
--- /dev/null
+++ b/contrib/zpages/screenshots/tracez-example.png
Binary files differ