aboutsummaryrefslogtreecommitdiffstats
path: root/exporters
diff options
context:
space:
mode:
authorYang Song <songy23@users.noreply.github.com>2018-05-21 14:51:32 -0700
committerGitHub <noreply@github.com>2018-05-21 14:51:32 -0700
commitb30683a47b35a65fa963f72014ad839fec70525e (patch)
tree68286ba080735922f306d9894264ebee385b07d3 /exporters
parentb647dbda2e7131d7d350f63d28943c93fe94fc47 (diff)
downloadplatform_external_opencensus-java-b30683a47b35a65fa963f72014ad839fec70525e.tar.gz
platform_external_opencensus-java-b30683a47b35a65fa963f72014ad839fec70525e.tar.bz2
platform_external_opencensus-java-b30683a47b35a65fa963f72014ad839fec70525e.zip
Stackdriver Trace Exporter: update README about auth setup and project id in bad format. (#1205)
Diffstat (limited to 'exporters')
-rw-r--r--exporters/trace/stackdriver/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/exporters/trace/stackdriver/README.md b/exporters/trace/stackdriver/README.md
index c65e1899..c5f5ef27 100644
--- a/exporters/trace/stackdriver/README.md
+++ b/exporters/trace/stackdriver/README.md
@@ -93,6 +93,13 @@ If you prefer to manually set the project ID use:
StackdriverTraceExporter.createAndRegisterWithProjectId("MyStackdriverProjectId");
```
+#### Enable Stackdriver Trace API access scope on Google Cloud Platform
+If your Stackdriver Trace Exporter is running on Kubernetes Engine or Compute Engine,
+you might need additional setup to explicitly enable the ```trace.append``` Stackdriver
+Trace API access scope. To do that, please follow the instructions for
+[GKE](https://cloud.google.com/trace/docs/setup/java#kubernetes_engine) or
+[GCE](https://cloud.google.com/trace/docs/setup/java#compute_engine).
+
#### Java Versions
Java 7 or above is required for using this exporter.
@@ -103,6 +110,13 @@ In all the versions before '0.9.1' the Stackdriver Trace exporter was implemente
API][stackdriver-v1-api-url] which is not fully compatible with the OpenCensus data model. Trace
events like Annotations and NetworkEvents will be dropped.
+### Why do I get a "StatusRuntimeException: NOT_FOUND: Requested entity was not found"?
+One of the possible reasons is you are using a project id with bad format for the exporter.
+Please double check the project id associated with the Stackdriver Trace exporter first.
+Stackdriver Trace backend will not do any sanitization or trimming on the incoming project id.
+Project id with leading or trailing spaces will be treated as a separate non-existing project
+(e.g "project-id" vs "project-id "), and will cause a NOT_FOUND exception.
+
[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true